Merge pull request #491 from nfdi4plants/revert-490-image-kebap

Revert "Image kebap"

.config/dotnet-tools.json

@@ -0,0 +1,18 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "fornax": {
+      "version": "0.14.3",
+      "commands": [
+        "fornax"
+      ]
+    },
+    "paket": {
+      "version": "7.1.5",
+      "commands": [
+        "paket"
+      ]
+    }
+  }
+}

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,6 @@
+---
+name: Report a bug
+title: "[bug]"
+about: If you found a bug, error, dead link, please let us know. 
+labels: content
+---

.github/ISSUE_TEMPLATE/contribution-to-the-faq-section.md

@@ -0,0 +1,29 @@
+---
+name: Contribution to the FAQ section
+about: Already got an answer to a question or figured out the answer yourself? Please
+  let others benefit from it by adding your suggestion here.
+title: "[FAQ]"
+labels: FAQ
+assignees: CMR248
+
+---
+
+Once this issue has been reviewed and, if necessary, slightly edited, it will be added to the [FAQ section](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/faqs/faqs.html)
+
+**Question:**
+*Please phrase a question that is as straightforward to answer as possible. If several answers are required, it could be useful to consider phrasing more than one question.*
+
+**Answer:**
+*Please provide a precise answer and refer to existing resources, such as the [Knowledge Base](https://nfdi4plants.org/nfdi4plants.knowledgebase/index.html), if applicable.*
+
+**Suitable for the section:**
+- [ ] General
+- [ ] Annotated Research Context
+- [ ] ARC Commander
+- [ ] ARCitect
+- [ ] DataHUB
+- [ ] DataPLAN
+- [ ] ISA
+- [ ] Swate
+- [ ] Teaching Material
+- [ ] Other (Please make a suggestion)

.github/ISSUE_TEMPLATE/guide-request.md

@@ -0,0 +1,11 @@
+---
+name: Guide request
+title: "[guide]"
+about: If you're missing a guide about a tool, software or concept, please let us know.
+labels: content
+---
+
+**Guide needed**
+*Please name and describe the guide you'd like to see with a few bullet points*
+
+:bulb: If you want to contribute a tutorial, please refer to the [contribution guide](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/CONTRIBUTING.html).

.github/ISSUE_TEMPLATE/topic-request.md

@@ -0,0 +1,17 @@
+---
+name: Topic request
+title: "[topic]"
+about: If you're missing an article about a specific topic, software, concept, or tool, please let us know.
+labels: content
+---
+
+**Topic**
+*Please name and describe the topic with a few bullet points*
+
+**Related to**
+*Is there any related content or section in the knowledge base? Please link it here*
+
+**Resources**
+*If you have suitable resources on a similar topic, feel free to share them with us.*
+
+:bulb: If you want to contribute an article about a topic, please refer to the [contribution guide](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/CONTRIBUTING.html).

.github/pull_request_template.md

@@ -0,0 +1,13 @@
+# Thank you for contributing to the DataPLANT Knowledge Base :rocket:
+
+## Please make sure that
+
+- [ ] your pull request has a **good title**,
+- [ ] you add a short description below to summarize your changes,
+- [ ] the contents and images you add, are allowed to be shared publicly and - if applicable - reference the source properly,
+- [ ] you read the [contribution guide](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/CONTRIBUTING.html),
+- [ ] you tested your changes locally
+
+If you are unsure, you can also label your PR as draft.
+
+## Description

.github/workflows/deploy.yml

@@ -0,0 +1,71 @@
+# This is a basic workflow to help you get started with Actions
+
+name: deploy-gh-pages
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: [ "main" ]
+  # triggers when "update-dependencies" is completed
+  workflow_run:
+    workflows: [update-dependencies]
+    types: [completed]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build-and-deploy:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup .NET 3.1
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 3.1.301
+
+      - name: Setup .NET 5
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 5.0.102
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: install sass
+        run: npm install -g sass
+
+      - name: install node modules
+        run: npm install
+
+      - name: Restore dotnet tools
+        run: dotnet tool restore
+
+      - name: Restore dependencies
+        run: dotnet paket install
+
+      - name: Build
+        working-directory: ./src
+        run: dotnet fornax build
+
+      - name: Index
+        run: npm run index
+
+      - name: deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+            TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            BRANCH: gh-pages # The branch the action should deploy to.
+            FOLDER: ./src/_public # The folder the action should deploy.
+            CLEAN: true # Automatically remove deleted files from the deploy branch

.github/workflows/update-dependencies.yml

@@ -0,0 +1,60 @@
+# This is a basic workflow to help you get started with Actions
+
+name: update-dependencies
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow at 20pm thursday (depends on timezone) (0 18 * * THU)
+  # schedule:
+  #   - cron: '0 21 * * THU'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  update_dependencies:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup .NET 3.1
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 3.1.301
+
+      - name: Setup .NET 5
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 5.0.102
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install rollup
+        run: npm install --global [email protected]
+
+      - name: Update to latest nfdi4plants web components
+        run: npm install @nfdi4plants/web-components@latest
+
+      - name: Bundle npm packages
+        run: rollup --config rollup.config.js --bundleConfigAsCjs
+
+      - name: Restore dotnet tools
+        run: dotnet tool restore
+
+      - name: Update to latest Nfdi4Plants.fornax version
+        run: dotnet paket update Nfdi4Plants.Fornax
+
+      - name: Commit and push changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Update @nfdi4plants/web-components & Nfdi4Plants.Fornax ⬆️

.gitignore

@@ -346,6 +346,11 @@ healthchecksdb
 # Backup folder for Package Reference Convert tool in Visual Studio 2017
 MigrationBackup/
 
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+src/_public
+.vscode/settings.json
+.paket/
 
 # Macos temporary files
-.DS_Store
+.DS_Store

CONTRIBUTING.md

@@ -1,44 +1,3 @@
-# Contribution Guide
+# Knowledge Base Contribution Guide
 
-## Adding your materials
-
-Slide decks or other materials may come in any format (pptx, md, html).
-Although most materials are reusable and editable, this repo is primarily meant as an archive to stably collect materials of past events.
-
-:bulb: Hence, please add your materials (also) in a stable file format (typically PDF) to make them independent of link changes, etc.
-
-1. Add a new folder named `<date>_<context>_<title>` (date format: `yyyy-mm-dd`) with your materials to `slide-decks/`
-2. add a `README.md` to describe the event / materials, etc.
-3. List your slides in the root [README.md](./README.md) sorted by latest first
-<!-- 
-## marp (render markdown slides)
-
-Definitely not a must, but it may make reuse more easily.
-
-## Knowledge Base - git submodule
- -->
-
-
-## File names
-
-- All files and folders must always be [kebap-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case). This means all lower case and `-` as word separator.
-
-```txt title="Example"
-src\assets\images\arc-commander\access-2.png
-```
-
-## Images
-
-### How to store
-
-Try to use `.svg` files for icons, graphics and logos. Use any other file format for screenshots or tutorial images.
-
-Images should be stored in the `images/` directory. If your image has a obvious context, you SHOULD create a subdirectory for it.
-
-```txt title="Example"
-|-- images
-    |-- arc-commander
-        |-- access-1.png
-        |-- access-2.png
-        |-- access-3.png
-```
+You can find the Contribution Guide [here](./src/docs/CONTRIBUTING.md).

README.md

@@ -1,32 +1,33 @@
-# DataPLANT Training Materials
-
-Welcome to the DataPLANT Training Materials.
-
-Here you can find training materials of previous workshops and classes.
-
-Check out the [DataPLANT Knowledge Base](https://nfdi4plants.org/nfdi4plants.knowledgebase/) for up-to-date guides and tutorials.
-
-Materials are shared here under [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/).
-
-## Past events
-
-Event | Slide decks
---------------------------|-------------------------------------------
-2024-10-24_ceplas_arcify-your-research-project | [2024-10-24_ceplas_arcify-your-research-project](slide-decks/2024-10-24_ceplas_arcify-your-research-project)
-2024-06-19_trr175_tutzing-retreat | [2024-06-19_trr175_tutzing-retreat](slide-decks/2024-06-19_trr175_tutzing-retreat)
-2024-04-11_mibinet-ceplas_arc-trainings | [2024-04-11_mibinet-ceplas_arc-trainings](slide-decks/2024-04-11_mibinet-ceplas_arc-trainings)
-2024-04-03_ceplas_arc-trainings | [2024-04-03_ceplas_arc-trainings](slide-decks/2024-04-03_ceplas_arc-trainings)
-2024-02-13_trr175_becoming-fair | [2024-02-13_trr175_becoming-fair](slide-decks/2024-02-13_trr175_becoming-fair)
-2023-11-15_ceplas_arc-clubs | [2023-11-15_ceplas_arc-clubs](slide-decks/2023-11-15_ceplas_arc-clubs)
-2023-11-14_hhu_tagderforschungsdaten | [2023-11-14_hhu_tagderforschungsdaten](slide-decks/2023-11-14_hhu_tagderforschungsdaten)
-2023-11-08_ceplas_phd-module | [2023-11-08_ceplas_phd-module](slide-decks/2023-11-08_ceplas_phd-module)
-2023-10-29_cscs-ceplas_startyourarc | [2023-10-29_cscs-ceplas_startyourarc](slide-decks/2023-10-29_cscs-ceplas_startyourarc)
-2023-09-21_mibinet-ceplas_startyourarc | [2023-09-21_mibinet-ceplas_startyourarc](slide-decks/2023-09-21_mibinet-ceplas_startyourarc)
-2023-09-19_hhu_fdm-nrw-bestpractice | [2023-09-19_hhu_fdm-nrw-bestpractice](slide-decks/2023-09-19_hhu_fdm-nrw-bestpractice)
-2023-07-20_rptu_summerschool-elabftw | [2023-07-20_rptu_summerschool-elabftw](slide-decks/2023-07-20_rptu_summerschool-elabftw)
-2023-07-17_rptu_summerschool-on-rdm | [2023-07-17_rptu_summerschool-on-rdm](slide-decks/2023-07-17_rptu_summerschool-on-rdm)
-2023-07-11_dataplant_datasteward-circle | [2023-07-11_dataplant_datasteward-circle](slide-decks/2023-07-11_dataplant_datasteward-circle)
-2023-06-28_hhu_arc-club | [2023-06-28_hhu_arc-club](slide-decks/2023-06-28_hhu_arc-club)
-2023-05-09_dataplant_teaching-materials-concept | [2023-05-09_dataplant_teaching-materials-concept](slide-decks/2023-05-09_dataplant_teaching-materials-concept)
-2023-05-09_ceplas_startyourarc-series | [2023-05-09_ceplas_startyourarc-series](slide-decks/2023-05-09_ceplas_startyourarc-series)
-2023-04-27_dataplant_mbs-onboarding | [2023-04-27_dataplant_mbs-onboarding](slide-decks/2023-04-27_dataplant_mbs-onboarding)
+# DataPLANT Knowledge Base
+
+[![CC BY 4.0][cc-by-shield]][cc-by]
+
+Welcome to the [DataPLANT knowledge base](https://nfdi4plants.org/nfdi4plants.knowledgebase/index.html)! 👋
+
+This knowledge base combines articles on
+- **fundamental** topics on research data management (RDM) and
+- how **DataPLANT implements** these aspects to support plant researchers with RDM tools and services.
+
+## Feedback & Contribution
+
+The DataPLANT knowledge base is a community effort and improves with every feedback we receive from readers and users.
+**Your contribution is highly appreciated** no matter how little it may seem!
+
+If you just want to ask a question, recommend missing topics or tutorials, raise awareness for inconsistencies, typos, missing links, errors in training materials or tutorials, feel free to
+
+- submit a ticket to our [helpdesk](https://helpdesk.nfdi4plants.org/?topic=Documentation_KnowledgeBase),
+- [open an issue](https://github.com/nfdi4plants/nfdi4plants.knowledgebase/issues/new/) at GitHub or
+- write us an <a href="javascript:location='mailto:\u0069\u006e\u0066\u006f\u0040\u006e\u0066\u0064\u0069\u0034\u0070\u006c\u0061\u006e\u0074\u0073\u002e\u006f\u0072\u0067';void 0">email</a>.
+
+For all other contributions, please refer to the [contribution guide](https://nfdi4plants.org/nfdi4plants.knowledgebase/docs/CONTRIBUTING.html).
+
+## License
+
+This work is licensed under a
+[Creative Commons Attribution 4.0 International License][cc-by].
+
+[![CC BY 4.0][cc-by-image]][cc-by]
+
+[cc-by]: http://creativecommons.org/licenses/by/4.0/
+[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
+[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg