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

Shorten doc versions

parent f8c6488a
No related branches found
No related tags found
3 merge requests!345Updated docs and endpoints:,!341Fixed mapping problem where UK and FK share columns they are inserted,!339Fixed mapping problem where UK and FK share columns they are inserted
...@@ -2,9 +2,9 @@ ...@@ -2,9 +2,9 @@
author: Martin Weise author: Martin Weise
--- ---
## v1.4.7 (2024-11-06) ## v1.5.0 (2024-11-06)
[:simple-gitlab: GitLab Release](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags/v1.4.7) [:simple-gitlab: GitLab Release](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags/v1.5.0)
!!! warning "Contains Breaking Changes" !!! warning "Contains Breaking Changes"
......
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
author: Martin Weise author: Martin Weise
--- ---
# DBRepo
[![CI/CD Status](./images/pipeline.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 } [![CI/CD Status](./images/pipeline.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 }
[![CI/CD Coverage](./images/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 } [![CI/CD Coverage](./images/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 }
[![Latest 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 } [![Latest 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 }
...@@ -10,7 +12,7 @@ author: Martin Weise ...@@ -10,7 +12,7 @@ author: Martin Weise
[![Helm Chart version](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/dbrepo)](https://artifacthub.io/packages/helm/dbrepo/dbrepo){ tabindex=-1 } [![Helm Chart version](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/dbrepo)](https://artifacthub.io/packages/helm/dbrepo/dbrepo){ 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&cacheSeconds=3600)](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&cacheSeconds=3600)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services){ tabindex=-1 }
Documentation for version: [v1.5](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/releases). Documentation for version: [v1.5.0](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/releases).
DBRepo is a repository for data in databases that are used from the beginning until the end of a research DBRepo is a repository for data in databases that are used from the beginning until the end of a research
project supporting data evolution, -citation and -versioning. It implements the query store of the project supporting data evolution, -citation and -versioning. It implements the query store of the
......
...@@ -13,7 +13,7 @@ helm upgrade --install dbrepo \ ...@@ -13,7 +13,7 @@ helm upgrade --install dbrepo \
-n dbrepo \ -n dbrepo \
"oci://registry.datalab.tuwien.ac.at/dbrepo/helm/dbrepo" \ "oci://registry.datalab.tuwien.ac.at/dbrepo/helm/dbrepo" \
--values ./values.yaml \ --values ./values.yaml \
--version "1.5" \ --version "1.5.0" \
--create-namespace \ --create-namespace \
--cleanup-on-fail --cleanup-on-fail
``` ```
......
No preview for this file type
:root, :root,
[data-md-color-accent=indigo] { [data-md-color-accent=indigo] {
--md-hue: 230;
--md-default-bg-color: hsla(230, 15%, 21%, 1);
--md-primary-fg-color: #006699; --md-primary-fg-color: #006699;
--md-accent-fg-color: #005c8a; --md-accent-fg-color: #005c8a;
/* darken 10% */ /* darken 10% */
...@@ -28,5 +30,3 @@ img.img-border { ...@@ -28,5 +30,3 @@ img.img-border {
.md-banner { .md-banner {
background-color: var(--md-primary-fg-color--dark); } background-color: var(--md-primary-fg-color--dark); }
/*# sourceMappingURL=extra.css.map */
:root, :root,
[data-md-color-accent=indigo] { [data-md-color-accent=indigo] {
--md-hue: 230;
--md-default-bg-color: hsla(230, 15%, 21%, 1);
--md-primary-fg-color: #006699; --md-primary-fg-color: #006699;
--md-accent-fg-color: #005c8a; /* darken 10% */ --md-accent-fg-color: #005c8a; /* darken 10% */
--md-primary-fg-color--dark: #00537c; /* darken 10% */ --md-primary-fg-color--dark: #00537c; /* darken 10% */
......
...@@ -3,6 +3,7 @@ variables: ...@@ -3,6 +3,7 @@ variables:
DOCKER_HOST: "unix:///var/run/dind/docker.sock" DOCKER_HOST: "unix:///var/run/dind/docker.sock"
TESTCONTAINERS_RYUK_DISABLED: "false" TESTCONTAINERS_RYUK_DISABLED: "false"
PYTHON_VERSION: "3.11" PYTHON_VERSION: "3.11"
DOC_VERSION: "1.5"
APP_VERSION: "1.5.0" APP_VERSION: "1.5.0"
CHART_VERSION: "1.5.0" CHART_VERSION: "1.5.0"
CACHE_FALLBACK_KEY: ${CI_DEFAULT_BRANCH} CACHE_FALLBACK_KEY: ${CI_DEFAULT_BRANCH}
...@@ -416,15 +417,15 @@ release-docs: ...@@ -416,15 +417,15 @@ release-docs:
- "apk add --update alpine-sdk bash sed wget openssh jq curl" - "apk add --update alpine-sdk bash sed wget openssh jq curl"
- "pip install pipenv" - "pip install pipenv"
- "pip install -r ./requirements.txt" - "pip install -r ./requirements.txt"
- "mkdir -p ./final/${APP_VERSION}/rest" - "mkdir -p ./final/${DOC_VERSION}/rest"
script: script:
- "make gen-lib-doc gen-docs-doc package-config" - "make gen-lib-doc gen-docs-doc package-config"
- "cp -r ./lib/python/docs/build/html ./final/${APP_VERSION}/python" # sphinx - "cp -r ./lib/python/docs/build/html ./final/${DOC_VERSION}/python" # sphinx
- "cp .docs/.swagger/api.yaml ./final/${APP_VERSION}/rest/api.yaml" # swagger - "cp .docs/.swagger/api.yaml ./final/${DOC_VERSION}/rest/api.yaml" # swagger
- "cp .docs/.swagger/swagger-ui.html ./final/${APP_VERSION}/rest/index.html" # swagger - "cp .docs/.swagger/swagger-ui.html ./final/${DOC_VERSION}/rest/index.html" # swagger
- "cp .docs/.swagger/custom.css ./final/${APP_VERSION}/rest/custom.css" # swagger - "cp .docs/.swagger/custom.css ./final/${DOC_VERSION}/rest/custom.css" # swagger
- "cp -r ./site/* ./final/${APP_VERSION}" # mkdocs - "cp -r ./site/* ./final/${DOC_VERSION}" # mkdocs
- "cp .docker/dist.tar.gz ./final/${APP_VERSION}/dist.tar.gz" # dist - "cp .docker/dist.tar.gz ./final/${DOC_VERSION}/dist.tar.gz" # dist
- "bash ./.gitlab/gen-badge.sh" - "bash ./.gitlab/gen-badge.sh"
- eval $(ssh-agent -s) - eval $(ssh-agent -s)
- "mkdir -p /root/.ssh" - "mkdir -p /root/.ssh"
...@@ -435,7 +436,7 @@ release-docs: ...@@ -435,7 +436,7 @@ release-docs:
- "scp -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa final.tar.gz $CI_DOC_USER@$CI_DOC_IP:final.tar.gz" - "scp -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa final.tar.gz $CI_DOC_USER@$CI_DOC_IP:final.tar.gz"
- "scp -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa versions.json $CI_DOC_USER@$CI_DOC_IP:/system/user/ifs/infrastructures/public_html/dbrepo/versions.json" - "scp -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa versions.json $CI_DOC_USER@$CI_DOC_IP:/system/user/ifs/infrastructures/public_html/dbrepo/versions.json"
- "scp -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa .docs/redirect.html $CI_DOC_USER@$CI_DOC_IP:/system/user/ifs/infrastructures/public_html/dbrepo/index.html" - "scp -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa .docs/redirect.html $CI_DOC_USER@$CI_DOC_IP:/system/user/ifs/infrastructures/public_html/dbrepo/index.html"
- 'ssh -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa $CI_DOC_USER@$CI_DOC_IP "rm -rf /system/user/ifs/infrastructures/public_html/dbrepo/${APP_VERSION}; tar xzf ./final.tar.gz; rm -f ./final.tar.gz; cp -r ./final/* /system/user/ifs/infrastructures/public_html/dbrepo/${APP_VERSION}; rm -rf ./final"' - 'ssh -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa $CI_DOC_USER@$CI_DOC_IP "rm -rf /system/user/ifs/infrastructures/public_html/dbrepo/${DOC_VERSION}; tar xzf ./final.tar.gz; rm -f ./final.tar.gz; cp -r ./final/* /system/user/ifs/infrastructures/public_html/dbrepo/${DOC_VERSION}; rm -rf ./final"'
release-libs: release-libs:
stage: release stage: release
......
site_name: Database Repository site_name: Database Repository
site_url: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/1.5.0/ site_url: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/1.5/
repo_url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services repo_url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services
repo_name: fda-services repo_name: fda-services
site_author: Research Unit Data Science, Technische Universität Wien site_author: Research Unit Data Science, Technische Universität Wien
...@@ -121,7 +121,7 @@ markdown_extensions: ...@@ -121,7 +121,7 @@ markdown_extensions:
extra: extra:
homepage: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/ homepage: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/
version: version:
default: 1.5.0 default: 1.5
provider: mike provider: mike
social: social:
- icon: simple/artifacthub - icon: simple/artifacthub
......
[ [
{ {
"version": "1.5.0", "version": "1.5",
"title": "1.5.0", "title": "1.5",
"aliases": [] "aliases": []
}, },
{ {
"version": "1.4.6", "version": "1.4",
"title": "1.4.6", "title": "1.4",
"aliases": []
},
{
"version": "1.4.5",
"title": "1.4.5",
"aliases": []
},
{
"version": "1.4.4",
"title": "1.4.4",
"aliases": []
},
{
"version": "1.4.3",
"title": "1.4.3",
"aliases": []
},
{
"version": "1.4.2",
"title": "1.4.2",
"aliases": []
},
{
"version": "1.4.1",
"title": "1.4.1",
"aliases": []
},
{
"version": "1.4.0",
"title": "1.4.0",
"aliases": [] "aliases": []
} }
] ]
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment