Skip to content
Snippets Groups Projects
Commit 31a49328 authored by Daniel Hornung's avatar Daniel Hornung
Browse files

WIP DOC: Server structure.

parent eefbef6d
No related branches found
No related tags found
2 merge requests!21Release v0.4.0,!15Document server code structure
Pipeline #7979 passed
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*.
CaosDB's internal structure
===========================
......@@ -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>
......
......@@ -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.
......
......@@ -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>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment