Update RELEASE_GUIDELINES

CHANGELOG.md

@@ -28,6 +28,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Deprecated
 
+* Legacy XML/HTTP API (also known as the REST API). The API will not be removed
+  until the web interface (caosdb-webui) and the python client libraries have
+  been updated and freed from any dependencies. However, new clients should not
+  implement this API anymore.
+
 ### Removed
 
 ### Fixed

DEPENDENCIES.md

-* caosdb-mysqlbackend == 5.0.0
-* Java 11
-* Apache Maven >= 3.6.0
-* make >= 4.2.0
+# Dependencies
+
+## For Building and Running the Server
+
+* `>=caosdb-proto 0.1.0`
+* `>=caosdb-mysqlbackend 5.0.0`
+* `>=Java 11`
+* `>=Apache Maven 3.6.0`
+* `>=Make 4.2`
+* `libpam` (if PAM authentication is required)
 * More dependencies are being pulled and installed automatically by Maven. See the complete list of dependencies in the [pom.xml](pom.xml)
+
+## For Deploying a Web User Interface (optional)
+
+* `>=caosdb-webui 0.4.`
+
+## For Building the Documentation (optional)
+
+* `>=Python 3.8`
+* `>=pip 21.0.0`
+
+## For Server-side Scripting (optional)
+
+* `>=Python 3.8`
+* `>=pip 21.0.0`
+* `openpyxl` (for XLS/ODS export)
+
+## Recommended Packages
+
+* `openssl` (if a custom TLS certificate is required)

FEATURES.md

+# Features
+
+* The CaosDB Server implements a CaosDB GRPC API Endpoint (v0.1.0)
+  Authentication is supported via a Basic scheme, using the well-known
+  "authentication" header.
+  Notable limitations of the current implementation of the API:
+  * It is currently not possible to mix retrievals
+    (caosdb.entity.v1.RetrieveRequest) with any other transaction type - so
+    transaction are either read-only or write-only. The server throws an error
+    if it finds mixed read/write transactions.
+  * It is currently not possible to have more that one query
+    (caosdb.entity.v1.Query) in a single transaction. The server throws an
+    error if it finds more than one query.
+* Legacy XML/HTTP API (Deprecated)
+* Deployment of caosdb-webui (>=v0.4.1)
+* Server-side Scripting API (v0.1)
+* CaosDB Query Language Processor
+* CaosDB FileSystem
+* User Management, Authentication and Authorization
+  * Internal authentication service
+  * Authentication via an external service.

README_SETUP.md

@@ -5,26 +5,7 @@ more.
 
 ## Requirements
 
-### CaosDB Packages
-
-* caosdb-webui=0.2.1
-* caosdb-mysqlbackend=3.0
-
-### Third-party Software
-
-* `>=Java 8`
-* `>=Apache Maven 3.0.4`
-* `>=Python 3.4`
-* `>=pip 9.0.1`
-* `>=git 1.9.1`
-* `>=Make 3.81`
-* `>=Screen 4.01`
-* `>=MySQL 5.5` (better `>=5.6`) or `>=MariaDB 10.1`
-* `libpam` (if PAM authentication is required)
-* `unzip`
-* `openpyxl` (for XLS/ODS export)
-* `openssl` (if a custom TLS certificate is required)
-- `easy-units` >= 0.0.1    https://gitlab.com/timm.fitschen/easy-units
+See [DEPENDENCIES.md](DEPENDENCIES.md).
 
 #### Install the requirements on Debian
 

RELEASE_GUIDELINES.md

@@ -31,3 +31,5 @@ guidelines of the CaosDB Project
 
 8. Update the version property in [pom.xml](./pom.xml) for the next
    developlement round (with a `-SNAPSHOT` suffix).
+
+9. Add a gitlab release in the respective repository.

src/doc/DEPENDENCIES.md

+../../DEPENDENCIES.md
\ No newline at end of file

src/doc/index.rst

@@ -13,6 +13,7 @@ Welcome to caosdb-server's documentation!
    Query Language <CaosDB-Query-Language>
    administration
    Development <development/devel>
+   Dependencies <DEPENDENCIES>
    specification/index.rst
    Glossary
    API documentation<_apidoc/packages>