From 2fde93ac89b05318bf56b2775c86a5fee8556218 Mon Sep 17 00:00:00 2001
From: Florian Sesser <florian@leastauthority.com>
Date: Tue, 12 Jan 2021 21:36:30 +0000
Subject: [PATCH] Docs: Structure into User, Ops, Dev documentation.
---
README.rst | 8 +++++++-
docs/source/dev/README.rst | 4 ++++
docs/source/index.rst | 3 +++
docs/source/ops/README.rst | 4 ++++
docs/source/user/README.rst | 4 ++++
5 files changed, 22 insertions(+), 1 deletion(-)
create mode 100644 docs/source/dev/README.rst
create mode 100644 docs/source/ops/README.rst
create mode 100644 docs/source/user/README.rst
diff --git a/README.rst b/README.rst
index 9a847edb..94bd9cad 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,7 @@
PrivateStorageio
================
-The backend for a private, secure, and end-to-end encrypted storage solution
+The backend for a private, secure, and end-to-end encrypted storage solution.
Building
--------
@@ -14,6 +14,12 @@ Start by setting up the development/operations environment::
Documentation
~~~~~~~~~~~~~
+There is documentation for:
+
+* Users: ``docs/user/README.rst``
+* Operators/Admins: ``docs/ops/README.rst``
+* Developers: ``docs/dev/README.rst``
+
The documentation can be built using this command::
$ nix-build docs.nix
diff --git a/docs/source/dev/README.rst b/docs/source/dev/README.rst
new file mode 100644
index 00000000..5550b7c3
--- /dev/null
+++ b/docs/source/dev/README.rst
@@ -0,0 +1,4 @@
+Development documentation
+=========================
+
+This contains development documentation.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 8cc638a2..361fc01b 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -13,6 +13,9 @@ Welcome to PrivateStorageio's documentation!
README
architecture-overview
morph
+ user/README
+ ops/README
+ dev/README
diff --git a/docs/source/ops/README.rst b/docs/source/ops/README.rst
new file mode 100644
index 00000000..27195d35
--- /dev/null
+++ b/docs/source/ops/README.rst
@@ -0,0 +1,4 @@
+Deployment documentation
+========================
+
+This contains documentation regarding running PrivateStorageIo.
diff --git a/docs/source/user/README.rst b/docs/source/user/README.rst
new file mode 100644
index 00000000..7c2dfdc1
--- /dev/null
+++ b/docs/source/user/README.rst
@@ -0,0 +1,4 @@
+User documentation
+==================
+
+This contains user documentation.
--
GitLab