aboutsummaryrefslogtreecommitdiff
path: root/infra/libkookie/nixpkgs/nixos/doc/manual/contributing-to-this-manual.xml
diff options
context:
space:
mode:
Diffstat (limited to 'infra/libkookie/nixpkgs/nixos/doc/manual/contributing-to-this-manual.xml')
-rw-r--r--infra/libkookie/nixpkgs/nixos/doc/manual/contributing-to-this-manual.xml22
1 files changed, 22 insertions, 0 deletions
diff --git a/infra/libkookie/nixpkgs/nixos/doc/manual/contributing-to-this-manual.xml b/infra/libkookie/nixpkgs/nixos/doc/manual/contributing-to-this-manual.xml
new file mode 100644
index 000000000000..935dd66bc141
--- /dev/null
+++ b/infra/libkookie/nixpkgs/nixos/doc/manual/contributing-to-this-manual.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 documentation</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>