From 987980db1fca56e43d5a9d8d0335564d801b8fb7 Mon Sep 17 00:00:00 2001 From: jon r Date: Fri, 4 Apr 2025 14:14:53 +0200 Subject: [PATCH] docs(developer/setup/docker): move documentation section up to the other set up instructions [skip ci] --- docs/developer/setup/docker.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/developer/setup/docker.md b/docs/developer/setup/docker.md index eba9b3123..797e7264d 100644 --- a/docs/developer/setup/docker.md +++ b/docs/developer/setup/docker.md @@ -277,6 +277,21 @@ docker compose run --rm -T api \ The generated tracks do not contain any audio and are here for testing purposes of metadata handling only. +## Set up local documentation + +To build the documentation locally run: + +```sh +docker compose -f compose.docs.yml up -d +``` + +The documentation is then accessible at . The OpenAPI schema is available at . The UI component library will be served at . + +Fallback ports are available for the documentation at , for the OpenAPI schema at and for the UI component library at . + +Maintain their life cycle with similar commands to those used to +[set up network services (point 2.)](#set-up-network-services). + ## Lifecycle Recycle individual containers: @@ -467,18 +482,3 @@ This step does not apply to the default instance when running `docker compose` w In this case follow the manual steps from above. First create a super user as described in [set up application services](#set-up-application-services) and then continue with the [set up of local data for development](#set-up-local-data-for-development). ``` - -## Local documentation - -To build the documentation locally run: - -```sh -docker compose -f compose.docs.yml up -d -``` - -The documentation is then accessible at . The OpenAPI schema is available at . The UI component library will be served at . - -Fallback ports are available for the documentation at , for the OpenAPI schema at and for the UI component library at . - -Maintain their life cycle with similar commands to those used to -[set up network services (point 2.)](#set-up-network-services).