From 1899771b75606b303d78d581a240d203a9f6e0a7 Mon Sep 17 00:00:00 2001 From: LAShemilt Date: Mon, 3 Jun 2024 12:23:31 +0000 Subject: [PATCH 1/4] changing resources to documentation and adding links to the documentation pages --- _config.yml | 37 +++++++++++++++++++----------------- _includes/documentation.html | 18 ++++++++++++++++++ _includes/nav.html | 2 +- _includes/resources.html | 13 ------------- _layouts/home.html | 2 +- 5 files changed, 40 insertions(+), 32 deletions(-) create mode 100644 _includes/documentation.html delete mode 100644 _includes/resources.html diff --git a/_config.yml b/_config.yml index 53c4100..7540f36 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/Users/ + - 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://github.com/ScicatProject/scicatlive + - 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.link }}
+ {{ 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
  • - Resources + Documentation
    • 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 %} -
    - {{ resource.name }} -
    - {% 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 %} From 7234a304e53f4e7aeb8a2ceb76975bbb0525e7af Mon Sep 17 00:00:00 2001 From: LAShemilt Date: Wed, 24 Jul 2024 12:34:22 +0000 Subject: [PATCH 2/4] removing the 'User' endpoint and just reaching to the documentation website. In future this will be updated to include the user friendly docs --- .gitignore | 1 + README.md | 2 +- _config.yml | 2 +- docker-compose.yaml | 7 +++++-- 4 files changed, 8 insertions(+), 4 deletions(-) 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/README.md b/README.md index dba744a..ce99e65 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ gem install bundler jekyll ## Running with docker You may prefer to build using a docker container to avoid installing all the dependencies. -This can be done by simply running the following from the project directory: +This can be done by simply running the following from the projlect directory: ```bash docker-compose up diff --git a/_config.yml b/_config.yml index 7540f36..f72479f 100644 --- a/_config.yml +++ b/_config.yml @@ -185,7 +185,7 @@ documentation: url: https://github.com/ScicatProject - name: User Guides description: Experience SciCat as a user - url: https://scicatproject.github.io/documentation/Users/ + 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://github.com/ScicatProject/scicatlive 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 From 62ddf71edfacca94e9f0f36df137238be856c405 Mon Sep 17 00:00:00 2001 From: LAShemilt Date: Wed, 24 Jul 2024 12:43:15 +0000 Subject: [PATCH 3/4] adding the latest docs from SciCatLive --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index f72479f..2102be7 100644 --- a/_config.yml +++ b/_config.yml @@ -188,7 +188,7 @@ documentation: 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://github.com/ScicatProject/scicatlive + 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 From b638170dba97028e082f14827b39c40e42f657ab Mon Sep 17 00:00:00 2001 From: LAShemilt Date: Fri, 26 Jul 2024 13:28:30 +0100 Subject: [PATCH 4/4] removing spelling error --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ce99e65..dba744a 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ gem install bundler jekyll ## Running with docker You may prefer to build using a docker container to avoid installing all the dependencies. -This can be done by simply running the following from the projlect directory: +This can be done by simply running the following from the project directory: ```bash docker-compose up