diff --git a/README.rst b/README.rst index 94bd9cad97091bd24a846bc72c4ac95e56a100d7..f789130688cce2d1e96015641540daad1076df77 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/docs/source/README.rst b/docs/source/README.rst deleted file mode 100644 index 068656ccfbf7aabee907d6ffb3ac28c37415f7b7..0000000000000000000000000000000000000000 --- a/docs/source/README.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../../README.rst diff --git a/docs/source/architecture-overview.rst b/docs/source/architecture-overview.rst deleted file mode 100644 index d8480a2483ebab1585287537f06b5a08664300d4..0000000000000000000000000000000000000000 --- a/docs/source/architecture-overview.rst +++ /dev/null @@ -1,4 +0,0 @@ -Architecture Overview -===================== - -.. graphviz:: architecture-overview.dot diff --git a/docs/source/dev/README.rst b/docs/source/dev/README.rst index 5550b7c3ec3e4c5fad98a503244da21e44d5686b..c3a77e83cb54b57ac107ed291aceab1e246573c7 100644 --- a/docs/source/dev/README.rst +++ b/docs/source/dev/README.rst @@ -1,4 +1,36 @@ -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. diff --git a/docs/source/architecture-overview.dot b/docs/source/dev/architecture-overview.dot similarity index 100% rename from docs/source/architecture-overview.dot rename to docs/source/dev/architecture-overview.dot diff --git a/docs/source/index.rst b/docs/source/index.rst index 361fc01bf2a87463ad54a6bdfb7e771ac54f7804..aa38cfd14a28a782f219d95847ac099c9e6e8fb5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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> diff --git a/docs/source/morph.rst b/docs/source/morph.rst deleted file mode 100644 index 5bcffb5fb5a6928a69300dcfb3ac4cb7126ba09a..0000000000000000000000000000000000000000 --- a/docs/source/morph.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../../morph/README.rst diff --git a/docs/source/ops/README.rst b/docs/source/ops/README.rst index 27195d3574dd18c2a3398555d6b8ec258e0e5402..22b53e6590d9564a4635c03dc3cd6fd8b982c5cc 100644 --- a/docs/source/ops/README.rst +++ b/docs/source/ops/README.rst @@ -1,4 +1,9 @@ -Deployment documentation -======================== +Adminstrator documentation +========================== This contains documentation regarding running PrivateStorageIo. + +.. include:: + ../../../morph/README.rst + :start-line: 9 + diff --git a/docs/source/user/README.rst b/docs/source/user/README.rst index 7c2dfdc1360ed7ee6c478ad52c4d6af0680daa30..2a6e4b912cb6dfafb250149eb8aab095c34ce023 100644 --- a/docs/source/user/README.rst +++ b/docs/source/user/README.rst @@ -1,4 +1,5 @@ User documentation ================== -This contains user documentation. +This will contain the user documentation for this project. +