GemeenteUtrecht · damm89 · Apr 18, 2024 · Apr 18, 2024
diff --git a/doc/conf.py b/doc/conf.py
@@ -22,7 +22,7 @@
 author = "Gemeente Utrecht"
 
 # The full version, including alpha/beta/rc tags
-release = "0.1.3"
+release = "0.6.3"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/doc/django.rst → doc/developers/django.rst b/doc/django.rst → doc/developers/django.rst
diff --git a/doc/docker.rst → doc/developers/docker.rst b/doc/docker.rst → doc/developers/docker.rst
diff --git a/doc/frontend.rst → doc/developers/frontend.rst b/doc/frontend.rst → doc/developers/frontend.rst
diff --git a/doc/developers/index.rst b/doc/developers/index.rst
@@ -0,0 +1,14 @@
+==========
+Developers
+==========
+
+This section of the documentation is aimed developers working on the DoWC.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developers
+
+   django
+   docker
+   frontend
+   testing
diff --git a/doc/developers/testing.rst b/doc/developers/testing.rst
@@ -0,0 +1,15 @@
+.. _testing:
+
+=======
+Testing
+=======
+
+This document covers the tools to run tests and how to use them.
+
+
+Django tests
+============
+
+Run the project tests by executing::
+
+    $ python src/manage.py test dowc
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,29 +1,36 @@
 Document Wijzigen Component Documentation
 =========================================
 
-**Document Wijzigen Component** (short DO.W.C.) is a WebDAV server exposing documents stored in a `Documenten API <https://documenten-api.vng.cloud/>`_.
+:Version: 0.6.3
+:Source: https://github.com/GemeenteUtrecht/dowc
+:Keywords: dowc, webdav, reading documents, editing documents, native office
+:PythonVersion: 3.8
 
-Access to documents is obtained by creating authenticated links via the DO.W.C. API endpoints. WebDAV clients, such as MS Office Word, Excel etc. are then able to read and modify (with the correct permissions) these documents. DO.W.C. is built in Python/Django.
-
-The authentication mechanism relies on `zgw-auth-backend <https://github.com/maykinmedia/zgw-auth-backend>`_.
+|build-status| |black|
 
+A webapplication to use the native MS Office application to read and edit documents.
 Please refer to this document on how to start, configure and get the DO.W.C. running yourself.
 
 .. toctree::
    :maxdepth: 2
-   :hidden:
+   :caption: Contents
 
-   docker
-   configuration
-   frontend
-   django
-   mechanics
-   supported_formats 
+   introduction
+   technical_requirements
+   usage/index
+   developers/index 
 
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
+
+.. |build-status| image:: https://travis-ci.org/GemeenteUtrecht/dowc.svg?branch=master
+    :alt: Build status
+    :target: https://travis-ci.org/GemeenteUtrecht/dowc
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
diff --git a/doc/introduction.rst b/doc/introduction.rst
@@ -0,0 +1,10 @@
+.. _introduction:
+
+Introduction
+============
+
+**Document Wijzigen Component** (short DO.W.C.) is a WebDAV server exposing documents stored in a `Documenten API <https://documenten-api.vng.cloud/>`_.
+
+Access to documents is obtained by creating authenticated links via the DO.W.C. API endpoints. WebDAV clients, such as MS Office Word, Excel etc. are then able to read and modify (with the correct permissions) these documents. DO.W.C. is built in Python/Django.
+
+The authentication mechanism relies on `zgw-auth-backend <https://github.com/maykinmedia/zgw-auth-backend>`_.
diff --git a/doc/technical_requirements.rst b/doc/technical_requirements.rst
@@ -0,0 +1,45 @@
+.. _technical-requirements:
+
+
+Software requirements
+=====================
+=======================  ==============
+Software/framework       Version        
+-----------------------  --------------
+Python                   3.8
+PostgreSQL               9.6+  
+Node                     13
+=======================  ==============
+
+The current python dependencies can be found in github repository dowc/requirements/production.txt.
+The current node dependencies can be found in github repository dowc/package.json.
+
+
+Hardware requirements
+=====================
+
+Currently in our production implementation we have ~50 concurrent users and run the following
+kubernetes settings:
+
+=======================  ==============
+Resource                 Values        
+-----------------------  --------------
+DOWC
+-----------------------  --------------
+CPU: requests            750m             
+CPU: limits              750m
+Memory: requests         512Mi
+Memory: limits           512Mi
+Storage                  Persistent 1Gi
+Replica count            1-100
+Replica autoscale        True
+-----------------------  --------------
+Redis
+-----------------------  --------------
+CPU: requests            256m             
+CPU: limits              256m
+Memory: requests         64Mi
+Memory: limits           128Mi
+Storage                  Persistent 1Gi
+Replica count            1
+=======================  ==============
diff --git a/doc/usage/admin.rst b/doc/usage/admin.rst
@@ -0,0 +1,7 @@
+.. _admin:
+
+====
+TODO
+====
+
+#TODO: Create write up on how to manage locked documents.
diff --git a/doc/configuration.rst → doc/usage/configuration.rst b/doc/configuration.rst → doc/usage/configuration.rst
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
@@ -0,0 +1,15 @@
+=====
+Usage
+=====
+
+This section of the documentation is aimed users managing the DoWC.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developers
+
+   configuration
+   mechanics
+   supported_formats
+   admin
+
diff --git a/doc/mechanics.rst → doc/usage/mechanics.rst b/doc/mechanics.rst → doc/usage/mechanics.rst
diff --git a/doc/supported_formats.rst → doc/usage/supported_formats.rst b/doc/supported_formats.rst → doc/usage/supported_formats.rst