From dfb5d317ae57cdcc35715a233d04ad725f379a86 Mon Sep 17 00:00:00 2001
From: Florian Sesser <florian@leastauthority.com>
Date: Tue, 12 Jan 2021 23:43:19 +0000
Subject: [PATCH] Restructure documentation
Separate into User/Ops/Dev documentation.
---
README.rst | 31 ---------------
docs/source/README.rst | 2 -
docs/source/architecture-overview.rst | 4 --
docs/source/dev/README.rst | 38 +++++++++++++++++--
.../{ => dev}/architecture-overview.dot | 0
docs/source/index.rst | 14 +++----
docs/source/morph.rst | 2 -
docs/source/ops/README.rst | 9 ++++-
docs/source/user/README.rst | 3 +-
9 files changed, 50 insertions(+), 53 deletions(-)
delete mode 100644 docs/source/README.rst
delete mode 100644 docs/source/architecture-overview.rst
rename docs/source/{ => dev}/architecture-overview.dot (100%)
delete mode 100644 docs/source/morph.rst
diff --git a/README.rst b/README.rst
index 94bd9cad..f7891306 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 068656cc..00000000
--- 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 d8480a24..00000000
--- 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 5550b7c3..c3a77e83 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 361fc01b..aa38cfd1 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 5bcffb5f..00000000
--- 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 27195d35..22b53e65 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 7c2dfdc1..2a6e4b91 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.
+
--
GitLab