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

Added docs

parent 1f0c658c
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
.docs/overrides/home.html
+ 24
− 11
View file @ 7f576567
...@@ -82,7 +82,7 @@ ...@@ -82,7 +82,7 @@
<div class="md-grid md-typeset"> <div class="md-grid md-typeset">
<div class="mdx-spotlight"> <div class="mdx-spotlight">
<figure class="mdx-spotlight__feature"> <figure class="mdx-spotlight__feature">
<a href="setup/setting-up-site-search/" tabindex="-1" title="Built-in search"> <a href="../system-services-search/" tabindex="-1" title="Built-in search">
<img src="images/screenshots/feature-search.png" <img src="images/screenshots/feature-search.png"
alt="Built-in search" loading="lazy" alt="Built-in search" loading="lazy"
width="500" width="500"
...@@ -96,12 +96,12 @@ ...@@ -96,12 +96,12 @@
<p>Adding <strong>semantic mapping</strong> through a suggestion-feature, allows machines to <p>Adding <strong>semantic mapping</strong> through a suggestion-feature, allows machines to
properly understand the context of your data.</p> properly understand the context of your data.</p>
<p> <p>
<a href="setup/setting-up-site-search/" aria-label="Built-in search">Learn more</a> <a href="../system-services-search/" aria-label="Built-in search">Learn more</a>
</p> </p>
</figcaption> </figcaption>
</figure> </figure>
<figure class="mdx-spotlight__feature"> <figure class="mdx-spotlight__feature">
<a href="setup/setting-up-site-search/" tabindex="-1" title="Built-in search"> <a href="../system-services-metadata/" tabindex="-1" title="Built-in search">
<img src="images/screenshots/feature-identifiers.png" <img src="images/screenshots/feature-identifiers.png"
alt="Built-in search" loading="lazy" alt="Built-in search" loading="lazy"
width="500" width="500"
...@@ -109,14 +109,18 @@ ...@@ -109,14 +109,18 @@
</a> </a>
<figcaption class="md-typeset"> <figcaption class="md-typeset">
<h2>Citable datasets</h2> <h2>Citable datasets</h2>
<p>OAI-PMH, Google Datasets, FAIR Signposting</p> <p>Adopting the recommendations of the <strong>RDA-WGDC</strong>, arbitrary subsets can be
precisely, <strong>persistently identified</strong> using system-versioned tables of MariaDB and
the <strong>DOI</strong> schema.</p>
<p>External systems i.e. <strong>metadata harvesters</strong> (OpenAIRE, Google Datasets) can access
these datasets through OAI-PMH, JSON-LD and <strong>FAIR Signposting</strong> protocols.</p>
<p> <p>
<a href="setup/setting-up-site-search/" aria-label="Built-in search">Learn more</a> <a href="../system-services-metadata/" aria-label="Built-in search">Learn more</a>
</p> </p>
</figcaption> </figcaption>
</figure> </figure>
<figure class="mdx-spotlight__feature"> <figure class="mdx-spotlight__feature">
<a href="setup/setting-up-site-search/" tabindex="-1" title="Built-in search"> <a href="../usage-python/" tabindex="-1" title="Built-in search">
<img src="images/screenshots/feature-jupyter.png" <img src="images/screenshots/feature-jupyter.png"
alt="Built-in search" loading="lazy" alt="Built-in search" loading="lazy"
width="500" width="500"
...@@ -124,14 +128,19 @@ ...@@ -124,14 +128,19 @@
</a> </a>
<figcaption class="md-typeset"> <figcaption class="md-typeset">
<h2>Powerful API for Data Scientists</h2> <h2>Powerful API for Data Scientists</h2>
<p>Python Library, Pandas, Juypter Notebook, etc.</p> <p>With our <strong>strongly typed</strong> Python Library, Data Scientists can import, export and
<strong>work with data</strong> from Jupyter Notebook or Python script, optionally using
<strong>Pandas DataFrames</strong>.
</p>
<p>For example: the <strong>AMQP API Client</strong> can collect continuous data from edge devices
like sensors and store them <strong>asynchronous</strong> in DBRepo.</p>
<p> <p>
<a href="setup/setting-up-site-search/" aria-label="Built-in search">Learn more</a> <a href="../usage-python/" aria-label="Built-in search">Learn more</a>
</p> </p>
</figcaption> </figcaption>
</figure> </figure>
<figure class="mdx-spotlight__feature"> <figure class="mdx-spotlight__feature">
<a href="setup/setting-up-site-search/" tabindex="-1" title="Built-in search"> <a href="../deployment-helm/" tabindex="-1" title="Built-in search">
<img src="images/screenshots/feature-cloud.png" <img src="images/screenshots/feature-cloud.png"
alt="Built-in search" loading="lazy" alt="Built-in search" loading="lazy"
width="500" width="500"
...@@ -139,9 +148,13 @@ ...@@ -139,9 +148,13 @@
</a> </a>
<figcaption class="md-typeset"> <figcaption class="md-typeset">
<h2>Cloud Native</h2> <h2>Cloud Native</h2>
<p>Easy deployment</p> <p>Our <strong>lightweight</strong> Helm chart allows for installations on <strong>any cloud
provider</strong> that has an underlying PV storage provider. DBRepo can be installed from the
Artifacthub repository.</p>
<p>Databases are managed as <strong>MariaDB Galera</strong> Cluster with high degree of replication,
ensuring your data is always <strong>accessible</strong>.</p>
<p> <p>
<a href="setup/setting-up-site-search/" aria-label="Built-in search">Learn more</a> <a href="../deployment-helm/" aria-label="Built-in search">Learn more</a>
</p> </p>
</figcaption> </figcaption>
</figure> </figure>
......
.docs/stylesheets/.sass-cache/04e8358553d0156a67b95297c054a24cd7eab863/_colors.scssc
+ 0
− 0
View file @ 7f576567
No preview for this file type
.docs/stylesheets/custom.css
+ 13
− 7
View file @ 7f576567
...@@ -7,11 +7,17 @@ ...@@ -7,11 +7,17 @@
img.img-border { img.img-border {
border: 1px solid #b3b3b3; } border: 1px solid #b3b3b3; }
.md-typeset .md-button.md-button--secondary {
background: #ffffff; }
.md-typeset .md-button.md-button--secondary:focus, .md-typeset .md-button.md-button--secondary:hover {
color: var(--md-primary-fg-color);
background: #e5e5e5; }
.md-main .md-content a:not(.action-button):not([tabindex]), .md-main .md-content a:not(.action-button):not([tabindex]),
.md-main .md-content a:not(.action-button):not([tabindex]) { .md-main .md-content a:not(.action-button):not([tabindex]) {
color: var(--md-typeset-color); color: var(--md-typeset-color);
border-bottom: 2px solid var(--md-primary-fg-color); } border-bottom: 2px solid var(--md-primary-fg-color); }
.md-main .md-content a:not(.action-button):not([tabindex]):focus, .md-main .md-content a:not(.action-button):not([tabindex]):hover,
.md-main .md-content a:not(.action-button):not([tabindex]):focus, .md-main .md-content a:not(.action-button):not([tabindex]):focus,
.md-main .md-content a:not(.action-button):not([tabindex]):hover { .md-main .md-content a:not(.action-button):not([tabindex]):hover {
color: var(--md-typeset-color); color: var(--md-typeset-color);
......
.docs/stylesheets/custom.css.map
+ 1
− 1
View file @ 7f576567
{ {
"version": 3, "version": 3,
"mappings": "AAAA;6BAC8B;EAC1B,qBAAqB,CAAC,QAAQ;EAC9B,oBAAoB,CAAC,yBAAyB;EAC9C,2BAA2B,CAAC,yBAAyB;;AAGzD,cAAe;EACX,MAAM,EAAE,iBAAiB;;AAG7B;0DAC2D;EACvD,KAAK,EAAE,uBAAuB;EAC9B,aAAa,EAAE,oCAAoC;;AAGvD;gEACiE;EAC7D,KAAK,EAAE,uBAAuB;EAC9B,aAAa,EAAE,0CAA0C;;AAG7D,UAAW;EACP,gBAAgB,EAAE,gCAAgC;;ACnBtD,gBAYC;EAXC;;;MAGK;IACH,SAAS,EAAE,QAAQ;EAGrB;KACI;IACF,SAAS,EAAE,WAAW;AAYxB,oBAAS;EACP,KAAK,EAAE,OAAO;AAKhB,qBAAU;EACR,KAAK,EAAE,OAAO;AAIhB,sBAAW;EACT,KAAK,EAAE,IAAI;EAGX,6BAAS;IACP,QAAQ,EAAE,QAAQ;IAClB,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,CAAC;IACT,cAAc,EAAE,OAAO;EAIzB,6BAAO;IACL,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,CAAC;IACN,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,MAAM;IAChB,MAAM,EAAE,IAAI;AAKhB,sBAAW;EACT,SAAS,EAAE,qBAAqB;AAMlC,sBAAW;EACT,SAAS,EAAE,MAAM;EAGjB,6BAAS;IACP,KAAK,EAAE,KAAK;IACZ,WAAW,EAAE,MAAM;AAQvB,8BAAmB;EACjB,MAAM,EAAE,OAAO;EACf,UAAU,EAAE,aAAa;EAGzB,iDAAqB;IACnB,OAAO,EAAE,IAAI;EAIf,qCAAO;IACL,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,0BAA0B;IACjC,gBAAgB,EAAE,0BAA0B;AAQ9C;2BACG;EACD,OAAO,EAAE,CAAC;AAIZ,2BAAG;EACD,YAAY,EAAE,KAAK;AAKvB,sBAAW;EACT,MAAM,EAAE,QAAQ;EAGhB,yBAAG;IACD,UAAU,EAAE,IAAI;IAGhB,4BAAG;MACD,aAAa,EAAE,GAAG;EAKtB,4BAAQ;IACN,OAAO,EAAE,IAAI;IACb,GAAG,EAAE,QAAQ;EAIf,+BAAW;IACT,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,CAAC;IACP,cAAc,EAAE,MAAM;IAGtB,oCAAK;MACH,OAAO,EAAE,WAAW;MACpB,WAAW,EAAE,QAAQ;MACrB,eAAe,EAAE,aAAa;IAIhC,mDAAoB;MAClB,SAAS,EAAE,GAAG;IAIhB,oCAAK;MACH,KAAK,EAAE,KAAK;;ACtJpB,cAAe;EACb,WAAW,EAAE,OAAO;EACpB,UAAU,EAAE,gYAMX;EAGD,6CAAiC;IAC/B,UAAU,EAAE,kYAMX;;AAKL,SAAU;EACR,MAAM,EAAE,MAAM;EACd,KAAK,EAAE,0BAA0B;EAGjC,YAAG;IACD,aAAa,EAAE,IAAI;IACnB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,YAAY;EAKrB,kBAAW;IACT,cAAc,EAAE,KAAK;;AAIzB,uBAAwB;EACtB,cAAc,EAAE,WAAW;;AAM3B,sCAAwB;EACtB,KAAK,EAAE,IAAI;EACX,OAAO,EAAE,IAAI;EACb,IAAI,EAAE,OAAO;EACb,SAAS,EAAE,UAAU;EACrB,GAAG,EAAE,MAAM;EACX,MAAM,EAAE,UAAU;EAElB,qDAAiB;IACf,cAAc,EAAE,WAAW;EAG7B,mDAAe;IACb,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,OAAO;IACnB,SAAS,EAAE,OAAO;IAClB,MAAM,EAAE,gBAAgB;EAG1B,0CAAM;IACJ,MAAM,EAAE,MAAM;IACd,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,CAAC;IAEd,gDAAQ;MACN,aAAa,EAAE,KAAK;MACpB,UAAU,EAAE,mBAAmB;MAC/B,OAAO,EAAE,KAAK;MACd,MAAM,EAAE,IAAI;MACZ,SAAS,EAAE,IAAI;MACf,KAAK,EAAE,KAAK;;ACxEpB,8CAA+C;EAC3C,UAAU,EAAE,MAAM;EAClB,aAAa,EAAE,MAAM", "mappings": "AAAA;6BAC8B;EAC5B,qBAAqB,CAAC,QAAQ;EAC9B,oBAAoB,CAAC,0BACvB;EACE,2BAA2B,CAAC,0BAC9B;;AAGA,cAAe;EACb,MAAM,EAAE,iBAAiB;;AAG3B,2CAA4C;EAC1C,UAAU,EAAE,OAAO;EAEnB,oGACQ;IACN,KAAK,EAAE,0BAA0B;IACjC,UAAU,EAAE,OAAO;;AAKvB;0DAC2D;EACzD,KAAK,EAAE,uBAAuB;EAC9B,aAAa,EAAE,oCAAoC;EAEnD;;kEACQ;IACN,KAAK,EAAE,uBAAuB;IAC9B,aAAa,EAAE,0CAA0C;;AAK7D,UAAW;EACT,gBAAgB,EAAE,gCAAgC;;ACjCpD,gBAYC;EAXC;;;MAGK;IACH,SAAS,EAAE,QAAQ;EAGrB;KACI;IACF,SAAS,EAAE,WAAW;AAYxB,oBAAS;EACP,KAAK,EAAE,OAAO;AAKhB,qBAAU;EACR,KAAK,EAAE,OAAO;AAIhB,sBAAW;EACT,KAAK,EAAE,IAAI;EAGX,6BAAS;IACP,QAAQ,EAAE,QAAQ;IAClB,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,CAAC;IACT,cAAc,EAAE,OAAO;EAIzB,6BAAO;IACL,QAAQ,EAAE,QAAQ;IAClB,GAAG,EAAE,CAAC;IACN,IAAI,EAAE,CAAC;IACP,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,MAAM;IAChB,MAAM,EAAE,IAAI;AAKhB,sBAAW;EACT,SAAS,EAAE,qBAAqB;AAMlC,sBAAW;EACT,SAAS,EAAE,MAAM;EAGjB,6BAAS;IACP,KAAK,EAAE,KAAK;IACZ,WAAW,EAAE,MAAM;AAQvB,8BAAmB;EACjB,MAAM,EAAE,OAAO;EACf,UAAU,EAAE,aAAa;EAGzB,iDAAqB;IACnB,OAAO,EAAE,IAAI;EAIf,qCAAO;IACL,OAAO,EAAE,KAAK;IACd,KAAK,EAAE,0BAA0B;IACjC,gBAAgB,EAAE,0BAA0B;AAQ9C;2BACG;EACD,OAAO,EAAE,CAAC;AAIZ,2BAAG;EACD,YAAY,EAAE,KAAK;AAKvB,sBAAW;EACT,MAAM,EAAE,QAAQ;EAGhB,yBAAG;IACD,UAAU,EAAE,IAAI;IAGhB,4BAAG;MACD,aAAa,EAAE,GAAG;EAKtB,4BAAQ;IACN,OAAO,EAAE,IAAI;IACb,GAAG,EAAE,QAAQ;EAIf,+BAAW;IACT,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,CAAC;IACP,cAAc,EAAE,MAAM;IAGtB,oCAAK;MACH,OAAO,EAAE,WAAW;MACpB,WAAW,EAAE,QAAQ;MACrB,eAAe,EAAE,aAAa;IAIhC,mDAAoB;MAClB,SAAS,EAAE,GAAG;IAIhB,oCAAK;MACH,KAAK,EAAE,KAAK;;ACtJpB,cAAe;EACb,WAAW,EAAE,OAAO;EACpB,UAAU,EAAE,gYAMX;EAGD,6CAAiC;IAC/B,UAAU,EAAE,kYAMX;;AAKL,SAAU;EACR,MAAM,EAAE,MAAM;EACd,KAAK,EAAE,0BAA0B;EAGjC,YAAG;IACD,aAAa,EAAE,IAAI;IACnB,WAAW,EAAE,GAAG;IAChB,KAAK,EAAE,YAAY;EAKrB,kBAAW;IACT,cAAc,EAAE,KAAK;;AAIzB,uBAAwB;EACtB,cAAc,EAAE,WAAW;;AAM3B,sCAAwB;EACtB,KAAK,EAAE,IAAI;EACX,OAAO,EAAE,IAAI;EACb,IAAI,EAAE,OAAO;EACb,SAAS,EAAE,UAAU;EACrB,GAAG,EAAE,MAAM;EACX,MAAM,EAAE,UAAU;EAElB,qDAAiB;IACf,cAAc,EAAE,WAAW;EAG7B,mDAAe;IACb,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,OAAO;IACnB,SAAS,EAAE,OAAO;IAClB,MAAM,EAAE,gBAAgB;EAG1B,0CAAM;IACJ,MAAM,EAAE,MAAM;IACd,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,CAAC;IAEd,gDAAQ;MACN,aAAa,EAAE,KAAK;MACpB,UAAU,EAAE,mBAAmB;MAC/B,OAAO,EAAE,KAAK;MACd,MAAM,EAAE,IAAI;MACZ,SAAS,EAAE,IAAI;MACf,KAAK,EAAE,KAAK;;ACxEpB,8CAA+C;EAC3C,UAAU,EAAE,MAAM;EAClB,aAAa,EAAE,MAAM",
"sources": ["custom/_colors.scss","custom/_typeset.scss","custom/layout/_hero.scss","custom.scss"], "sources": ["custom/_colors.scss","custom/_typeset.scss","custom/layout/_hero.scss","custom.scss"],
"names": [], "names": [],
"file": "custom.css" "file": "custom.css"
......
.docs/stylesheets/custom/_colors.scss
+ 24
− 10
View file @ 7f576567
:root, :root,
[data-md-color-accent=indigo] { [data-md-color-accent=indigo] {
--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% */
;
} }
img.img-border { img.img-border {
border: 1px solid #b3b3b3; border: 1px solid #b3b3b3;
} }
.md-typeset .md-button.md-button--secondary {
background: #ffffff;
&:focus,
&:hover {
color: var(--md-primary-fg-color);
background: #e5e5e5 /* darken 10% */
;
}
}
.md-main .md-content a:not(.action-button):not([tabindex]), .md-main .md-content a:not(.action-button):not([tabindex]),
.md-main .md-content a:not(.action-button):not([tabindex]) { .md-main .md-content a:not(.action-button):not([tabindex]) {
color: var(--md-typeset-color); color: var(--md-typeset-color);
border-bottom: 2px solid var(--md-primary-fg-color); border-bottom: 2px solid var(--md-primary-fg-color);
}
.md-main .md-content a:not(.action-button):not([tabindex]):focus, &:focus,
.md-main .md-content a:not(.action-button):not([tabindex]):hover { &:hover {
color: var(--md-typeset-color); color: var(--md-typeset-color);
border-bottom: 2px solid var(--md-primary-fg-color--dark); border-bottom: 2px solid var(--md-primary-fg-color--dark);
} }
}
.md-banner { .md-banner {
background-color: var(--md-primary-fg-color--dark); background-color: var(--md-primary-fg-color--dark);
......
mkdocs.yml
+ 2
− 0
View file @ 7f576567
...@@ -106,6 +106,8 @@ extra: ...@@ -106,6 +106,8 @@ extra:
default: 1.4.2 default: 1.4.2
provider: mike provider: mike
social: social:
- icon: simple/artifacthub
link: https://artifacthub.io/packages/helm/dbrepo/dbrepo
- icon: fontawesome/brands/docker - icon: fontawesome/brands/docker
link: https://hub.docker.com/search?q=dbrepo link: https://hub.docker.com/search?q=dbrepo
- icon: fontawesome/brands/python - icon: fontawesome/brands/python
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment