Add admin manual and detailed changelog sections

Author: ciur

docs/admin-manual/overview.md

@@ -0,0 +1,5 @@
+
+# Overview
+
+In this section, you will find information relevant to the administration and maintenance of the
+{{ extra.project }}.

docs/admin-manual/upgrade-instructions.md

@@ -0,0 +1,15 @@
+# Upgrades
+
+This document describes version specific upgrade instructions.
+
+!!! Note
+
+    Always backup your database before performing an upgrade to next Papermerge version
+
+## 3.5.3 (not yet released)
+
+When migration from `3.5.2` to `3.5.3` make sure that you don't have in database table `users` entries with `home_folder_id` or `inbox_folder_id` columns set to NULL - in such case migration will fail. 
+
+Though it was possible before 3.5.3 under certain circumstances to create users with either one or both of these two columns set to NULL, it is very unlikely that this case is relevant for you.
+In case you have some - please delete these entries (`DELETE users WHERE home_folder_id IS NULL OR inbox_folder_id IS NULL`)
+No worries about deleting user entity with NULL value for `home_folder_id` or `home_folder_id` as such entities are stale anyway - they have no documents associated and no login is possible. 

docs/admin-manual/version-matrix.md

@@ -0,0 +1,12 @@
+# Version Matrix
+
+The individual {{extra.project}} services, can be executed in Docker containers. To retain version compatibility, use only the listed image tags for {{extra.project}} versions.
+
+## {{extra.project}} Versions
+
+The listed versions have been tested. Other combinations might work as well, but can cause side effects, that are not supported by {{extra.project}}.
+
+| Papermerge Version | Docker Image | Auth Server<br>(used only internally) |OCR Worker | Path Template Worker | S3 Worker | i3 Worker | DB |  Redis | Solr |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
+| [**3.5.2**](https://github.com/papermerge/papermerge-core/releases/tag/3.5.2) | papermerge/papermerge:3.5.2 | papermerge/auth-server:1.1.3 |papermerge/ocrworker:0.3.1 | papermerge/path-tmpl-worker:0.4 | papermerge/s3worker:0.5 | papermerge/i3worker:0.3 |  postgres:16.1 | bitname-redis:7.2 | solr:9.7 |
+| [**3.4.1**](https://github.com/papermerge/papermerge-core/releases/tag/3.4.1) | papermerge/papermerge:3.4.1 | papermerge/auth-server:1.0.2 | papermerge/ocrworker:0.3.1 | papermerge/path-tmpl-worker:0.3.2 | papermerge/s3worker:0.4.3 | papermerge/i3worker:0.3 | postgres:16.1 | bitname-redis:7.2 | solr:9.7 |

docs/changelog/3.5/3.5.3.md

@@ -0,0 +1,36 @@
+
+# 3.5.3 – Not Yet Released
+
+If you want to see all database schema changes for the 3.5.3 release, have a look at the
+[migrations folder](https://github.com/papermerge/papermerge-core/tree/master/papermerge/core/alembic/versions) — specifically, all files containing `__v3_5_3__` in their name.
+
+## Async Instead of Sync
+
+This enhancement is related to performance.
+Simply put, the REST API core server can now handle many more concurrent connections.
+This is possible because its internal mechanics have changed:
+instead of handling connections and database requests synchronously, they are now handled asynchronously.
+
+## Home/Inbox DB Checks
+
+This enhancement introduces the following database schema changes:
+`users.home_folder_id` and `users.inbox_folder_id` now have a "NOT NULL" database constraint.
+This means that, at the database level, it is guaranteed that a user will always have
+an existing home and inbox folder.
+
+To make this technically possible, the `nodes_user_id_fkey` foreign key constraint on the `nodes` table
+was changed to be *deferrable*.
+
+The purpose of this change is to prevent situations where a user is created
+without an associated home or inbox folder.
+
+## Length Limit on Users Columns
+
+This is a security-related database schema change.
+The following columns of the `users` table now have upper length limits:
+
+* `email`: limited to 254 characters
+* `password`: limited to 255 characters
+* `username`: limited to 150 characters
+* `first_name`: limited to 100 characters
+* `last_name`: limited to 100 characters

docs/changelog/overview.md

@@ -0,0 +1,5 @@
+# Overview
+
+This section provides detailed changelog information of the {{extra.project}}.
+A shorter version of this document can be found in the
+ [Papermerge Core repo](https://github.com/papermerge/papermerge-core/blob/master/changelog.md).

mkdocs.yml

@@ -30,6 +30,10 @@ nav:
     - user/group-ownership.md
     - user/roles.md
     - user/sharing.md
+  - Administrator Manual:
+    - "admin-manual/overview.md"
+    - "admin-manual/version-matrix.md"
+    - "admin-manual/upgrade-instructions.md"
   - SSO:
     - sso/overview.md
     - OIDC:
@@ -52,6 +56,9 @@ nav:
     - settings/ocrworker.md
     - settings/i3worker.md
   - "pmdump.md"
+  - Changelog:
+    - "changelog/overview.md"
+    - "changelog/3.5/3.5.3.md"
   - REST API:
     - "rest-api/overview.md"
     - "rest-api/reference.md"