diff options
Diffstat (limited to 'nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml')
| -rw-r--r-- | nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml b/nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml new file mode 100644 index 00000000000..a9b0c6a5eef --- /dev/null +++ b/nixos/doc/manual/from_md/contributing-to-this-manual.chapter.xml @@ -0,0 +1,22 @@ +<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> |