Merge pull request #2 from rkweehinzmann/main

first import as is from rkweehinzmann/user-sc-manual

Author: nitrosx

Diff for: .github/mkdocs/mkdocs.yaml

@@ -0,0 +1,42 @@
+site_name: SciCat Documentation
+docs_dir: ../../docs
+
+
+nav: 
+  - Home: index.md
+  - SciCat User Guide:  
+    - user-manual/index.md
+    - Login:
+      - login/index.md
+      - Anonymous: login/Anonymous.md
+      - Dashboard: login/Dashboard.md
+    - Datasets:
+      - datasets/index.md
+      - Register DOIs: datasets/Publishing.md
+    - Proposals: proposals.md
+    - Samples: samples.md
+    - Instruments: instruments.md
+    - Troubleshooting:
+      - troubleshoot/index.md
+  
+  - SciCat Operator Guide: 
+    - operator-manual/index.md
+    - sites/DESY/index.md
+    - swagger/index.md
+    - backendconfig/index.md
+    - backendconfig/dois.md
+    
+
+  - About:
+      - about/index.md
+
+theme: material 
+
+plugins:
+  - search
+  - glightbox
+  - section-index
+
+
+extra_css:
+  - custom.css

Diff for: .github/mkdocs/requirements.txt

@@ -0,0 +1,44 @@
+Babel==2.16.0
+beautifulsoup4==4.12.3
+bracex==2.5.post1
+certifi==2024.8.30
+charset-normalizer==3.4.0
+click==8.1.7
+colorama==0.4.6
+ghp-import==2.1.0
+idna==3.10
+importlib_metadata==8.5.0
+importlib_resources==6.4.5
+Jinja2==3.1.4
+lxml==5.3.0
+Markdown==3.7
+MarkupSafe==3.0.2
+mergedeep==1.3.4
+mike==2.1.3
+mkdocs==1.6.1
+mkdocs-awesome-pages-plugin==2.9.3
+mkdocs-get-deps==0.2.0
+mkdocs-glightbox==0.4.0
+mkdocs-material==9.5.42
+mkdocs-material-extensions==1.3.1
+mkdocs-section-index==0.3.9
+natsort==8.4.0
+packaging==24.1
+paginate==0.5.7
+pathspec==0.12.1
+platformdirs==4.3.6
+Pygments==2.18.0
+pymdown-extensions==10.11.2
+pyparsing==3.2.0
+python-dateutil==2.9.0.post0
+PyYAML==6.0.2
+pyyaml_env_tag==0.1
+regex==2024.9.11
+requests==2.32.3
+six==1.16.0
+soupsieve==2.6
+urllib3==2.2.3
+verspec==0.1.0
+watchdog==5.0.3
+wcmatch==10.0
+zipp==3.20.2

Diff for: .github/workflows/mkdocs.yaml

@@ -0,0 +1,16 @@
+name: Deploy docs
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: SciCatProject/scicatlive/.github/actions/mkdocs-pages@tree
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          push: true

Diff for: docs/.gitignore

@@ -0,0 +1,3 @@
+# Ignore modified files
+*.md~
+*.DS_Store

Diff for: docs/about/img/versionInfoFrontend.png

@@ -0,0 +1,6 @@
+# About the team - who are we?
+SciCat has been initially developed at PSI but is now in production use across many other European and transatlantic countries. The core institutes are still PSI and ESS, but invaluable contribution comes from other labs, see [SciCat Team](https://www.scicatproject.org/#team) for up-to-date details.
+
+# About SciCat version
+Here is where you find the [frontend](operatorHowTos.md) version.
+

Diff for: docs/about/img/versionscicat-backend-dev.png

@@ -0,0 +1,5 @@
+# Where is the version of SciCat Frontend?
+
+Version information under ```user```
+![version information of frontend](img/versionInfoFrontend.png)
+

Diff for: docs/about/index.md

@@ -0,0 +1,8 @@
+# DOI minting in SciCat - How to publish datasets
+
+## Introduction
+User introduction can be found [here](../doisIntro.md).
+
+
+
+