From 0bb4711bd8ef8bf1611cbd9074fe42755deea12e Mon Sep 17 00:00:00 2001 From: David Trattnig <david@subsquare.at> Date: Thu, 3 Nov 2022 10:52:16 +0100 Subject: [PATCH] docs: update URLs --- docs/developer-guide.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 1a963ad1..b123ce80 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -23,7 +23,7 @@ This page gives insights on extending Aura Engine internals or through the API. AURA Engine as part of the AURA Radio Suite uses an modulear architecture based on a REST API. All external information is retrieved using JSON data-structures. -To get the basic architectural overview, visit the [Aura Meta](https://gitlab.servus.at/autoradio/meta) repository. +To get the basic architectural overview, visit [docs.aura.radio](https://docs.aura.radio). Starting development of engine can be quite tedious, as it requires all most all other AURA components to be up and running. @@ -36,9 +36,7 @@ For example: If you need to test and develop against the Engine's API you'll also need to get the `engine-api` project running. -For a start it is recommended to create a general `aura` project folder. In there you start cloning all the sub-projects. After having all the sub-projects configured, and verified that they are working, take a look at the AURA `meta` project. - -There's a convenience script to start all of the three main dependencies (Steering, Dashboard, Tank) all at once: +For a start it is recommended to create a general `aura` project folder. In there you start cloning all the sub-projects. After having all the sub-projects configured, and verified that they are working, take a look at the `aura/aura` repository. ## Engine Components @@ -80,9 +78,7 @@ Test cases are located in `./tests` are executed by running: ## API -You can find the AURA API definition here: https://gitlab.servus.at/autoradio/meta/blob/main/development/api-definition.md - -OpenAPI definition for Engine API: https://app.swaggerhub.com/apis/AURA-Engine/engine-api/ +You can find the AURA API definition at https://api.aura.radio ## Scheduler @@ -186,4 +182,4 @@ All Engine logs can be found under `./logs`. - [Bare Metal Installation](docs/bare-metal-installation.md) - [Developer Guide](docs/developer-guide.md) -- [Setting up the Audio Store [meta]](https://docs.aura.radio/en/latest/administration/setup-audio-store.html) +- [Setting up the Audio Store [docs.aura.radio]](https://docs.aura.radio/en/latest/administration/setup-audio-store.html) -- GitLab