From 93f67e248cefff19a046633b7b634de31901b26d Mon Sep 17 00:00:00 2001 From: Martin Weise <martin.weise@tuwien.ac.at> Date: Thu, 12 Oct 2023 13:33:58 +0200 Subject: [PATCH] Update base URL --- Makefile | 9 +++++---- docs/deployment-kubernetes-azure.md | 2 +- docs/deployment-kubernetes-minikube.md | 6 +++--- docs/index.md | 4 ++-- docs/system-services-analyse.md | 2 +- docs/system-services-broker.md | 2 +- docs/system-services-data.md | 2 +- docs/system-services-metadata.md | 4 +++- docs/system-services-mirror.md | 2 +- docs/system-services-upload.md | 3 ++- 10 files changed, 20 insertions(+), 16 deletions(-) diff --git a/Makefile b/Makefile index c528b12..c6ff5b7 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,9 @@ .PHONY: clean docs TAG ?= latest +BASE_URL ?= / -all: build-docs +all: build clean: rm -rf ./site @@ -14,12 +15,12 @@ deploy-dockerhub-docs: verify: sudo nginx -t -build: +build: build-swagger + grep -rl __BASE_URL__ . | xargs sed -i 's|__BASE_URL__|${BASE_URL}|g' mkdocs build - cd ./swagger && bash ./generate.sh build-swagger: - cd ./swagger && UPDATE=1 ./generate.sh + cd ./swagger && bash ./generate.sh deploy-docs: tar czfv ./final.tar.gz ./final diff --git a/docs/deployment-kubernetes-azure.md b/docs/deployment-kubernetes-azure.md index e1039dc..f389130 100644 --- a/docs/deployment-kubernetes-azure.md +++ b/docs/deployment-kubernetes-azure.md @@ -49,6 +49,6 @@ in your Kubernetes Cluster). We recommend to create a [Container](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#containers) for the -[Upload Service](/infrastructures/dbrepo/latest/system-services-upload/) to deposit files and mount the BLOB storage +[Upload Service](__BASE_URL__/system-services-upload/) to deposit files and mount the BLOB storage via CSI drivers into the *Deployment*. It greatly increases the available interfaces (see below) for file uploads and provides a highly-available filesystem for the many deployments that need to use the files. diff --git a/docs/deployment-kubernetes-minikube.md b/docs/deployment-kubernetes-minikube.md index bd64c05..6b523db 100644 --- a/docs/deployment-kubernetes-minikube.md +++ b/docs/deployment-kubernetes-minikube.md @@ -83,9 +83,9 @@ in the cluster. In our test deployment we obtained a certificate from Let's Encr ### Fileshare -Since the Upload Service uses a shared filesystem with the [Analyst Service](/infrastructures/dbrepo/latest/system-services-analyse/), -[Metadata Service](/infrastructures/dbrepo/latest/system-services-metadata/) and -[Data Database](/infrastructures/dbrepo/latest/system-databases-data/), the dynamic provision of the *PersistentVolume* +Since the Upload Service uses a shared filesystem with the [Analyst Service](__BASE_URL__/system-services-analyse/), +[Metadata Service](__BASE_URL__/system-services-metadata/) and +[Data Database](__BASE_URL__/system-databases-data/), the dynamic provision of the *PersistentVolume* by the *PersistentVolumeClaim* of [`pvc.yaml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-deployment/-/blob/master/charts/dbrepo-core/templates/upload-service/pvc.yaml) needs to happen statically. You can make use of the host's filesystem and mount it in each of those deployments. diff --git a/docs/index.md b/docs/index.md index 45c2309..b27b0a2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,8 +14,8 @@ collection. Challenges revolve around organizing, searching and retrieving conte constitute a major technical burden as their internal representation greatly differs from static documents most digital repositories are designed for. -[Get Started](/infrastructures/dbrepo/latest/deployment-docker-compose/){ .action-button .md-button .md-button--primary } -[Learn More](/infrastructures/dbrepo/latest/system){ .action-button .md-button .md-button--secondary } +[Get Started](__BASE_URL__/deployment-docker-compose/){ .action-button .md-button .md-button--primary } +[Learn More](__BASE_URL__/system){ .action-button .md-button .md-button--secondary } ## Application Areas diff --git a/docs/system-services-analyse.md b/docs/system-services-analyse.md index dc25876..9f4e64c 100644 --- a/docs/system-services-analyse.md +++ b/docs/system-services-analyse.md @@ -8,7 +8,7 @@ author: Martin Weise * Ports: 5000/tcp * Prometheus: `http://:5000/metrics` - * Swagger UI: `http://:5000/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/analyse" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:5000/swagger-ui/index.html` <a href="__BASE_URL__/swagger/analyse" target="_blank">:fontawesome-solid-square-up-right: view online</a> It suggests data types for the FAIR Portal when creating a table from a *comma separated values* (CSV) file. It recommends enumerations for columns and returns e.g. a list of potential primary key candidates. The researcher is able diff --git a/docs/system-services-broker.md b/docs/system-services-broker.md index d166a8b..259c8a8 100644 --- a/docs/system-services-broker.md +++ b/docs/system-services-broker.md @@ -30,7 +30,7 @@ The Broker Service allows two ways of authentication: 2. OAuth2 For detailed examples how to authenticate with the Broker Service see -the [usage](/infrastructures/dbrepo/latest/usage-broker) page. +the [usage](__BASE_URL__/usage-broker) page. ## Limitations diff --git a/docs/system-services-data.md b/docs/system-services-data.md index ae39218..2e929a8 100644 --- a/docs/system-services-data.md +++ b/docs/system-services-data.md @@ -12,7 +12,7 @@ author: Martin Weise * Info: `http://:9093/actuator/info` * Health: `http://:9093/actuator/health` * Prometheus: `http://:9093/actuator/prometheus` - * Swagger UI: `http://:9093/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/data" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:9093/swagger-ui/index.html` <a href="__BASE_URL__/swagger/data" target="_blank">:fontawesome-solid-square-up-right: view online</a> ## Overview diff --git a/docs/system-services-metadata.md b/docs/system-services-metadata.md index c4a753c..a33c9a6 100644 --- a/docs/system-services-metadata.md +++ b/docs/system-services-metadata.md @@ -11,8 +11,10 @@ author: Martin Weise * Ports: 9099/tcp * Info: `http://:9099/actuator/info` * Health: `http://:9099/actuator/health` + * Readiness: `http://:9099/actuator/health/readiness` + * Liveness: `http://:9099/actuator/health/liveness` * Prometheus: `http://:9099/actuator/prometheus` - * Swagger UI: `http://:9099/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/metadata" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:9099/swagger-ui/index.html` <a href="__BASE_URL__/swagger/metadata" target="_blank">:fontawesome-solid-square-up-right: view online</a> ## Overview diff --git a/docs/system-services-mirror.md b/docs/system-services-mirror.md index 962e387..cbd66d2 100644 --- a/docs/system-services-mirror.md +++ b/docs/system-services-mirror.md @@ -12,7 +12,7 @@ author: Martin Weise * Info: `http://:9050/actuator/info` * Health: `http://:9050/actuator/health` * Prometheus: `http://:9050/actuator/prometheus` - * Swagger UI: `http://:9050/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/mirror" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:9050/swagger-ui/index.html` <a href="__BASE_URL__/swagger/mirror" target="_blank">:fontawesome-solid-square-up-right: view online</a> ## Overview diff --git a/docs/system-services-upload.md b/docs/system-services-upload.md index dbae245..375be1e 100644 --- a/docs/system-services-upload.md +++ b/docs/system-services-upload.md @@ -9,8 +9,9 @@ author: Martin Weise !!! debug "Debug Information" * Ports: 1080/tcp - * TUSd: `http://:1080/api/upload/files` + * TUS: `http://:1080/api/upload/files` * Prometheus: `http://:1080/metrics` + * Swagger UI: <a href="__BASE_URL__/swagger/upload" target="_blank">:fontawesome-solid-square-up-right: view online</a> ## Overview -- GitLab