diff --git a/nixos/doc/manual/README b/nixos/doc/manual/README index 587f6275197a..120c127d7af2 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 000000000000..9820e75fc337 --- /dev/null +++ b/nixos/doc/manual/contributing-to-this-manual.xml @@ -0,0 +1,22 @@ + + Contributing to this documentation + + The DocBook sources of NixOS' manual are in the +nixos/doc/manual subdirectory of the Nixpkgs repository. + + + You can quickly check your edits with the following: + + +$ cd /path/to/nixpkgs/nixos/doc/manual +$ 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. + + diff --git a/nixos/doc/manual/manual.xml b/nixos/doc/manual/manual.xml index 18a67a2dd941..db9e7313831d 100644 --- a/nixos/doc/manual/manual.xml +++ b/nixos/doc/manual/manual.xml @@ -19,5 +19,6 @@ +