Docs linter on Documentation Markdown files only (#456)

* docs linter only on markdown files

* add gh runner top level permissions

* test docs linter within docs

* cleanup

* linter works so do as it says

* test if ignore files works

* cleanup

.github/workflows/markdown.yaml

@@ -2,24 +2,26 @@ name: "Docs: Markdown lint"
 
 on: [push, pull_request]
 
+permissions:
+  contents: read
+
 jobs:
   markdown-lint:
     runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - uses: tj-actions/changed-files@v44
-      id: changed-files
-      with:
-        files: |
-          docs/src/snap/**
-          docs/src/charm/**
-    - uses: DavidAnson/markdownlint-cli2-action@v16
-      if: steps.changed-files.outputs.any_changed == 'true'
-      with:
-        config: 'docs/src/.markdownlint.json'
-        globs: ${{ steps.changed-files.outputs.all_changed_files }}
-        separator: ","
-
-
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: tj-actions/changed-files@v44
+        id: changed-markdown-files
+        with:
+          files: |
+            docs/**/*.md
+          files_ignore: |
+            docs/src/_parts/**
+      - uses: DavidAnson/markdownlint-cli2-action@v16
+        if: steps.changed-markdown-files.outputs.any_changed == 'true'
+        with:
+          config: "docs/src/.markdownlint.json"
+          globs: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
+          separator: ","

docs/src/snap/explanation/about.md

@@ -16,7 +16,8 @@ maintain and easy to upgrade.
 
 ## What else comes with it?
 
-In addition to the upstream Kubernetes services, Canonical Kubernetes also includes:
+In addition to the upstream Kubernetes services, 
+Canonical Kubernetes also includes:
 
 - a DNS service for the node
 - a CNI for the node/cluster
@@ -30,7 +31,8 @@ In addition to the upstream Kubernetes services, Canonical Kubernetes also inclu
 
 The Canonical Kubernetes snap can be installed on a Linux OS, wherever it may
 be: run it in several local containers or VMs for example, or use it on
-public/private cloud instances. For deploying with [Juju], a machine [charm] to deploy
+public/private cloud instances. 
+For deploying with [Juju], a machine [charm] to deploy
 the snap is also available.
 
 ## Can I use it to make a cluster?