Also updates it to mention running md-to-db.sh.launchpad/nixpkgs/master
parent
a67febac45
commit
7501467903
@ -0,0 +1,13 @@ |
||||
# Contributing to this manual {#chap-contributing} |
||||
|
||||
The DocBook and CommonMark sources of NixOS' manual are in the [nixos/doc/manual](https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual) subdirectory of the [Nixpkgs](https://github.com/NixOS/nixpkgs) repository. |
||||
|
||||
You can quickly check your edits with the following: |
||||
|
||||
```ShellSession |
||||
$ cd /path/to/nixpkgs |
||||
$ ./nixos/doc/manual/md-to-db.sh |
||||
$ nix-build nixos/release.nix -A manual.x86_64-linux |
||||
``` |
||||
|
||||
If the build succeeds, the manual will be in `./result/share/doc/nixos/index.html`. |
@ -1,22 +0,0 @@ |
||||
<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> |
@ -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> |
Loading…
Reference in new issue