From 57c8382ac9ccc617252e42115c0c02cbc25ed78f Mon Sep 17 00:00:00 2001 From: Martin Weise <martin.weise@tuwien.ac.at> Date: Mon, 20 May 2024 18:18:04 +0200 Subject: [PATCH] Added more docs --- .docs/api/python.md | 3 +-- .docs/deployment-helm.md | 2 ++ .docs/index.md | 38 +++++++++++--------------------------- .docs/why.md | 34 ++++++++++++++++++++++++++++++++++ 4 files changed, 48 insertions(+), 29 deletions(-) diff --git a/.docs/api/python.md b/.docs/api/python.md index bc7469d680..7289639bfa 100644 --- a/.docs/api/python.md +++ b/.docs/api/python.md @@ -2,12 +2,11 @@ author: Martin Weise --- -# Python Library +[](https://pypi.org/project/dbrepo/){ tabindex=-1 } ## tl;dr [:fontawesome-solid-cube: View Docs](../sphinx){ .md-button .md-button--primary } -[:fontawesome-brands-python: PyPI](https://pypi.org/project/dbrepo/){ .md-button .md-button--secondary } ## Installing diff --git a/.docs/deployment-helm.md b/.docs/deployment-helm.md index 59835476e7..745ad87b94 100644 --- a/.docs/deployment-helm.md +++ b/.docs/deployment-helm.md @@ -2,6 +2,8 @@ author: Martin Weise --- +[](https://artifacthub.io/packages/helm/dbrepo/dbrepo){ tabindex=-1 } + ## TL;DR To install DBRepo in your existing cluster, download the diff --git a/.docs/index.md b/.docs/index.md index 1776ffb830..8b7f397570 100644 --- a/.docs/index.md +++ b/.docs/index.md @@ -7,39 +7,23 @@ author: Martin Weise [](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 } [](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 } +Documentation for version: [v1.4.3](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/releases). -## Features +DBRepo is a repository for data in databases that are used from the beginning of a research project supporting data +evolution, -citation and -versioning. It implements the +[RDA WGDC recommendations](https://doi.org/10.1162/99608f92.be565013) on precisely identifying arbitrary subsets of +data. -### Built-in search +## Why use DBRepo? -DBRepo makes your dataset searchable without extra effort: most metadata is generated automatically for data in your -databases. The fast and powerful OpenSearch database allows a fast retrieval of any information. Adding semantic mapping -through a suggestion-feature, allows machines to properly understand the context of your data. [Learn more.](../system-services-search/) +* **aaa** bbbb -### Citable datasets +Installing DBRepo is very easy or just [give it a try online](https://test.dbrepo.tuwien.ac.at). -Adopting the recommendations of the RDA-WGDC, arbitrary subsets can be precisely, persistently identified using -system-versioned tables of MariaDB and the DataCite schema for minting DOIs. External systems i.e. metadata harvesters -(OpenAIRE, Google Datasets) can access these datasets through OAI-PMH, JSON-LD and FAIR Signposting protocols. -[Learn more.](../system-services-metadata/) +## Who is using DBRepo? -### Powerful API for Data Scientists +TBD -With our strongly typed Python Library, Data Scientists can import, export and work with data from Jupyter Notebook or -Python script, optionally using Pandas DataFrames. For example: the AMQP API Client can collect continuous data from -edge devices like sensors and store them asynchronous in DBRepo. [Learn more.](../usage-python/) - -### 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 [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/) - -## 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. +## How can I try DBRepo [:fontawesome-solid-flask: Demonstration Instance](https://test.dbrepo.tuwien.ac.at){ .md-button .md-button--primary } \ No newline at end of file diff --git a/.docs/why.md b/.docs/why.md index 71175d013b..1e6e52cc7f 100644 --- a/.docs/why.md +++ b/.docs/why.md @@ -14,3 +14,37 @@ repositories are designed for. 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 + +### Built-in search + +DBRepo makes your dataset searchable without extra effort: most metadata is generated automatically for data in your +databases. The fast and powerful OpenSearch database allows a fast retrieval of any information. Adding semantic mapping +through a suggestion-feature, allows machines to properly understand the context of your data. [Learn more.](../system-services-search/) + +### Citable datasets + +Adopting the recommendations of the RDA-WGDC, arbitrary subsets can be precisely, persistently identified using +system-versioned tables of MariaDB and the DataCite schema for minting DOIs. External systems i.e. metadata harvesters +(OpenAIRE, Google Datasets) can access these datasets through OAI-PMH, JSON-LD and FAIR Signposting protocols. +[Learn more.](../system-services-metadata/) + +### Powerful API for Data Scientists + +With our strongly typed Python Library, Data Scientists can import, export and work with data from Jupyter Notebook or +Python script, optionally using Pandas DataFrames. For example: the AMQP API Client can collect continuous data from +edge devices like sensors and store them asynchronous in DBRepo. [Learn more.](../usage-python/) + +### 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 [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/) + +## 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. \ No newline at end of file -- GitLab