From d1e8fad976654dae563de23860dce4407dbf9a02 Mon Sep 17 00:00:00 2001 From: Maurice Zhou Date: Thu, 9 Sep 2021 13:35:58 +0800 Subject: [PATCH] NixOS: special procedures for building site Signed-off-by: Maurice Zhou --- docs/Getting Started/NixOS/index.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/Getting Started/NixOS/index.rst b/docs/Getting Started/NixOS/index.rst index 2f44f7b..5c95160 100644 --- a/docs/Getting Started/NixOS/index.rst +++ b/docs/Getting Started/NixOS/index.rst @@ -62,3 +62,31 @@ An installation guide is available. :glob: Root on ZFS/* + +Contribute +---------- +#. Fork and clone `this repo `__. + +#. Launch an ephemeral nix-shell with the following packages:: + + nix-shell -p python39 python39Packages.pip gnumake \ + python39Packages.setuptools python39Packages.sphinx + +#. Create python virtual environment and install packages:: + + cd openzfs-docs + python -m venv .venv + source .venv/bin/activate + + pip install -r docs/requirements.txt + +#. Make your changes. + +#. Test:: + + cd docs + make html + sensible-browser _build/html/index.html + +#. ``git commit --signoff`` to a branch, ``git push``, and create a pull + request. Mention @rlaager.