Skip to content
Snippets Groups Projects
Commit dfb5d317 authored by Florian Sesser's avatar Florian Sesser
Browse files

Restructure documentation

Separate into User/Ops/Dev documentation.
parent 2fde93ac
No related branches found
No related tags found
1 merge request!56Introduce user/op/dev structure for the documentation
......@@ -3,14 +3,6 @@ PrivateStorageio
The backend for a private, secure, and end-to-end encrypted storage solution.
Building
--------
The build system uses `Nix`_ which must be installed before anything can be built.
Start by setting up the development/operations environment::
$ nix-shell
Documentation
~~~~~~~~~~~~~
......@@ -26,26 +18,3 @@ The documentation can be built using this command::
The documentation is also built on and published by CI.
Testing
-------
The test system uses `Nix`_ which must be installed before any tests can be run.
Unit tests are run using this command::
$ nix-build nixos/unit-tests.nix
Unit tests are also run on CI.
The system tests are run using this command::
$ nix-build nixos/system-tests.nix
The system tests boot QEMU VMs which prevents them from running on CI at this time.
Deployment
----------
See ``morph/README.rst``.
.. _Nix: https://nixos.org/nix
.. include::
../../README.rst
Architecture Overview
=====================
.. graphviz:: architecture-overview.dot
Development documentation
=========================
Developer documentation
=======================
Building
--------
The build system uses `Nix`_ which must be installed before anything can be built.
Start by setting up the development/operations environment::
$ nix-shell
Testing
-------
The test system uses `Nix`_ which must be installed before any tests can be run.
Unit tests are run using this command::
$ nix-build nixos/unit-tests.nix
Unit tests are also run on CI.
The system tests are run using this command::
$ nix-build nixos/system-tests.nix
The system tests boot QEMU VMs which prevents them from running on CI at this time.
Architecture overview
---------------------
.. graphviz:: architecture-overview.dot
.. _Nix: https://nixos.org/nix
This contains development documentation.
......@@ -6,16 +6,14 @@
Welcome to PrivateStorageio's documentation!
============================================
Howdy! We separated the documentation into parts addressing different audiences. Please enjoy our docs for:
.. toctree::
:maxdepth: 2
:caption: Contents:
README
architecture-overview
morph
user/README
ops/README
dev/README
Users <user/README>
Administrators <ops/README>
Developers <dev/README>
......
.. include::
../../morph/README.rst
Deployment documentation
========================
Adminstrator documentation
==========================
This contains documentation regarding running PrivateStorageIo.
.. include::
../../../morph/README.rst
:start-line: 9
User documentation
==================
This contains user documentation.
This will contain the user documentation for this project.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment