WIP doc

.docs/operation-prometheus.md → .docs/concepts/pid.md

@@ -2,8 +2,6 @@
 author: Martin Weise
 ---
 
-# Prometheus
+## tbd
 
-## Usage
-
-TBD documentation of all prometheus metrics
+tbd

.docs/system-databases-data.md → .docs/concepts/relational-database.md

@@ -2,10 +2,6 @@
 author: Martin Weise
 ---
 
-# Data Database
-
-## tl;dr
-
 !!! debug "Debug Information"
 
     Image: [`bitnami/mariadb-galera:11.2.2-debian-11-r0`](https://hub.docker.com/r/bitnami/mariadb-galera)

.docs/dev-guide-app.md → .docs/contributing.md

-# Application Developer Guide
+---
+author: Martin Weise
+---
+
+## Contributing
+
+We welcome contributions to DBRepo!
 
 ## Dependencies
 
@@ -105,3 +111,10 @@ repository.
 ## Documentation
 
 For consistency reasons across the documentation, the resolution needs to be 1280x800 (16:10 ratio)
+
+## Roadmap
+
+- [x] Q1: Python library, versioning in every component, bumping frontend versions, i18n
+- [ ] Q2: Kubernetes deployment guidelines for OpenShift
+- [ ] Q3: Frontend tests, database dashboards
+- [ ] Q4: Release of 2.0.0

.docs/dev-guide-infra.md

-# Infrastructure Developer Guide
-
-## tl;dr
-
-```shell
-make cluster-start cluster-image-pull cluster-install
-```
-
-## Dependencies
-
-Local development depends on the following packages for Debian 12:
-
-```shell
-apt install -y make
-```
-
-Required tools with their own installing guides:
-
-* [Docker Engine](https://docs.docker.com/engine/install/) 24+
-* [Minikube](https://minikube.sigs.k8s.io/docs/start/) 1.32.0
-
-## Getting Started
-
-Start the local development cluster with the Docker driver (takes at least 8 vCPUs and 12GB RAM). It installs a Minikube
-single-node Kubernetes cluster with enabled Ingress and Dashboard
-
-```shell
-make cluster-start
-```
-
-Build the local images with `make build-docker` and copy them to the cluster image cache:
-
-```shell
-make cluster-image-pull
-```
-
-Build and install the Helm chart:
-
-```shell
-make cluster-install
-```
-
-## Debug
-
-Open the Minikube (Kubernetes) Dashboard:
-
-```shell
-make cluster-dashboard
-```
-
-<figure markdown>
-![Minikube Dashboard](images/screenshots/minikube-dashboard.png)
-<figcaption>Figure 1: Minikube Dashboard</figcaption>
-</figure>
-
-Optionally enable the Prometheus metrics addon with:
-
-```shell
-minikube addons enable metrics-server
-```
-
-## Test
-
-Test if the Helm chart raises errors on start (the script aborts after 5 minutes automatically if some pods are not
-starting or erroneous).
-
-```shell
-make cluster-test
-```
-
-## Uninstall
-
-To uninstall DBRepo from the local Minikube cluster, removing all data:
-
-```shell
-make cluster-uninstall
-```
-

.docs/dev-overview.md

-# Overview
-
-## Guides
-
-* The [application developer guide](../dev-guide-app) guides you through the steps on how to build DBRepo from
-  scratch and customize the application.
-* The [infrastructure developer guide](../dev-guide-infra) guides you through the steps on how to build and customize
-  the operation environment.
-
-## Organization
-
-* Monthly sprints with patch-releases (i.e. `1.4.2` in February, `1.4.3` in March, ...).
-* Branching from `dev` for feature development, one release branch per patch (i.e. `release-1.4.2` for release version
-  `1.4.2`).
-
-## Roadmap
-
-- [x] Q1: Python library, versioning in every component, bumping frontend versions, i18n
-- [ ] Q2: Kubernetes deployment guidelines for OpenShift
-- [ ] Q3: Frontend tests, database dashboards
-- [ ] Q4: Release of 2.0.0
\ No newline at end of file

.docs/help.md

+---
+author: Martin Weise
+---
+
+## Usage Documentation
+
+The [usage documentation](#) is the most complete guide on how to use DBRepo.
+
+## API Documentation
+
+The [API documentation](#) present reference docs for all APIs.

.docs/index.md

 ---
 author: Martin Weise
-hide:
-- navigation
-social:
-  cards_layout_options:
-    title: Documentation that simply works
 ---
 
-## Problem Statement
+[![CI/CD Pipeline](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/pipeline.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 }
+[![Code Coverage](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 }
+[![GitLab Release](https://img.shields.io/gitlab/v/release/fair-data-austria-db-repository%2Ffda-services?gitlab_url=https%3A%2F%2Fgitlab.phaidra.org&display_name=release&style=flat)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 }
+[![GitLab License](https://img.shields.io/gitlab/license/fair-data-austria-db-repository%2Ffda-services?gitlab_url=https%3A%2F%2Fgitlab.phaidra.org%2F&style=flat)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 }
+[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/dbrepo)](https://artifacthub.io/packages/helm/dbrepo/dbrepo){ tabindex=-1 }
 
-Digital repositories see themselves more frequently encountered with the problem of making databases accessible in their
-collection. Challenges revolve around organizing, searching and retrieving content stored within databases and
-constitute a major technical burden as their internal representation greatly differs from static documents most digital
-repositories are designed for.
-
-## Application Areas
-
-We present a database repository system that allows researchers to ingest data into a central, versioned repository
-through common interfaces, provides efficient access to arbitrary subsets of data even when the underlying data store is
-evolving, allows reproducing of query results and supports findable-, accessible-, interoperable- and reusable data.
 
 ## Features
 
@@ -44,12 +33,14 @@ edge devices like sensors and store them asynchronous in DBRepo. [Learn more.](.
 ### Cloud Native
 
 Our lightweight Helm chart allows for installations on any cloud provider or private-cloud setting that has an
-underlying PV storage provider. DBRepo can be installed from the Artifacthub repository. Databases are managed as 
-MariaDB Galera Cluster with high degree of availability ensuring your data is always accessible.
+underlying PV storage provider. DBRepo can be installed from 
+the [Artifact Hub](https://artifacthub.io/packages/helm/dbrepo/dbrepo) repository. Databases are managed as MariaDB
+Galera Cluster with high degree of availability ensuring your data is always accessible.
 [Learn more.](../deployment-helm/)
 
-## More Information
+## Demo Site
+
+We run a small demonstration instance so you can see the latest version of DBRepo in action. The demonstration instance
+is updated with new releases and should be considered ephemeral.
 
-- Demonstration instance [https://dbrepo1.ec.tuwien.ac.at](https://dbrepo1.ec.tuwien.ac.at)
-- Test instance [https://test.dbrepo.tuwien.ac.at](https://test.dbrepo.tuwien.ac.at)
+[:fontawesome-solid-flask: Demonstration Instance](https://test.dbrepo.tuwien.ac.at){ .md-button .md-button--primary }
\ No newline at end of file
-- System description [https://doi.org/10.2218/ijdc.v17i1.825](https://doi.org/10.2218/ijdc.v17i1.825)

.docs/operation-actuator.md → .docs/migration.md

@@ -2,8 +2,5 @@
 author: Martin Weise
 ---
 
-# Actuators
+## Migration Guide
 
-## Usage
-
-TBD documentation of all Healthiness endpoints
\ No newline at end of file