From 0fd55565d3204fbb152166c2186ba70f6cf38222 Mon Sep 17 00:00:00 2001 From: Bobby Rong Date: Fri, 23 Apr 2021 12:46:02 +0800 Subject: doc/contributing/*.xml: Convert to markdown --- .../contributing-to-documentation.chapter.md | 24 ++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/contributing/contributing-to-documentation.chapter.md (limited to 'doc/contributing/contributing-to-documentation.chapter.md') diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md new file mode 100644 index 000000000000..642beba74d61 --- /dev/null +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -0,0 +1,24 @@ +# Contributing to this documentation {#chap-contributing} + +The DocBook sources of the Nixpkgs manual are in the [doc](https://github.com/NixOS/nixpkgs/tree/master/doc) subdirectory of the Nixpkgs repository. + +You can quickly check your edits with `make`: + +```ShellSession +$ cd /path/to/nixpkgs/doc +$ nix-shell +[nix-shell]$ make $makeFlags +``` + +If you experience problems, run `make debug` to help understand the docbook errors. + +After making modifications to the manual, it's important to build it before committing. You can do that as follows: + +```ShellSession +$ cd /path/to/nixpkgs/doc +$ nix-shell +[nix-shell]$ make clean +[nix-shell]$ nix-build . +``` + +If the build succeeds, the manual will be in `./result/share/doc/nixpkgs/manual.html`. -- cgit 1.4.1