diff --git a/.gitignore b/.gitignore index f40fbd8..258adaa 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ _site .jekyll-cache .jekyll-metadata vendor +.env \ No newline at end of file diff --git a/_config.yml b/_config.yml index 53c4100..2102be7 100644 --- a/_config.yml +++ b/_config.yml @@ -178,27 +178,30 @@ efforts: link: https://github.com/SciCatProject/scitacean -resources: - - name: Official website (aka this one) - url: https://scicatproject.github.io - - name: Documentation - url: https://scicatproject.github.io/documentation +documentation: + - name: Official github project + description: All software packages that are part of the SciCat ecosystem are in the Github project. For documentation see each project. url: https://github.com/ScicatProject - - name: pySciCat documentation + - name: User Guides + description: Experience SciCat as a user + url: https://scicatproject.github.io/documentation/ + - name: Get Started + description: To get started with a standalone installation of SciCat and to know more about how to add it to your infrastructure visit the SciCat Live repository. + url: https://scicatproject.github.io/scicatlive/latest/ + - name: Backend + description: For developer documentation on the SciCat backend. + url: https://github.com/ScicatProject/scicat-backend-next + - name: Frontend + description: For more information on the SciCat frontend and developer documentation. + url: https://github.com/ScicatProject/frontend + - name: pySciCat + description: The pyscicat project is a python client library to interact with the SciCat backend. url: https://scicatproject.github.io/pyscicat/ - - name: Scitacean documentation + - name: Scitacean + description: Scictacean is a high level python packaging for uploading and downloading data to and from SciCat. url: https://scicatproject.github.io/scitacean/ - - name: SciCat backend repository - url: https://github.com/ScicatProject/scicat-backend-next - - name: SciCat website repository - url: https://github.com/SciCatProject/scicatproject.github.io - - name: SciCat documentation repository - url: https://github.com/SciCatProject/documentation - - name: pySciCat repository - url: https://github.com/SciCatProject/pyscicat - - name: Scitacean repository - url: https://github.com/SciCatProject/scitacean + # Build settings diff --git a/_includes/documentation.html b/_includes/documentation.html new file mode 100644 index 0000000..93d09ba --- /dev/null +++ b/_includes/documentation.html @@ -0,0 +1,18 @@ +
+
+

Documentation

+
+ {% for document in site.documentation %} +
+
{{ document.name }}
+
+
+
{{ document.description }}
+ + {{ document.name }} +
+ {% endfor %} +
+
+
+ diff --git a/_includes/nav.html b/_includes/nav.html index a34b625..8f08ed2 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -81,7 +81,7 @@ Effort diff --git a/_includes/resources.html b/_includes/resources.html deleted file mode 100644 index af9a700..0000000 --- a/_includes/resources.html +++ /dev/null @@ -1,13 +0,0 @@ -
-
-

Resources

-
- {% for resource in site.resources %} - - {% endfor %} -
-
-
- diff --git a/_layouts/home.html b/_layouts/home.html index 8608c7c..2ec9b38 100644 --- a/_layouts/home.html +++ b/_layouts/home.html @@ -19,7 +19,7 @@ {% include breaker.html %} {% include effort.html %} {% include breaker.html %} - {% include resources.html %} + {% include documentation.html %} {% include breaker.html %} {% include footer.html %} diff --git a/docker-compose.yaml b/docker-compose.yaml index c5752b0..3741448 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -2,8 +2,11 @@ version: '3' services: serve: image: jekyll/jekyll:latest - command: jekyll serve --watch --force_polling --verbose + command: jekyll serve --watch --force_polling --verbose --trace ports: - - 4000:4000 + - "4000:4000" + environment: + JEKYLL_UID: $JEKYLL_UID + JEKYLL_GID: $JEKYLL_GID volumes: - .:/srv/jekyll \ No newline at end of file