From 31a493286f1be5d017ab137d7bdfeb1377d3e8ca Mon Sep 17 00:00:00 2001
From: Daniel Hornung <d.hornung@indiscale.com>
Date: Mon, 31 May 2021 18:23:14 +0200
Subject: [PATCH] WIP DOC: Server structure.
---
src/doc/development/devel.rst | 25 +++++++++++++++++++++++++
src/doc/development/structure.rst | 4 ++++
src/doc/index.rst | 2 +-
src/doc/specification/Fileserver.md | 3 ++-
src/doc/specification/index.rst | 4 +---
5 files changed, 33 insertions(+), 5 deletions(-)
create mode 100644 src/doc/development/devel.rst
create mode 100644 src/doc/development/structure.rst
diff --git a/src/doc/development/devel.rst b/src/doc/development/devel.rst
new file mode 100644
index 00000000..141b0455
--- /dev/null
+++ b/src/doc/development/devel.rst
@@ -0,0 +1,25 @@
+Developing CaosDB
+=================
+
+.. toctree::
+ :glob:
+ :maxdepth: 2
+
+ Structure of the Java code <structure>
+ Benchmarking CaosDB <benchmarking>
+
+CaosDB is an Open-Source project, so anyone may modify the source as they like. These pages aim to
+provide some help for all CaosDB developers.
+
+More generally, these are the most common ways to contribute to CaosDB:
+
+- You found a bug, have a question, or want to request a feature? Please `create an issue
+ <https://gitlab.com/caosdb/caosdb-server/-/issues>`_.
+- You want to contribute code? Please fork the repository and create a merge request in GitLab and
+ choose this repository as target. Make sure to select "Allow commits from members who can merge
+ the target branch" under Contribution when creating the merge request. This allows our team to
+ work with you on your request.
+- If you have a suggestion for this `documentation <https://docs.indiscale.com/caosdb-server/>`_,
+ the preferred way is also a merge request as describe above (the documentation resides in
+ ``src/doc``). However, you can also create an issue for it.
+- You can also contact the developers at *info (AT) caosdb.de*.
diff --git a/src/doc/development/structure.rst b/src/doc/development/structure.rst
new file mode 100644
index 00000000..7117a53f
--- /dev/null
+++ b/src/doc/development/structure.rst
@@ -0,0 +1,4 @@
+CaosDB's internal structure
+===========================
+
+
diff --git a/src/doc/index.rst b/src/doc/index.rst
index 870db025..8c366b3c 100644
--- a/src/doc/index.rst
+++ b/src/doc/index.rst
@@ -12,7 +12,7 @@ Welcome to caosdb-server's documentation!
Concepts <concepts>
Query Language <CaosDB-Query-Language>
administration
- development/*
+ Development <development/devel>
specification/index.rst
Glossary
API documentation<_apidoc/packages>
diff --git a/src/doc/specification/Fileserver.md b/src/doc/specification/Fileserver.md
index fda2ec18..badb4b41 100644
--- a/src/doc/specification/Fileserver.md
+++ b/src/doc/specification/Fileserver.md
@@ -35,7 +35,8 @@ where
### HTTP upload stream
#### Files
-There is an example on file upload using cURL described in detail in [the curl section of this wiki](manuals/curl/curl-access).
+There is an example on file upload using cURL described in detail in [the curl section of this
+documentation](../administration/curl-access.md).
File upload via HTTP is implemented in a [rfc1867](http://www.ietf.org/rfc/rfc1867.txt) consistent way. This is a de-facto standard that defines a file upload as a part of an HTML form submission. This concept shall not be amplified here. But it has to be noticed that this protocol is not designed for uploads of complete structured folders. Therefore the HeartDB file components have to impose that structure on the upload protocol.
diff --git a/src/doc/specification/index.rst b/src/doc/specification/index.rst
index e9683072..3609aa4a 100644
--- a/src/doc/specification/index.rst
+++ b/src/doc/specification/index.rst
@@ -8,15 +8,13 @@ Specification
:hidden:
AbstractProperty
- C-Client
Fileserver
Record
- Server-side-scripting
Specification of the Entity API <Specification-of-the-Entity-API>
Authentication
Datatype
Paging
RecordType
- Server side scripting <Server-side-scripting-v0.1>
+ Server side scripting <Server-side-scripting>
Specification of the Message API <Specification-of-the-Message-API>
--
GitLab