pyrox.dev
Streamline contributing section
+10
-9
doc/contributing.xml
+10
-9
doc/contributing.xml
···
4
5
<title>Contributing</title>
6
7
-
<para>If you make modifications to the manual, it's important to build the manual before contributing:</para>
8
9
-
<orderedlist>
10
11
-
<listitem><para><command>$ git clone git://github.com/NixOS/nixpkgs.git</command></para></listitem>
12
-
13
-
<listitem><para><command>$ nix-build -A manual nixpkgs/pkgs/top-level/release.nix</command></para></listitem>
14
-
15
-
<listitem><para>Inside the built derivation you shall see <literal>manual/index.html</literal> file.</para></listitem>
16
-
17
-
</orderedlist>
18
19
</chapter>
···
4
5
<title>Contributing</title>
6
7
+
<para>The DocBook sources of the Nixpkgs manual are in the <filename
8
+
xlink:href="https://github.com/NixOS/nixpkgs/tree/master/doc">doc</filename>
9
+
subdirectory of the Nixpkgs repository. If you make modifications to
10
+
the manual, it's important to build it before committing. You can do that as follows:
11
12
+
<screen>
13
+
$ cd /path/to/nixpkgs
14
+
$ nix-build doc
15
+
</screen>
16
17
+
If the build succeeds, the manual will be in
18
+
<filename>./result/share/doc/nixpkgs/manual.html</filename>.</para>
19
20
</chapter>