Commit 3864ed81 authored by David Trattnig's avatar David Trattnig
Browse files

Add structure.

parent 8839283b
......@@ -2,6 +2,8 @@
# API Specification
[← Developer Guide | Overview](index.md)
This page gives an overview of the Aura API Endpoints.
<!-- TOC -->
......
......@@ -3,6 +3,8 @@
# Bug Reports
[← Developer Guide | Overview](index.md)
Tell us your problems!
But please use the bug report template below.
......
......@@ -3,4 +3,6 @@
# Coding Conventions
[← Developer Guide | Overview](index.md)
*to be defined via https://gitlab.servus.at/aura/meta/-/issues/63*.
\ No newline at end of file
......@@ -2,6 +2,29 @@
# Schedules and conflict resolution
[← Developer Guide | Overview](index.md)
1. [Schedules and conflict resolution](#schedules-and-conflict-resolution)
1. [Overview](#overview)
2. [Create/update schedule](#createupdate-schedule)
3. [Return](#return)
4. [Solutions](#solutions)
1. [theirs (always possible)](#theirs-always-possible)
2. [ours (always possible)](#ours-always-possible)
3. [theirs-start](#theirs-start)
4. [ours-start](#ours-start)
5. [theirs-end](#theirs-end)
6. [ours-end](#ours-end)
7. [theirs-both](#theirs-both)
8. [ours-both](#ours-both)
1. [Multiple collisions](#multiple-collisions)
5. [Errors](#errors)
1. [Fatal errors that require the schedule's data to be corrected and the resolution to restart](#fatal-errors-that-require-the-schedules-data-to-be-corrected-and-the-resolution-to-restart)
2. [Conflict-related errors which can be resolved for each conflict:](#conflict-related-errors-which-can-be-resolved-for-each-conflict)
6. [Read more](#read-more)
## Overview
Creating timeslots is only possible by creating/updating a schedule.
When creating/updating a schedule by giving the schedule data:
......
......@@ -3,6 +3,8 @@
# Contributing to AURA
[← Developer Guide | Overview](index.md)
1. [Contributing to AURA](#contributing-to-aura)
1. [Code of Conduct](#code-of-conduct)
2. [How can I contribute?](#how-can-i-contribute)
......
......@@ -3,9 +3,14 @@
# Default hosts and ports
These are the default hosts and ports for all AURA applications.
[← Developer Guide | Overview](index.md)
# Development environment
Here you find the default hosts and ports for all AURA applications.
1. [Default hosts and ports](#default-hosts-and-ports)
1. [Development environment](#development-environment)
## Development environment
| Component | Host:Port | Description |
|-----------------|:--------------------:|:------------------------------|
......
......@@ -3,6 +3,8 @@
# Developer Guide | Installation
[← Developer Guide | Overview](index.md)
For Development the native installation as outlined in the `README.md` of each project is recommended.
In case you are not developing on some certain project, but need it as a dependency only, you can install it using the Docker Image deployment variant.
......
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