diff --git a/docs/contact.md b/docs/contact.md index 43b98707a9adaf7ebcda309f72cc4be80bc2bd52..cfad049c1d674ad7cbdee8393ad282d8e9a3fbd0 100644 --- a/docs/contact.md +++ b/docs/contact.md @@ -7,10 +7,30 @@ hide: # Contact -Ao.Univ.Prof. Dipl.-Ing. Dr.techn. Andreas Rauber<br /> -[Technische Universität Wien](https://ror.org/04d836q62)<br /> -[Information and Software Engineering Group](https://informatics.tuwien.ac.at/orgs/e194-01)<br /> +## Team + +### Project + +Ao.univ.Prof. Dr. [Andreas Rauber](//tiss.tuwien.ac.at/person/39608.html)<br /> +Technische Universität Wien<br /> +Information and Software Engineering Group<br /> Favoritenstraße 9-11<br /> A-1040 Vienna, Austria -Mail: [andreas.rauber@tuwien.ac.at](mailto:andreas.rauber@tuwien.ac.at) \ No newline at end of file +### Development + +Projektass. Dipl.-Ing. [Martin Weise](//tiss.tuwien.ac.at/person/287722.html)<br /> +Technische Universität Wien<br /> +Information and Software Engineering Group<br /> +Favoritenstraße 9-11<br /> +A-1040 Vienna, Austria + +## Contributors + +- Martin Weise +- Moritz Staudinger +- Cornelia Michlits +- Eva Gergely +- Kirill Stytsenko +- Raman Ganguly +- Andreas Rauber diff --git a/docs/getting-started.md b/docs/getting-started.md index b972139f5db3345fcbed8724bc74c13dc1e6d014..0c2059c5eba467132608149e9093b7e7eacf8599 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -33,49 +33,42 @@ We currently maintain 14 images on [Dockerhub](https://hub.docker.com/u/dbrepo). === ":fontawesome-brands-linux: Linux" - Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml) + Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml) + and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.example) - ```console - wget https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml - ``` + $ curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml + $ curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.example Start the services - ```console - docker-compose up -d - ``` + $ docker-compose up -d === ":fontawesome-brands-windows: Windows" - - Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml) + Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml) + and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.example) - ```console - curl.exe -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml - ``` + $ curl.exe -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml + $ curl.exe -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.example Start the services - ```console - docker-compose up -d - ``` + $ docker-compose up -d === ":fontawesome-brands-apple: macOS" - - Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml) + Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml) + and [`.env`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.example) - ```console - wget https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml - ``` + $ curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml + $ curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.example Start the services - ```console - docker-compose up -d - ``` + $ docker-compose up -d -The system is auto-configured for a small, local, test deployment. You only need to start all containers by executing: +The system is auto-configured for a small, local, test deployment. You need to place the `.env` file in the same +directory as the `docker-compose.yml`. ## Development diff --git a/docs/system.md b/docs/system.md index 6a7dc33ff75b4a45ac0589af4c2f39b6356af003..b3fffe1d2bc697f010cf0f510a6d71a546710566 100644 --- a/docs/system.md +++ b/docs/system.md @@ -7,10 +7,6 @@ hide: # System -!!! abstract "Abstract" - - Hello - ## Architecture The repository is designed as a microservice architecture to ensure scalability and the utilization of various diff --git a/mkdocs.yml b/mkdocs.yml index 98ad63fa5d4966274f3ff4b0b04b48b3f124a978..ab32164232275422713a9a49efb8846a3407eccc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,6 +28,7 @@ theme: features: - navigation.tabs - navigation.tabs.sticky + - content.code.annotate icon: repo: fontawesome/brands/git-alt palette: