diff options
| author | Doron Behar <doron.behar@gmail.com> | 2020-10-22 15:18:55 +0300 |
|---|---|---|
| committer | Doron Behar <doron.behar@gmail.com> | 2020-10-22 17:40:48 +0300 |
| commit | 7fb1e3af7722d4ae3d8046f33a59882f3c150429 (patch) | |
| tree | 13225e0e0ddd7dfa176622bfdc47f8fe1825879d | |
| parent | c5c468bda61d409ea68ccd8cd7296377e32f645a (diff) | |
| download | nixpkgs-7fb1e3af7722d4ae3d8046f33a59882f3c150429.tar nixpkgs-7fb1e3af7722d4ae3d8046f33a59882f3c150429.tar.gz nixpkgs-7fb1e3af7722d4ae3d8046f33a59882f3c150429.tar.bz2 nixpkgs-7fb1e3af7722d4ae3d8046f33a59882f3c150429.tar.lz nixpkgs-7fb1e3af7722d4ae3d8046f33a59882f3c150429.tar.xz nixpkgs-7fb1e3af7722d4ae3d8046f33a59882f3c150429.tar.zst nixpkgs-7fb1e3af7722d4ae3d8046f33a59882f3c150429.zip | |
nixos/doc: Mention how to contribute to it
Instead of putting a README in the directory where the manual is written, put the information from it straight in the docs themselves. It's a bit untrivial to guess the manual is located exactly there for contributers.
| -rw-r--r-- | nixos/doc/manual/README | 13 | ||||
| -rw-r--r-- | nixos/doc/manual/contributing-to-this-manual.xml | 22 | ||||
| -rw-r--r-- | nixos/doc/manual/manual.xml | 1 |
3 files changed, 25 insertions, 11 deletions
diff --git a/nixos/doc/manual/README b/nixos/doc/manual/README index 587f6275197..120c127d7af 100644 --- a/nixos/doc/manual/README +++ b/nixos/doc/manual/README @@ -1,12 +1,3 @@ -To build the manual, you need Nix installed on your system (no need -for NixOS). To install Nix, follow the instructions at +Moved to: ./contributing-to-this-manual.xml. Link: - https://nixos.org/nix/download.html - -When you have Nix on your system, in the root directory of the project -(i.e., `nixpkgs`), run: - - nix-build nixos/release.nix -A manual.x86_64-linux - -When this command successfully finishes, it will tell you where the -manual got generated. +https://nixos.org/manual/nixos/unstable/#chap-contributing diff --git a/nixos/doc/manual/contributing-to-this-manual.xml b/nixos/doc/manual/contributing-to-this-manual.xml new file mode 100644 index 00000000000..9820e75fc33 --- /dev/null +++ b/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/nixos/doc/manual +<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> diff --git a/nixos/doc/manual/manual.xml b/nixos/doc/manual/manual.xml index 18a67a2dd94..db9e7313831 100644 --- a/nixos/doc/manual/manual.xml +++ b/nixos/doc/manual/manual.xml @@ -19,5 +19,6 @@ <xi:include href="./generated/options-db.xml" xpointer="configuration-variable-list" /> </appendix> + <xi:include href="contributing-to-this-manual.xml" /> <xi:include href="release-notes/release-notes.xml" /> </book> |