diff --git a/docs/getting-started.md b/docs/getting-started.md index dc47c004a5b6b585785c5d10d9ff2b050df83042..8cc716e676ee692283c565f940eac0a347d40c62 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -93,10 +93,9 @@ We develop all packages with the following software requirements: For local development you need to clone the repository and build the services from scratch: -```console -git clone git@gitlab.phaidra.org:fair-data-austria-db-repository/fda-services.git -make build -``` + git clone git@gitlab.phaidra.org:fair-data-austria-db-repository/fda-services.git + make build + #### Swagger Codegen @@ -104,15 +103,11 @@ It is possible to use the Swagger documentation of the services to generate HTTP Clients can only begenerated when DBRepo is running. Just download the [`swagger-codegen-cli.jar`](https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/) and start the services: -```console -docker-compose up -d -``` + docker-compose up -d Run the codegen tool: -```console -java -jar ./swagger-codegen-cli-2.x.y.jar generate -i ./api-docs.yaml -l python -o ./api-container -``` + java -jar ./swagger-codegen-cli-2.x.y.jar generate -i ./api-docs.yaml -l python -o ./api-container ### Debugging @@ -120,12 +115,10 @@ java -jar ./swagger-codegen-cli-2.x.y.jar generate -i ./api-docs.yaml -l python Start all containers with docker-compose: -```console -docker-compose up -d -docker container stop fda-xxxxx-service # <<< replace with the service you want to debug -docker container rm fda-xxxxx-service # <<< replace with the service you want to debug -docker-compose logs -f -``` + docker-compose up -d + docker container stop fda-xxxxx-service # <<< replace with the service you want to debug + docker container rm fda-xxxxx-service # <<< replace with the service you want to debug + docker-compose logs -f Then start the container in your IDE and debug it. @@ -133,14 +126,10 @@ Then start the container in your IDE and debug it. Start all containers with docker-compose: -```console -docker-compose up -d -docker container stop fda-ui && docker container rm fda-ui -docker-compose logs -f -``` + docker-compose up -d + docker container stop fda-ui && docker container rm fda-ui + docker-compose logs -f Then start the frontend in another console window: -```console -yarn --cwd=./fda-ui dev -``` + yarn --cwd=./fda-ui dev diff --git a/docs/grafana.html b/docs/grafana.html deleted file mode 100644 index 08b03b16776f01e0e750758d7dc305325b54fbd4..0000000000000000000000000000000000000000 --- a/docs/grafana.html +++ /dev/null @@ -1,10 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> - <meta charset="UTF-8"> - <meta http-equiv="refresh" content="0; URL=http://s125.dl.hpc.tuwien.ac.at:8080/grafana/d/R4B-UWZVz/dbrepo-airquality-austria?orgId=1" /> - <title>Redirecting to Grafana...</title> -</head> -<body> -</body> -</html> \ No newline at end of file