diff --git a/Makefile b/Makefile index db5e4bd81b3c414639871f8e91009c8b00aa6656..990b5e4ac475622c9c9309402dea3603d9ee3104 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,6 @@ .PHONY: clean docs TAG ?= latest -BASE_URL ?= "" all: build @@ -16,7 +15,6 @@ verify: sudo nginx -t build: build-swagger - grep -rl __BASE_URL__ ./docs | xargs sed -i 's|__BASE_URL__|${BASE_URL}|g' mkdocs build build-swagger: diff --git a/docs/deployment-kubernetes-azure.md b/docs/deployment-kubernetes-azure.md index f389130e9b50ae7879ac5222108d2480a0628594..4aeeb01040c6a22e389467ece64c92d13c6b0869 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](__BASE_URL__/system-services-upload/) to deposit files and mount the BLOB storage +[Upload Service](/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 6b523dba78e436485270c6dd130667482a02e684..5b8785584e757f91e22ecacb985fe34c0fa7a214 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](__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* +Since the Upload Service uses a shared filesystem with the [Analyst Service](/system-services-analyse/), +[Metadata Service](/system-services-metadata/) and +[Data Database](/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 b27b0a234c2907b1c0f5b78dfd65f32816830b14..eb2d6e0110e0c7dcd08cdb9d6f0a95eb0b85a368 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](__BASE_URL__/deployment-docker-compose/){ .action-button .md-button .md-button--primary } -[Learn More](__BASE_URL__/system){ .action-button .md-button .md-button--secondary } +[Get Started](/deployment-docker-compose/){ .action-button .md-button .md-button--primary } +[Learn More](/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 9f4e64c03dc327f90596200f7954141d5506bd09..a88a0895e0600c295deef940a5fc68ec53fe97d9 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="__BASE_URL__/swagger/analyse" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:5000/swagger-ui/index.html` <a href="/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 259c8a8e3cd4992cd2207c7664d37d4ff5d55bd9..04ec39c3e05d60f999d1606a3f937acf75bd619f 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](__BASE_URL__/usage-broker) page. +the [usage](/usage-broker) page. ## Limitations diff --git a/docs/system-services-data.md b/docs/system-services-data.md index 2e929a873d44a09aede781de4d7b2fc28c9c5635..ca100f35bb6768f7f45979db9d50dea4f38a991b 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="__BASE_URL__/swagger/data" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:9093/swagger-ui/index.html` <a href="/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 a33c9a6eb522fe26b08b584fec093c9ba0bc0e7d..46cca55796399bab8d09041b794a1d303005224f 100644 --- a/docs/system-services-metadata.md +++ b/docs/system-services-metadata.md @@ -14,7 +14,7 @@ author: Martin Weise * 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="__BASE_URL__/swagger/metadata" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:9099/swagger-ui/index.html` <a href="/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 cbd66d2b178d31c0485a87558faa982499bc2a77..0b6253cf1494b762298862d4792c6d2f792dc097 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="__BASE_URL__/swagger/mirror" target="_blank">:fontawesome-solid-square-up-right: view online</a> + * Swagger UI: `http://:9050/swagger-ui/index.html` <a href="/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 375be1eb7ea0d389c2361381bca3fd8efb9dcac8..dcea8026df2384431d4fa46bc0766528f3681448 100644 --- a/docs/system-services-upload.md +++ b/docs/system-services-upload.md @@ -11,7 +11,7 @@ author: Martin Weise * Ports: 1080/tcp * 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> + * Swagger UI: <a href="/swagger/upload" target="_blank">:fontawesome-solid-square-up-right: view online</a> ## Overview diff --git a/mkdocs.yml b/mkdocs.yml index 02a66902488c898fe090dd739ce814fba800cf78..3273010e00d29edce8b0f9ca41973fd75c5d0832 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,7 @@ site_name: Database Repository repo_url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services repo_name: fda-services +site_url: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/latest/ site_author: Research Unit Data Science, Technische Universität Wien copyright: CC-BY 4.0 Technische Universität Wien & Universität Wien nav: