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

Update TOC and refs.

parent 053e558b
...@@ -10,16 +10,16 @@ the requirements of community radio stations. ...@@ -10,16 +10,16 @@ the requirements of community radio stations.
<!-- TOC --> <!-- TOC -->
- [Aura Engine](#aura-engine) - [Aura Engine](#aura-engine)
- [Functionality](#functionality) - [Functionality](#functionality)
- [Scheduler](#scheduler) - [Scheduler](#scheduler)
- [Versatile playlists](#versatile-playlists) - [Versatile playlists](#versatile-playlists)
- [Default playlists](#default-playlists) - [Default playlists](#default-playlists)
- [Heartbeat Monitoring](#heartbeat-monitoring) - [Heartbeat Monitoring](#heartbeat-monitoring)
- [Logging](#logging) - [Logging](#logging)
- [Getting started](#getting-started) - [Getting started](#getting-started)
- [Using Docker](#using-docker) - [Using Docker](#using-docker)
- [Read more](#read-more) - [Read more](#read-more)
- [About](#about) - [About](#about)
<!-- /TOC --> <!-- /TOC -->
...@@ -30,7 +30,7 @@ In conjuction with other AURA components Engine provides several features: ...@@ -30,7 +30,7 @@ In conjuction with other AURA components Engine provides several features:
- **Scheduler** to automatically broadcast your radio programme (see [AURA Dashboard](https://gitlab.servus.at/aura/dashboard) for an user interface to do scheduling) - **Scheduler** to automatically broadcast your radio programme (see [AURA Dashboard](https://gitlab.servus.at/aura/dashboard) for an user interface to do scheduling)
- **Analog input and outputs** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core) - **Analog input and outputs** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core)
- **Streaming to an [Icecast](https://icecast.org/) Server including [Icy Metadata](https://cast.readme.io/docs/icy)** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core) - **Streaming to an [Icecast](https://icecast.org/) Server including [Icy Metadata](https://cast.readme.io/docs/icy)** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core)
- **Autonomous playout** by caching the schedule information pulled from [Steering](https://gitlab.servus.at/aura/steering) in a local database. This allows Engine be keep running, independently from any network or service outages. This enables the application of (*High Availability* infrastructure scenarios)[https://gitlab.servus.at/aura/meta/-/blob/master/docs/installation-guide.md#high-availability]. - **Autonomous playout** by caching the schedule information pulled from [Steering](https://gitlab.servus.at/aura/steering) in a local database. This allows Engine be keep running, independently from any network or service outages. This enables the application of (*High Availability* infrastructure scenarios)[https://gitlab.servus.at/aura/meta/-/blob/master/docs/administration/installation-guide.md#high-availability].
- **Auto DJ with Silcence Detector** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core) - **Auto DJ with Silcence Detector** provided by [Engine Core](https://gitlab.servus.at/aura/engine-core)
- **Web Application for a Track Service** (see [AURA Player](https://gitlab.servus.at/aura/player)) - **Web Application for a Track Service** (see [AURA Player](https://gitlab.servus.at/aura/player))
- **Web Application providing a Studio Clock** (see [Engine Clock](https://gitlab.servus.at/aura/engine-clock)) - **Web Application providing a Studio Clock** (see [Engine Clock](https://gitlab.servus.at/aura/engine-clock))
......
...@@ -4,15 +4,15 @@ This page gives insights on extending Aura Engine internals or through the API. ...@@ -4,15 +4,15 @@ This page gives insights on extending Aura Engine internals or through the API.
<!-- TOC --> <!-- TOC -->
- [Aura Engine Development Guide](#aura-engine-development-guide) 1. [Aura Engine Development Guide](#aura-engine-development-guide)
- [AURA Componentes](#aura-componentes) 1. [AURA Componentes](#aura-componentes)
- [Engine Components](#engine-components) 2. [Engine Components](#engine-components)
- [Running for Development](#running-for-development) 3. [Running for Development](#running-for-development)
- [Testing](#testing) 4. [Testing](#testing)
- [API](#api) 5. [API](#api)
- [Scheduler](#scheduler) 6. [Scheduler](#scheduler)
- [Docker](#docker) 7. [Docker](#docker)
- [Read more](#read-more) 8. [Read more](#read-more)
<!-- /TOC --> <!-- /TOC -->
...@@ -89,7 +89,7 @@ Test cases are located in `./tests`. The test command expects a virtual environm ...@@ -89,7 +89,7 @@ Test cases are located in `./tests`. The test command expects a virtual environm
## API ## API
You can find the AURA API definition here: https://gitlab.servus.at/autoradio/meta/blob/master/api-definition.md You can find the AURA API definition here: https://gitlab.servus.at/autoradio/meta/blob/master/development/api-definition.md
OpenAPI definition for Engine API: https://app.swaggerhub.com/apis/AURA-Engine/engine-api/ OpenAPI definition for Engine API: https://app.swaggerhub.com/apis/AURA-Engine/engine-api/
......
Supports Markdown
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