nixpkgs-suyu/nixos/doc/manual/contributing-to-this-manual.xml
Attila Lendvai 21c56fc3cf 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'.
2021-01-23 18:58:54 -08:00

22 lines
795 B
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>