Merge tests into single job

.github/workflows/actions.yml

@@ -0,0 +1,50 @@
+name: Build test and quality checks
+on: push
+jobs:
+  Actions:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Clone DietPi-Docs repository
+        id: clone
+        uses: actions/checkout@v2
+      - name: Check Markdown syntax
+        # .markdownlintrc: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+        uses: nosborn/github-action-markdown-cli@v1.1.1
+        with:
+          files: "*.md **/*.md"
+      - name: Set up Python 3.7
+        id: python_setup
+        if: always() && steps.clone.outcome == 'success'
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+      - name: Install Python dependencies
+        id: python_deps
+        if: always() && steps.python_setup.outcome == 'success'
+        run: |
+          python3 -m pip install -U pip wheel setuptools
+          pip3 install -r requirements.txt
+      - name: Configure MkDocs
+        id: mkdocs_config
+        if: always() && steps.python_deps.outcome == 'success'
+        run: |
+          sed -i "/repo_url/c\repo_url: https://github.com/$GITHUB_REPOSITORY" mkdocs.yml
+          sed -i "/edit_uri/c\edit_uri: edit/${GITHUB_REF#refs/heads}/docs/" mkdocs.yml
+      - name: Build DietPi-Docs
+        id: build
+        if: always() && steps.mkdocs_config.outcome == 'success'
+        run: mkdocs build -sd build/docs
+      - name: Check links in HTML files
+        id: check_links
+        if: always() && steps.build.outcome == 'success'
+        uses: peter-evans/link-checker@v1
+        with:
+          args: -c 1 -d build -r README.md build/docs
+      - name: Check link check result
+        if: always() && steps.check_links.outcome == 'success'
+        run: exit ${{ steps.check_links.outputs.exit_code }}
+      - name: Check spelling in HTML files
+        if: always() && steps.build.outcome == 'success'
+        # .spellcheck.yml: https://github.com/marketplace/actions/github-spellcheck-action#spellcheck-configuration-file
+        # .wordlist.txt
+        uses: rojopolis/spellcheck-github-actions@0.5.0

.spellcheck.yaml → .spellcheck.yml

@@ -1,18 +1,20 @@
 matrix:
-- name: Markdown
+- name: HTML
   aspell:
     lang: en
   dictionary:
     wordlists:
     - .wordlist.txt
     encoding: utf-8
   pipeline:
-  - pyspelling.filters.markdown:
   - pyspelling.filters.html:
-    comments: false
+    attributes:
+    - title
+    - alt
     ignores:
     - code
     - pre
+  - pyspelling.filters.url:
   sources:
-  - '**/*.md'
+  - 'build/docs/**/*.html'
   default_encoding: utf-8

.wordlist.txt

@@ -35,7 +35,7 @@ CSM
 Cuberite
 DarkBetter
 DarkIce
-dietpi
+DietPi
 DIY
 DLNA
 DNS
@@ -68,7 +68,6 @@ Grafana
 HAProxy
 Hardkernel
 HTPC
-http
 HTTPS
 IceCast
 ICMP
@@ -110,7 +109,7 @@ Minecraft
 MineOS
 MiniDLNA
 Minio
-mkdocs
+MkDocs
 Mopidy
 Mosquitto
 MotionEye

README.md

@@ -1,9 +1,7 @@
-Official Website: [dietpi.com](https://dietpi.com/)
-
 # DietPi Documentation
 
-The source for DietPi documentation [dietpi.com/docs](https://dietpi.com/docs/) is in this directory.
-The documentation uses extended Markdown, as implemented by [MkDocs](https://www.mkdocs.org/).
+This is the source code repository for the [DietPi documentation website](https://dietpi.com/docs/).
+It uses extended Markdown, as implemented by [MkDocs](https://www.mkdocs.org/).
 
 [![CodeFactor](https://www.codefactor.io/repository/github/michaing/dietpi-docs/badge)](https://www.codefactor.io/repository/github/michaing/dietpi-docs)
 
@@ -12,7 +10,7 @@ The documentation uses extended Markdown, as implemented by [MkDocs](https://www
 - Install dependencies: `pip3 install -r requirements.txt`
 - From the root directory, run: `mkdocs serve`
 
-It builds the static `site` and starts a local webserver: [http://localhost:8000](http://localhost:8000). If you have troubles accessing the MkDocs website, you could also listen on a specific IP address or all IP addresses, e.g. `mkdocs serve -a 0.0.0.0:8000`.    
+It builds the static HTML pages into the `site` directory and starts a local web server at <http://localhost:8000>. If you have troubles accessing the MkDocs website, you could also listen on a specific IP address or all IP addresses, e.g. `mkdocs serve -a 0.0.0.0:8000`.    
 
 ## License
 <a rel="cc:attributionURL" property="dct:title" href="https://dietpi.com/docs/">DietPi-Docs</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://dietpi.com/">DietPi</a> is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License - <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>.
@@ -21,21 +19,21 @@ It builds the static `site` and starts a local webserver: [http://localhost:8000
 
 ## Contributing
 
-There are many ways in which you can participate in the project, for example:
+There are many ways in which you can participate in this project, for example:
 
-* Review [DietPi Documentation](https://dietpi.com/docs/) and make pull requests for anything from typos to new content.
-* [Submit problems and things to investigate](https://github.com/MichaIng/DietPi/issues), and help us verify as they are checked in.
-* Improve / Add more features to [DietPi website](https://dietpi.com/)?
+* Review the [DietPi documentation website](https://dietpi.com/docs/) and make pull requests for anything from typos to new content.
+* Submit issues or ideas via [GitHub issue](https://github.com/MichaIng/DietPi-Docs/issues), and help us verify as they are checked in.
+* You may also review the [DietPi main website](https://dietpi.com/) and contribute on its [repository](https://github.com/MichaIng/DietPi-Website).
 
 ## Feedback
 
-* Ask a question on [DietPi Forum](https://dietpi.com/phpbb/)
-* [Request a new feature or upvote popular feature requests](https://feathub.com/MichaIng/DietPi)
-* [File an issue](https://github.com/MichaIng/DietPi/issues)
+* Ask a question on our [forum](https://dietpi.com/phpbb/).
+* [Request a new feature or vote for popular feature requests](https://feathub.com/MichaIng/DietPi)
+* [File an issue](https://github.com/MichaIng/DietPi-Docs/issues)
 * Follow [@DietPi_](https://twitter.com/DietPi_) and let us know what you think!
 
 ### GitHub Projects
 
-- DietPi: https://github.com/MichaIng/DietPi
-- Documentation: https://github.com/MichaIng/DietPi-Docs
-- Website: https://github.com/MichaIng/DietPi-Website
+- DietPi: <https://github.com/MichaIng/DietPi>
+- Documentation: <https://github.com/MichaIng/DietPi-Docs>
+- Website: <https://github.com/MichaIng/DietPi-Website>