diff options
| author | Antoine Eiche <lewo@abesis.fr> | 2020-07-06 22:23:03 +0200 |
|---|---|---|
| committer | Antoine Eiche <lewo@abesis.fr> | 2020-07-06 22:33:19 +0200 |
| commit | 8db0e184380c8bde8a4ab65d913370761c20e5b4 (patch) | |
| tree | 1d22f99e8eb8e95d8e239634742f1e3a74dc7f33 /docs | |
| parent | 781073b64d4608490155cf87cccb0357d889444c (diff) | |
docs: how to contribute to documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/howto-develop.rst | 37 |
1 files changed, 28 insertions, 9 deletions
diff --git a/docs/howto-develop.rst b/docs/howto-develop.rst index 3a6361c..173c4f3 100644 --- a/docs/howto-develop.rst +++ b/docs/howto-develop.rst @@ -1,17 +1,36 @@ How to Develop SNM ================== -Run tests ---------- +Run NixOS tests +--------------- You can run the testsuite via :: - nix-build tests -A extern.nixpkgs_20_03 - nix-build tests -A intern.nixpkgs_unstable + $ nix-build tests -A extern.nixpkgs_20_03 + $ nix-build tests -A intern.nixpkgs_unstable ... +Contributing to the documentation +--------------------------------- + +The documentation is written in RST, build with Sphinx and published +by `Read the Docs <https://readthedocs.org/>`_. + +For the syntax, see `RST/Sphinx Cheatsheet +<https://sphinx-tutorial.readthedocs.io/cheatsheet/>`_. + +The ``shell.nix`` provides all the tooling required to build the +documentation: + +:: + + $ nix-shell + $ cd docs + $ make html + $ firefox ./_build/html/index.html + Nixops ------ @@ -19,15 +38,15 @@ You can test the setup via ``nixops``. After installation, do :: - nixops create nixops/single-server.nix nixops/vbox.nix -d mail - nixops deploy -d mail - nixops info -d mail + $ nixops create nixops/single-server.nix nixops/vbox.nix -d mail + $ nixops deploy -d mail + $ nixops info -d mail You can then test the server via e.g. \ ``telnet``. To log into it, use :: - nixops ssh -d mail mailserver + $ nixops ssh -d mail mailserver Imap ---- @@ -36,4 +55,4 @@ To test imap manually use :: - openssl s_client -host mail.example.com -port 143 -starttls imap + $ openssl s_client -host mail.example.com -port 143 -starttls imap |