Merge pull request #50 from rosalindfranklininstitute/adding-documentation-ab

Towards changes for documentation to be repository specific

Author: nitrosx

.gitignore

@@ -3,3 +3,4 @@ _site
 .jekyll-cache
 .jekyll-metadata
 vendor
+.env

_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

_includes/documentation.html

@@ -0,0 +1,18 @@
+<section id="documentation" class="effort text-center bg-light">
+ <div class="container">
+  <h1 class="mt-5 mb-5">Documentation</h1>
+  <div class="row">
+   {% for document in site.documentation %}
+     <div class="documentation"> <div class="documentation-name">
+      <div class="name">{{ document.name }}</div>
+     </div>
+     <div class="documentation-info">
+      <div class="text">{{ document.description }}</div>
+      <div class="text"><a href="{{ document.link }}" target="_blank">{{ document.link }}</a></div>
+      <a href="{{ document.url }}" target="_blank">{{ document.name }}</a>
+     </div>
+   {% endfor %}
+  </div>
+ </div>
+</section>
+

_includes/nav.html

@@ -81,7 +81,7 @@
      <a class="page-scroll nav-link" id="nav-link-effort" href="{{'#effort' | relative_url }}" onclick="onClick(event);">Effort</a>
     </li>
     <li class="nav-item mx-lg-3">
-     <a class="page-scroll nav-link" id="nav-link-resources" href="{{'#resources' | relative_url }}" onclick="onClick(event);">Resources</a>
+     <a class="page-scroll nav-link" id="nav-link-documentation" href="{{'#documentation' | relative_url }}" onclick="onClick(event);">Documentation</a>
     </li>
   </div>
 </nav>

_includes/resources.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 %}
   <script src="/assets/js/main.js"></script>

_layouts/home.html

@@ -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