Merge remote-tracking branch 'origin/main'

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: ci
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Sozialhelden e.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

0. Vorwort und Überblick.md → docs/index.md

@@ -1,3 +1,5 @@
+# Vorwort und Überblick
+
 Citizen Scientists forschen.
 
 Diese einfache Feststellung fasst viele Diskurse, Kontroversen, unterschiedliche Begriffsverständnisse und langjährige Forschungsergebnisse zusammen. Es sind nicht nur berufliche Wissenschaftler\*innen, die forschen, sondern unsere Gesellschaft vertraut auf wichtige Forschungsergebnisse von Bürger\*innen, Betroffenen und Engagierten. Das sind oft nicht beruflich oder nur nebenberuflich und meist nicht bezahlte Forschende mit oft sehr tief greifender Expertise. Diese Menschen repräsentieren die Themen, die sie bewegen, und sind ein Spiegel unserer Gesellschaft. Dazu gehört auch, dass Menschen mit Behinderungen mitforschen. Darum haben wir uns entschieden, in diesem Dokument bewusst alle Menschen anzusprechen. Das wollen wir unter anderem mit der Formulierung „Citizen Scientists” deutlich machen.

mkdocs.yml

@@ -0,0 +1,169 @@
+# Copyright (c) 2016-2020 Martin Donath <[email protected]>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+# Project information
+site_name: Instrumentenkoffer für inklusive Citizen Science
+site_url: https://sozialhelden.github.io/incluscience-toolkit
+site_author: Sozialhelden e.V.
+site_description: >-
+  Ein Toolkit für inklusive Citizen Science-Projekte. Checklisten, Methoden und Tools für die Planung und Durchführung von Citizen Science-Projekten, die für alle Menschen zugänglich sind.
+
+# Repository
+repo_name: sozialhelden/incluscience-toolkit
+repo_url: https://github.com/sozialhelden/incluscience-toolkit
+# edit_uri: https://github.com/sozialhelden/k8s/edit/master/docs/
+
+# Copyright
+copyright: Copyright &copy; 2018-2024 Sozialhelden e.V.
+
+# Configuration
+theme:
+  name: material
+
+  # 404 page
+  static_templates:
+    - 404.html
+
+  # Don't include MkDocs' JavaScript
+  include_search_page: false
+  search_index_only: true
+
+  # Default values, taken from mkdocs_theme.yml
+  language: de
+  features:
+    # - tabs
+    - instant
+    - content.code.annotate
+
+  palette:
+    scheme: default
+    primary: deep purple
+    accent: deep purple grey
+
+  font:
+    text: Inter
+    code: Source Code Pro
+  icon:
+    logo: logo
+  logo: images/logo-white.svg
+  favicon: assets/logo-dark.png
+  custom_dir: overrides
+
+# Plugins
+plugins:
+  - search
+  # - minify:
+  #     minify_html: true
+
+# Customization
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/sozialhelden/incluscience-toolkit
+    # - icon: fontawesome/brands/gitter
+    #   link: https://gitter.im/squidfunk/mkdocs-material
+    # - icon: fontawesome/brands/docker
+    #   link: https://hub.docker.com/r/squidfunk/mkdocs-material/
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/sozialhelden
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/sozialhelden/
+    - icon: fontawesome/brands/instagram
+      link: https://instagram.com/sozialhelden
+
+  annotate:
+    json: [.s2]
+
+# TODO:
+#      <meta property="og:title" content="A11yJSON" />
+#      <meta property="og:site_name" content="A11yJSON" />
+#      <meta property="og:url" content="https://sozialhelden.github.io/a11yjson/index.html" />
+#      <meta property="og:description" content="A harmonized data schema for describing the accessibility of physical places." />
+#      <meta property="og:type" content="website" />
+#      <meta property="og:image" content="https://raw.githubusercontent.com/sozialhelden/a11yjson/master/A11yJSON%20GitHub%20share%20pic.png" />
+#
+#      <meta name="twitter:card" content="summary_large_image" />
+#      <meta name="twitter:site" content="@sozialhelden" />
+#      <meta name="twitter:creator" content="@sozialhelden" />
+#      <meta name="twitter:title" content="A11yJSON" />
+#      <meta name="twitter:description" content="A harmonized data schema for describing the accessibility of physical places." />
+#      <meta name="twitter:image" content="https://raw.githubusercontent.com/sozialhelden/a11yjson/master/A11yJSON%20GitHub%20share%20pic.png" />
+
+
+# Extensions
+markdown_extensions:
+  - markdown.extensions.admonition
+  - markdown.extensions.attr_list
+  - markdown.extensions.codehilite:
+      guess_lang: false
+  - markdown.extensions.def_list
+  - markdown.extensions.footnotes
+  - markdown.extensions.meta
+  - markdown.extensions.toc:
+      permalink: true
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: squidfunk
+      repo: mkdocs-material
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.superfences
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+# nav:
+#   - Home: index.md
+#   - Dashboards: dashboards.md
+#   - Cluster setup: cluster-setup.md
+#   - Development processes: dev-process.md
+#   - Culture: dev-culture.md
+#   - Ideas: ideas.md
+
+
+
+# Google Analytics
+# google_analytics:
+#   - !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
+#   - auto

overrides/main.html

@@ -0,0 +1,37 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+
+<meta property="og:url" content="{{ page.canonical_url }}">
+{% if page and page.meta and page.meta.title %}
+  <meta property="og:title" content="{{ page.meta.title }}">
+{% elif page and page.title and not page.is_homepage %}
+  <meta property="og:title" content="{{ page.title }} - {{ config.site_name }}">
+{% else %}
+  <meta property="og:title" content="{{ config.site_name }}">
+{% endif %}
+<meta property="og:description" content="{{ config.site_description }}">
+<meta property="og:type" content="website">
+<meta property="og:image" content="https://repository-images.githubusercontent.com/111114163/180dae00-0b8f-11ea-9470-49871d14b7b9">
+<meta property="og:image:alt" content="Logo of IncluScience, referencing its creator Sozialhelden e.V.">
+<meta property="og:image:type" content="image/jpeg">
+<meta property="og:image:width" content="1280">
+<meta property="og:image:height" content="640">
+
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:site" content="@sozialhelden">
+<meta name="twitter:creator" content="@sozialhelden">
+{% if page and page.meta and page.meta.title %}
+  <meta property="twitter:title" content="{{ page.meta.title }}">
+{% elif page and page.title and not page.is_homepage %}
+  <meta property="twitter:title" content="{{ page.title }} - {{ config.site_name }}">
+{% else %}
+  <meta property="twitter:title" content="{{ config.site_name }}">
+{% endif %}
+<meta name="twitter:description" content="{{ config.site_description }}">
+<meta name="twitter:image" content="https://repository-images.githubusercontent.com/111114163/180dae00-0b8f-11ea-9470-49871d14b7b9">
+<meta name="twitter:image:alt" content="Logo of IncluScience, referencing its creator Sozialhelden e.V.">
+
+<link href="https://github.com/sozialhelden/incluscience/commits/master.atom" rel="alternate" title="Recent Commits to incluscience:master" type="application/atom+xml">
+<link href="https://github.com/sozialhelden/incluscience" rel="alternate" title="IncluScience GitHub repository" type="text/html">
+{% endblock %}