Skip to content
Snippets Groups Projects
Verified Commit 031ba8d7 authored by Martin Weise's avatar Martin Weise
Browse files

Using mkdocs base_url

parent c5f4fdd2
No related branches found
No related tags found
No related merge requests found
.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:
......
......@@ -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.
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
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&auml;t Wien
copyright: CC-BY 4.0 Technische Universit&auml;t Wien & Universit&auml;t Wien
nav:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment