nixpkgs/nixos/doc/manual/contributing-to-this-manual.xml

<chapter xmlns="http://docbook.org/ns/docbook"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xml:id="chap-contributing">
 <title>Contributing to this manual</title>
 <para>
  The DocBook sources of NixOS' manual are in the <filename
xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual">
nixos/doc/manual</filename> subdirectory of the <link
xlink:href="https://github.com/NixOS/nixpkgs">Nixpkgs</link> repository.
 </para>
 <para>
  You can quickly check your edits with the following:
 </para>
<screen>
<prompt>$ </prompt>cd /path/to/nixpkgs
<prompt>$ </prompt>nix-build nixos/release.nix -A manual.x86_64-linux
</screen>
 <para>
  If the build succeeds, the manual will be in
  <filename>./result/share/doc/nixos/index.html</filename>.
 </para>
</chapter>
nixos/doc: Mention how to contribute to it Instead of putting a README in the directory where the manual is written, put the information from it straight in the docs themselves. It's a bit untrivial to guess the manual is located exactly there for contributers. 2020-10-22 15:18:55 +03:00			`<chapter xmlns="http://docbook.org/ns/docbook"`
			`xmlns:xlink="http://www.w3.org/1999/xlink"`
			`xml:id="chap-contributing">`
nixos/doc/manual: In the preface, add link to #chap-contributing Turned the freetext suggestion about opening the build output into a copy-pastable xdg-open line. Renamed title to 'Contributing to this manual'. 2020-12-28 11:41:33 +01:00			`<title>Contributing to this manual</title>`
nixos/doc: Mention how to contribute to it Instead of putting a README in the directory where the manual is written, put the information from it straight in the docs themselves. It's a bit untrivial to guess the manual is located exactly there for contributers. 2020-10-22 15:18:55 +03:00			`<para>`
			`The DocBook sources of NixOS' manual are in the <filename`
			`xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual">`
			`nixos/doc/manual</filename> subdirectory of the <link`
			`xlink:href="https://github.com/NixOS/nixpkgs">Nixpkgs</link> repository.`
			`</para>`
			`<para>`
			`You can quickly check your edits with the following:`
			`</para>`
			`<screen>`
doc: Fix doc-building instructions 2020-11-11 11:20:14 -08:00			`<prompt>$ </prompt>cd /path/to/nixpkgs`
nixos/doc: Mention how to contribute to it Instead of putting a README in the directory where the manual is written, put the information from it straight in the docs themselves. It's a bit untrivial to guess the manual is located exactly there for contributers. 2020-10-22 15:18:55 +03:00			`<prompt>$ </prompt>nix-build nixos/release.nix -A manual.x86_64-linux`
			`</screen>`
			`<para>`
			`If the build succeeds, the manual will be in`
			`<filename>./result/share/doc/nixos/index.html</filename>.`
			`</para>`
			`</chapter>`