From ea5a453042b6e15cf333c520f7763cfc294eccff Mon Sep 17 00:00:00 2001
From: Martin Weise <martin.weise@tuwien.ac.at>
Date: Sat, 23 Apr 2022 07:31:38 +0200
Subject: [PATCH] Added production template, moved the endpoint to own
directory
---
Makefile => Makefile.make | 10 +++++-----
docs/index.md | 2 +-
docs/operation/{ => endpoints}/authentication.md | 0
docs/operation/{ => endpoints}/container.md | 0
docs/operation/{ => endpoints}/database.md | 0
docs/operation/{ => endpoints}/identifier.md | 0
docs/operation/{ => endpoints}/query.md | 0
docs/operation/index.md | 10 ++--------
docs/operation/production.md | 9 +++++++++
docs/publications.md | 10 ++++++++--
mkdocs.yml | 12 +++++++-----
11 files changed, 32 insertions(+), 21 deletions(-)
rename Makefile => Makefile.make (65%)
rename docs/operation/{ => endpoints}/authentication.md (100%)
rename docs/operation/{ => endpoints}/container.md (100%)
rename docs/operation/{ => endpoints}/database.md (100%)
rename docs/operation/{ => endpoints}/identifier.md (100%)
rename docs/operation/{ => endpoints}/query.md (100%)
create mode 100644 docs/operation/production.md
diff --git a/Makefile b/Makefile.make
similarity index 65%
rename from Makefile
rename to Makefile.make
index 0ec51d0..58ac04f 100644
--- a/Makefile
+++ b/Makefile.make
@@ -9,11 +9,11 @@ run: build
docker-compose up
docs:
- widdershins --environment ./misc/env.json ./misc/api-authentication.yaml -o ./docs/operation/authentication.md
- widdershins --environment ./misc/env.json ./misc/api-container.yaml -o ./docs/operation/container.md
- widdershins --environment ./misc/env.json ./misc/api-database.yaml -o ./docs/operation/database.md
- widdershins --environment ./misc/env.json ./misc/api-identifier.yaml -o ./docs/operation/identifier.md
- widdershins --environment ./misc/env.json ./misc/api-query.yaml -o ./docs/operation/query.md
+ widdershins --environment ./misc/env.json ./misc/api-authentication.yaml -o ./docs/operation/endpoints/authentication.md
+ widdershins --environment ./misc/env.json ./misc/api-container.yaml -o ./docs/operation/endpoints/container.md
+ widdershins --environment ./misc/env.json ./misc/api-database.yaml -o ./docs/operation/endpoints/database.md
+ widdershins --environment ./misc/env.json ./misc/api-identifier.yaml -o ./docs/operation/endpoints/identifier.md
+ widdershins --environment ./misc/env.json ./misc/api-query.yaml -o ./docs/operation/endpoints/query.md
deploy: run
sudo cp -r ./site/* /usr/share/nginx/html/
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index 756d9a1..b81faf3 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -26,5 +26,5 @@ evolving, allows reproducing of query results and supports findable-, accessible
- This documentation can be downloaded as [PDF](/pdf/document.pdf)
- Public demonstration instance [https://dbrepo.ossdip.at](https://dbrepo.ossdip.at)
-- Join our [mailing list](https://lists.univie.ac.at/mailman/listinfo/fairdata_dbrepo) to receive bi-monthly updates
+- Join our [mailing list](https://lists.univie.ac.at/mailman/listinfo/fairdata_dbrepo) to receive updates every 2-3 months
about the progress, new features and events!
\ No newline at end of file
diff --git a/docs/operation/authentication.md b/docs/operation/endpoints/authentication.md
similarity index 100%
rename from docs/operation/authentication.md
rename to docs/operation/endpoints/authentication.md
diff --git a/docs/operation/container.md b/docs/operation/endpoints/container.md
similarity index 100%
rename from docs/operation/container.md
rename to docs/operation/endpoints/container.md
diff --git a/docs/operation/database.md b/docs/operation/endpoints/database.md
similarity index 100%
rename from docs/operation/database.md
rename to docs/operation/endpoints/database.md
diff --git a/docs/operation/identifier.md b/docs/operation/endpoints/identifier.md
similarity index 100%
rename from docs/operation/identifier.md
rename to docs/operation/endpoints/identifier.md
diff --git a/docs/operation/query.md b/docs/operation/endpoints/query.md
similarity index 100%
rename from docs/operation/query.md
rename to docs/operation/endpoints/query.md
diff --git a/docs/operation/index.md b/docs/operation/index.md
index 01f6d41..2ec4629 100644
--- a/docs/operation/index.md
+++ b/docs/operation/index.md
@@ -1,11 +1,5 @@
# Operation
-## Deploy
+!!! abstract "Abstract"
-```bash
-make teardown
-make config-frontend # for renewing Let's Encrypt certificates
-docker-compose build fda-metadata-database
-docker-compose build --parallel
-docker-compose -f docker-compose.prod.yml up -d
-```
+ We compiled a short [getting started guide](/getting-started) that quickly allows a stand-alone test-deployment of the infrastructure on your server without the need of infrastructure configuration.
\ No newline at end of file
diff --git a/docs/operation/production.md b/docs/operation/production.md
new file mode 100644
index 0000000..c74e2c6
--- /dev/null
+++ b/docs/operation/production.md
@@ -0,0 +1,9 @@
+# Production
+
+!!! bug "Alpha-release software"
+
+ Currently, the database repository is in an alpha-release and not considered secure enough to hold sensitive data. Enroll into our [mailing list](https://lists.univie.ac.at/mailman/listinfo/fairdata_dbrepo) and be notified every 2-3 months with progress of the software.
+
+!!! info "Friendly users"
+
+ We always welcome friendly users who want to deploy the database repository on their premises and provide continious feedback and create bug reports. We also take their improvement inquiries to improve the software quality. Please [contact](/contact) us.
\ No newline at end of file
diff --git a/docs/publications.md b/docs/publications.md
index f15f0f4..608e353 100644
--- a/docs/publications.md
+++ b/docs/publications.md
@@ -7,14 +7,20 @@ hide:
# Publications
-### Conferences
+## Refereed
+
+##### 2022
+
+1. Weise, M., Staudinger, M., Michlits, C., Gergely, E., Stytsenko, K., Ganguly, R. and Rauber A., 2022. A Semantic Digital Repository for Relational Databases, [accepted] in *Proceedings of the 17th International Digital Curation Conference*, (Virtual).
+
+##### 2021
1. Weise, M., Michlits, C., Staudinger, M., Gergely, E., Stytsenko, K., Ganguly, R. and Rauber A., 2021. FDA-DBRepo: A
Data Preservation Repository Supporting FAIR Principles, Data Versioning and Reproducible Queries. *Proceedings of
the 17th International Conference on Digital Preservation*, Beijing, China, p.34.
DOI: [10.17605/OSF.IO/B7NX5](http://doi.org/10.17605/OSF.IO/B7NX5)
-### News
+## Other
1. Staudinger, M., 2022. DBRepo: A Repository to Save Research Databases. [Online].
URL: [https://www.tuwien.at/en/tu-wien/news/news-articles/news/dbrepo](https://www.tuwien.at/en/tu-wien/news/news-articles/news/dbrepo)
diff --git a/mkdocs.yml b/mkdocs.yml
index e9e846c..18635ef 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -14,11 +14,13 @@ nav:
- system.md
- Operation:
- operation/index.md
- - operation/authentication.md
- - operation/container.md
- - operation/database.md
- - operation/identifier.md
- - operation/query.md
+ - operation/production.md
+ - Endpoints:
+ - operation/endpoints/authentication.md
+ - operation/endpoints/ontainer.md
+ - operation/endpoints/database.md
+ - operation/endpoints/identifier.md
+ - operation/endpoints/query.md
- publications.md
- contact.md
extra_css:
--
GitLab