clean up the mkdocs config (#1)

* clean up mkdocs configuration
* update the tds docs workflow to generate tds docs and a link on the PR

Author: bcumming

.github/workflows/docs_pr.yaml

@@ -38,12 +38,3 @@ jobs:
           name: docs
           path: upload
           if-no-files-found: error
-      - name: Post comment with preview URL
-        run: |
-          curl -L -X POST \
-            -H "Accept: application/vnd.github+json" \
-            -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
-            "https://api.github.com/repos/bcumming/kb-poc/issues/${{ github.event.pull_request.number }}/comments" \
-            -d '{
-              "body": "preview available: https://docs.tds.cscs.ch/${{ github.event.pull_request.number }}"
-            }'

.github/workflows/docs_pr_upload.yaml

@@ -24,3 +24,12 @@ jobs:
             ls -alh
             PR_NBR=$(cat pr_number.txt)
             curl --data-binary @site.tar.gz -H "Authorization: Bearer ${{ secrets.UPLOAD_TOKEN }}" https://docs.tds.cscs.ch/upload?path=$PR_NBR
+      - name: Post comment with preview URL
+        run: |
+          curl -L -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+            "https://api.github.com/repos/eth-cscs/cscs-docs/issues/${{ github.event.pull_request.number }}/comments" \
+            -d '{
+              "body": "preview available: https://docs.tds.cscs.ch/${{ github.event.pull_request.number }}"
+            }'

mkdocs.yml

@@ -1,12 +1,18 @@
-site_name: CSCS Knowledge Base
-# TODO: change to match target deployment
-#site_url: https://eth-cscs.github.io/
+site_name: CSCS Documentation
+# TODO: change to https://docs.cscs.ch when the time comes
+site_url: https://eth-cscs.github.io/
 
 # provide a link to the docs in top RHS corner
 repo_url: https://github.com/eth-cscs/cscs-docs
 # provide a link to "edit this page" to each page
 edit_uri: edit/main/docs/
-
+extra_css:
+  - stylesheets/extra.css
+plugins:
+  - search:
+      pipeline:
+        - trimmer
+  - autorefs
 nav:
   - Welcome: index.md
   - 'Alps':
@@ -55,7 +61,6 @@ nav:
 theme:
   name: material
   language: en
-  #custom_dir: docs/.overrides
   features:
     - content.code.copy
     # add an "edit this page" icon on each page
@@ -92,18 +97,10 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
-
   logo: assets/cscs-logo.png
   font:
     text: Roboto
     code: Roboto Mono
-
-plugins:
-  - search:
-      pipeline:
-        - trimmer
-  - autorefs
-
 markdown_extensions:
   - admonition
   - def_list
@@ -140,6 +137,3 @@ markdown_extensions:
 #  - javascripts/mathjax.js
 #  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
 
-extra_css:
-  - stylesheets/extra.css
-

readme.md

@@ -13,8 +13,8 @@ The source CSCS documentation [docs.cscs.ch](httpa://docs.cscs.ch)
 
 Clone this repository on your PC/laptop, then view the documentation in a browser run `./serve`:
 ```bash
-> git clone [email protected]:${githubusername}/kb.git
-> cd kb
+> git clone [email protected]:${githubusername}/cscs-docs.git
+> cd cscs-docs
 > ./serve
 ...
 INFO    -  [08:33:34] Serving on http://127.0.0.1:8000/