christian
/
nixos-mailserver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: how to contribute to documentation

This commit is contained in:
Antoine Eiche 2020-07-06 22:23:03 +02:00
parent 781073b64d
commit 8db0e18438
1 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/howto-develop.rst
View File

@ -1,17 +1,36 @@
How to Develop SNM How to Develop SNM
================== ==================
Run tests Run NixOS tests
--------- ---------------
You can run the testsuite via You can run the testsuite via
:: ::
nix-build tests -A extern.nixpkgs_20_03 $ nix-build tests -A extern.nixpkgs_20_03
nix-build tests -A intern.nixpkgs_unstable $ 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 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 create nixops/single-server.nix nixops/vbox.nix -d mail
nixops deploy -d mail $ nixops deploy -d mail
nixops info -d mail $ nixops info -d mail
You can then test the server via e.g. \ ``telnet``. To log into it, use 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 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