Merge branch 'main' into first_guide

Author: unfokus

.editorconfig

@@ -0,0 +1,21 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{md,txt}]
+indent_style = space
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+
+[CNAME]
+insert_final_newline = false

.github/workflows/ci.yml

@@ -20,21 +20,7 @@ jobs:
       - run: pip install mkdocs-material
       - run: mkdocs build
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          path: ./site/
-  deploy:
-    if: github.event.repository.fork == false
-    needs: build
-    permissions:
-      pages: write
-      id-token: write
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v1
-
+          folder: site
+          clean-exclude: pr-preview/

.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+name: Lint
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+permissions:
+  contents: read
+
+jobs:
+  editorconfig:
+    name: Editorconfig
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: editorconfig-checker/action-editorconfig-checker@v2
+      - run: editorconfig-checker

.github/workflows/preview.yml

@@ -0,0 +1,26 @@
+name: Deploy PR previews
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin
+      - run: mkdocs build
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./site/

LICENSE.md

@@ -23,3 +23,7 @@ On other systems you can use pip to install the dependencies:
 pip3 install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
 ```
 Then you can use `mkdocs serve` to start a local development server that updates the content automatically.
+
+# License
+
+Content is available under the [Creative Commons Attribution License 4.0](https://raw.githubusercontent.com/denog/routing-guide/main/LICENSE.md), unless otherwise stated

README.md

@@ -1,16 +1,25 @@
 site_name: DENOG Routing Guide
+repo_url: https://github.com/denog/routing-guide
+edit_uri: edit/main/docs/
 extra_css:
   - stylesheets/extra.css
 theme:
   name: material
   font: false
+  features:
+    - content.action.edit
+    - content.action.view
+    - content.code.copy
+  icon:
+    edit: material/pencil
+    view: material/eye
   palette:
     # Palette toggle for light mode
     - scheme: default
       primary: 'yellow'
       accent: 'yellow'
       toggle:
-        icon: material/brightness-7 
+        icon: material/brightness-7
         name: Switch to dark mode
     # Palette toggle for dark mode
     - scheme: slate
@@ -19,9 +28,6 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
-  features:
-    - content.code.copy
-copyright: Copyright &copy; DENOG e.V. <br/><a href="https://www.denog.de/de/impressum.html">Imprint</a>
 markdown_extensions:
   #- pymdownx.emoji
     #emoji_index: !!python/name:material.extensions.emoji.twemoji
@@ -45,3 +51,4 @@ plugins:
 extra:
   status:
     <identifier>: <description>
+copyright: Licensed under the <a href="https://raw.githubusercontent.com/denog/routing-guide/main/LICENSE.md">Creative Commons Attribution License 4.0</a>, unless otherwise stated | <a href="https://www.denog.de/de/impressum.html">Imprint</a>