From 2c0a8afc9f132c0668fff25ae4cf7de15b7f4403 Mon Sep 17 00:00:00 2001 From: David Trattnig <david.trattnig@o94.at> Date: Thu, 30 Apr 2020 13:23:10 +0200 Subject: [PATCH] Added TOCs. --- docs/installation-development.md | 13 +++++++++++++ docs/installation-production.md | 14 ++++++++++++++ docs/running-docker.md | 12 ++++++++++++ 3 files changed, 39 insertions(+) diff --git a/docs/installation-development.md b/docs/installation-development.md index b2cff013..92082d49 100644 --- a/docs/installation-development.md +++ b/docs/installation-development.md @@ -1,5 +1,18 @@ # Install for Development +<!-- TOC --> + +- [Install for Development](#install-for-development) + - [Prerequisites](#prerequisites) + - [Setup Database](#setup-database) + - [Installation](#installation) + - [Configuration](#configuration) + - [Running Engine](#running-engine) + - [Logging](#logging) + - [Read more](#read-more) + +<!-- /TOC --> + ## Prerequisites Aura Engine runs on any modern Debian-based OS. It requires at least diff --git a/docs/installation-production.md b/docs/installation-production.md index 1c849ead..2dbe53de 100644 --- a/docs/installation-production.md +++ b/docs/installation-production.md @@ -1,5 +1,19 @@ # Install for Production +<!-- TOC --> + +- [Install for Production](#install-for-production) + - [Prerequisites](#prerequisites) + - [Installation](#installation) + - [Configuration](#configuration) + - [Running Engine](#running-engine) + - [The API Server](#the-api-server) + - [Maintanence using Supervisor](#maintanence-using-supervisor) + - [Logging](#logging) + - [Read more](#read-more) + +<!-- /TOC --> + ## Prerequisites Aura Engine runs on any modern Debian-based OS. It requires at least diff --git a/docs/running-docker.md b/docs/running-docker.md index 863f67f9..e74aa774 100644 --- a/docs/running-docker.md +++ b/docs/running-docker.md @@ -11,6 +11,18 @@ https://hub.docker.com/repository/docker/autoradio/engine It's not yet ready to be offically used. If you want to try AURA Engine meanwhile try the [Standard Installation](docs/installation-development). +<!-- TOC --> + +- [Running Engine with Docker](#running-engine-with-docker) + - [Start an image](#start-an-image) + - [Configure an image](#configure-an-image) + - [Making Docker Releases](#making-docker-releases) + - [Build your own, local Docker image](#build-your-own-local-docker-image) + - [Releasing a new version to DockerHub](#releasing-a-new-version-to-dockerhub) + - [Read more](#read-more) + +<!-- /TOC --> + ## Start an image *To be extended ...* -- GitLab