forked from mirrors/nixpkgs
23 lines
831 B
XML
23 lines
831 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 and CommonMark sources of NixOS’ manual are in the
|
|||
|
|
<link xlink:href="https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual">nixos/doc/manual</link>
|
|||
|
|
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>
|
|||
|
|
<programlisting>
|
|||
|
|
$ cd /path/to/nixpkgs
|
|||
|
|
$ ./nixos/doc/manual/md-to-db.sh
|
|||
|
|
$ nix-build nixos/release.nix -A manual.x86_64-linux
|
|||
|
|
</programlisting>
|
|||
|
|
<para>
|
|||
|
|
If the build succeeds, the manual will be in
|
|||
|
|
<literal>./result/share/doc/nixos/index.html</literal>.
|
|||
|
|
</para>
|
|||
|
|
</chapter>
|