Merge pull request #2 from luepges/main

Github Pages Setup

Author: luepges

.github/workflows/deploy_pages.yml

@@ -0,0 +1,33 @@
+name: Build and update gh pages
+on:
+  push:
+    branches: main
+permissions:
+  contents: write
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v4
+      - 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
+      - name: Build main site
+        run: mkdocs build
+      - name: Build example site
+        run: mkdocs build --site-dir ../site/website_template
+        working-directory: website_template
+      - name: Deploy to gh-pages
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: oprypin/push-to-gh-pages@v3
+        with:
+          publish_dir: site

docs/glossar.md

@@ -0,0 +1,2 @@
+
+TODO

docs/index.md

@@ -0,0 +1,47 @@
+---
+hide:
+    - toc
+    - navigation
+---
+
+# A guidelines and policy template for the development of research software at German research institutions
+### A recommendation by GI, RSE working group and de-RSE
+
+Research Software Engineering (abbreviated: RSE) is the application of software engineering practices to research software,
+i.e., software created for and primarily used in scientific research projects.
+RSE is not High-Performance Computing (HPC), Computational Science Engineering (CSE), Artificial Intelligence, or Data Science.
+It has different goals and a distinct professional profile for Research Software Engineers.
+
+Due to the increased relevance and complexity of research software, efficient and high-quality software development for research software also requires a range of organizational, methodological, and legal measures.
+This results in consequences both for the leadership to provide organizational support and for the individuals involved in software development to adhere to certain methodological guidelines.
+These guidelines were created based on the distilled knowledge (as of 2024) about software development in general (Software Engineering) and research software in particular (Research Software Engineering).
+It is planned to regularly update these guidelines and incorporate new insights.
+
+The authors propose these guidelines as a template to aid universities, colleges, and research institutions in the adaptation of fundamental policies and recommendations for research projects involving research software.
+
+[View Guidelines](https://todo){.md-button}
+
+# Purpose
+
+This guidelines template proposes the establishment of specific guidelines within universities, colleges, and research institutions.
+It aims to provide concrete assistance for defining their own guidelines while allowing for flexibility to accommodate the different cultures in various disciplines and research institutions through explicit variability for refinement.
+
+The guidelines template developed by the GI, the RSE working group, and de-RSE should therefore be used to create an independent document that can ideally be declared binding within one's own university, college, or research institution.
+
+# Contact
+
+For comments and suggestions, please contact the coordination team of the 'Software Guidelines' working group of the RSE section,
+ currently Sebastian Nielebock, Bernhard Rumpe, and Inga Ulusoy, at the email address [email protected].
+We would also appreciate feedback on which university, college, or research center the text is being used and in what form.
+
+# Institutions that have adopted the guidelines
+
+
+
+# RSE-Website template
+
+A template for an institute's RSE website can be found [here](website_template/).
+
+# Glossary
+
+A glossary (currently only available in German) to the terms used in the policy template can be found [here](glossar.md).

mkdocs.yml

@@ -0,0 +1,16 @@
+site_name: RSE-Software Entwicklungs Leitlinien
+site_url: https://gi-ev.github.io/RSE-software-entwicklungs-leitlinien
+theme:
+  name: material
+  features:
+    - navigation.footer
+
+copyright: '© Software Guidelines workin group, CC0 1.0 deed'
+    
+markdown_extensions:
+  - attr_list
+    
+# page tree
+nav:
+  - Home: index.md
+  - Glossary: glossar.md

website_template/README.md

@@ -0,0 +1,5 @@
+# RSE example website template
+
+This directory contains a template for a RSE website.
+It is provided as a collection of Markdown files, built using mkdocs,
+ but the content can be copied into the content management system of your institution.

website_template/docs/index.md

@@ -0,0 +1,3 @@
+# Welcome to the RSE Website Template
+
+TODO

website_template/mkdocs.yml

@@ -0,0 +1,21 @@
+site_name: RSE-Website - Insitut für angewandte Beispiele
+site_url: https://gi-ev.github.io/RSE-software-entwicklungs-leitlinien/website_template
+theme:
+  name: material
+  features:
+    - navigation.top
+    - navigation.footer
+
+copyright: 'Example RSE Website - © Software Guidelines workin group, CC0 1.0 deed'
+    
+markdown_extensions:
+  - attr_list
+
+extra:
+  social:
+    - icon: fontawesome/brands/github 
+      link: https://github.com/gi-ev/RSE-software-entwicklungs-leitlinien
+
+# page tree
+nav:
+  - Home: index.md