Commit c4e7fb0e authored by David Trattnig's avatar David Trattnig
Browse files

Add some meat.

parent 44890c6f
......@@ -2,7 +2,7 @@
# Developer Guide
This guide holds all general information for AURA developers. For more specific documentation please consult the individual `README.md` files in the relevant projects.
This guide holds all general information for AURA developers. For more specific documentation please consult the individual `README.md` files [in the relevant projects](https://gitlab.servus.at/aura).
1. [Developer Guide](#developer-guide)
1. [Architecture](#architecture)
......@@ -12,11 +12,10 @@ This guide holds all general information for AURA developers. For more specific
3. [Development](#development)
1. [Coding Conventions](#coding-conventions)
2. [Network Diagramm](#network-diagramm)
3. [Component Diagramm](#component-diagramm)
4. [Simplified Data Model](#simplified-data-model)
5. [AURA CLI](#aura-cli)
6. [AURA API](#aura-api)
7. [Conflict Resolution for the timetable](#conflict-resolution-for-the-timetable)
3. [Simplified Data Model](#simplified-data-model)
4. [AURA CLI](#aura-cli)
5. [AURA API](#aura-api)
6. [Conflict Resolution for the timetable](#conflict-resolution-for-the-timetable)
4. [Planning](#planning)
1. [Sprint Planning](#sprint-planning)
2. [Planned Versions and Release Criteria](#planned-versions-and-release-criteria)
......@@ -39,7 +38,7 @@ Some of our core organisational and architectural requirements for AURA are:
Out of these requirements we came to an architecture which visually represented
in the components diagram.
> Note: The following diagram doesn't reflect all the details of the current implementation. It will be updated at some point.
> Note: The following component diagram doesn't reflect all the details of the current implementation. It will be updated at some point.
![Diagram illustrating the AuRa components](https://gitlab.servus.at/aura/meta/raw/master/assets/images/components.png "AuRa Components")
......@@ -103,41 +102,47 @@ Then it is recommended to configure the projects in following order:
### Coding Conventions
*to be defined*
Check out the [Coding Conventions](coding-conventions.md) page.
### Network Diagramm
*to be defined*
### Component Diagramm
*to be defined*
Check out the provided [Network Diagrams](network-diagram.md) on ideas how the individual projects can be deployed within your infrastructure.
### Simplified Data Model
*to be defined*
Here's a simplified data model on how data is stored in [Steering]().
<a href="assets/images/aura-data-model-simple.png"><img src="assets/images/aura-data-model-simple.png" width="500" /></a>
### AURA CLI
*to be defined*
Find out more in the [Administration | CLI documentation](../administration/cli.md).
### AURA API
*to be defined*
The AURA API is specified using OpenAPI 3:
* Steering API ([**TODO: Provide OpenAPI 3 Specification**](https://gitlab.servus.at/aura/steering/-/issues/44))
* Tank API ([**TODO: Provide OpenAPI 3 Specification**](https://gitlab.servus.at/aura/tank/-/issues/7))
* Engine API (https://app.swaggerhub.com/apis/AURA-Engine/engine-api/1.0.0).
> Open API for Steering and Tank is work in progress. Meanwhile you can find a rudimentary [API definition](api-definition.md).
### Conflict Resolution for the timetable
Check out the [Conflict Resolution](../administration/conflict-resolution.md) page.
Check out the [Administration | Conflict Resolution Documentation](../administration/conflict-resolution.md) page.
## Planning
### Sprint Planning
*to be defined*
*TODO: [Define sprint planning workflow](https://gitlab.servus.at/aura/meta/-/issues/64)*
The current sprint can be looked-up at our [Scrum Board](https://gitlab.servus.at/aura/meta/-/boards).
### Planned Versions and Release Criteria
*to be defined*
The project status and current version can be found at the [AURA Wiki: Project Status Page (German)](https://gitlab.servus.at/aura/meta/-/wikis/Projektstatus).
## Release Managment
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment