Verify/markdown

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,9 +2,9 @@
 name: Bug Report
 about: Report a bug
 labels: kind/bug
-
 ---
 
+<!-- markdownlint-disable MD041 -->
 **What happened**:
 
 **What you expected to happen**:

.github/ISSUE_TEMPLATE/enhancement_request.md

@@ -2,9 +2,9 @@
 name: Enhancement Request
 about: Suggest an enhancement
 labels: kind/enhancement
-
 ---
 
+<!-- markdownlint-disable MD041 -->
 **What would you like to be added**:
 
 **Why is this needed**:

.github/ISSUE_TEMPLATE/epic.md

@@ -2,8 +2,8 @@
 name: Epic
 about: Create a new Epic
 labels: kind/epic
-
 ---
 
+<!-- markdownlint-disable MD041 -->
 **Description**
 This is a short text that just acts as an example for your epic. Please be as precise and verbose as required, so that people understand what larger picture the epic should frame.

.github/ISSUE_TEMPLATE/user_story.md

@@ -1,10 +1,8 @@
 ---
 name: User Story
 about: User Story
-labels: 
+labels:
 title: <User Story> - Title
-
-
 ---
 
 **User Story**: The expressive title of your user story goes here
@@ -15,13 +13,15 @@ As a [type of user], I want to [perform some task] so that I can [achieve some g
 This is a short text that just acts as an example for your user story. Please be as precise and verbose as required, so that people picking up the user story are clear about the intention and their tasks.
 
 **Epic link**:
-- #410 (just mention the number of the related epic here, it will appear as clickable link later)  
+
+- #410 (just mention the number of the related epic here, it will appear as clickable link later)
 
 **Acceptance criteria**:
 
-- [ ] abc should have a red button in the center of the screen 
+- [ ] abc should have a red button in the center of the screen
 - [ ] on clicking the red button it should start to blink
 
 **Related issues**:
-- #413 (just mention the number of the related issue here, it will appear as clickable link later)  
-- #414 (just mention the number of the related issue here, it will appear as clickable link later)  
+
+- #413 (just mention the number of the related issue here, it will appear as clickable link later)
+- #414 (just mention the number of the related issue here, it will appear as clickable link later)

.github/config/markdown-link-check.json

@@ -0,0 +1,9 @@
+{ "replacementPatterns": [
+     { "pattern": "^/", "replacement": "{{BASEURL}}/" }
+  ],
+  "ignorePatterns": [
+     { "pattern": "^http[s]*://localhost.*" }
+    ,{ "pattern": "^https://.*\\.sigstore\\.dev.*" }
+    ,{ "pattern": "^{{.*}}$" }
+  ]
+}

.github/config/markdownignore

@@ -0,0 +1,3 @@
+examples/lib/tour/0*
+docs/reference
+docs/pluginreference

.github/config/markdownlint.yml

@@ -0,0 +1,6 @@
+default: true
+
+MD013: false #Line length - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013
+MD033: false #Inline HTML - https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033
+MD024:
+  siblings_only: true #Multiple headers with the same content

.github/workflows/mend.config → .github/config/mend.config

@@ -50,7 +50,7 @@ resolveAllDependencies=false
 #For any other dependency manager, this value is set to true.
 
 go.resolveDependencies=true
-#defaut value for ignoreSourceFiles  is set to false
+#default value for ignoreSourceFiles is set to false
 # ignoreSourceFiles parameter is important and need to be true
 # To scan source files, we need to disable it.
 go.ignoreSourceFiles=false

.github/config/spellcheck.yml

@@ -0,0 +1,22 @@
+matrix:
+  - name: Markdown
+    aspell:
+      lang: en
+      ignore-case: true
+      mode: markdown
+    dictionary:
+      wordlists:
+        - .github/config/wordlist.txt
+      encoding: utf-8
+    pipeline:
+      - pyspelling.filters.markdown:
+          markdown_extensions:
+            - pymdownx.superfences
+      - pyspelling.filters.html:
+          comments: false
+          ignores:
+            - code
+            - pre
+    sources:
+      - '**/*.md'
+    default_encoding: utf-8