diff --git a/docs/developer/setup/docker.md b/docs/developer/setup/docker.md index b9b7f2a79..dad5542a5 100644 --- a/docs/developer/setup/docker.md +++ b/docs/developer/setup/docker.md @@ -281,6 +281,21 @@ The generated tracks do not contain any audio and are here for testing purposes Read about [seeding additional instances](#seeding-additional-instances) below. +## 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: @@ -472,27 +487,6 @@ 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 [https://docs.funkwhale.test](https://docs.funkwhale.test). The OpenAPI schema is available at [https://openapi.funkwhale.test](https://openapi.funkwhale.test). The UI component library is available at [https://ui.funkwhale.test](https://ui.funkwhale.test). - -Fallback ports are available for the documentation at -[http://localhost:8001/](http://localhost:8001/), for the OpenAPI schema at -[http://localhost:8002/](http://localhost:8002/) and for the UI component library at [http://localhost:8003/](http://localhost:8003/). - -Maintain their life cycle with similar commands to those used to -[set up network services (point 2.)](#set-up-network-services). - -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 . - ## Running the test suites Run the App test suite: