Fix spelling issues

microsoft · Aug 12, 2024 · 972c8c8 · 972c8c8
1 parent 76fd49a
commit 972c8c8
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml
@@ -29,7 +29,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Install npm dependencies
-        run: npm install -g markdown-link-check textlint textlint-rule-spelling dictionary-en
+        run: npm install -g markdown-link-check textlint textlint-rule-spelling dictionary-en textlint-filter-rule-comments
 
       - name: Markdown link check
         shell: pwsh

diff --git a/.textlintrc.json b/.textlintrc.json
@@ -1,6 +1,8 @@
 {
   "plugins": {},
-  "filters": {},
+  "filters": {
+    "comments": true
+  },
   "rules": {
     "spelling": {
       "language": "en",
@@ -37,7 +39,6 @@
         "ThreadJob",
         "/unregisters/gi",
         "WinCNIPlugin",
-
         // Parameter names
         "DownloadPath",
         "InstallPath",

diff --git a/README.md b/README.md
@@ -151,7 +151,9 @@ This project builds on the work of others to create a PowerShell module.
 
 Credits (in alphabetic order):
 
-| Repo/ Author                       | Link                                                                                                                                                                          |
+<!-- textlint-disable -->
+
+| Author/Repository                  | Link                                                                                                                                                                          |
 |------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Anthony Nandaa (@profnandaa)       | [cni-setup-legacy.ps1](https://gist.github.com/profnandaa/33d65d85964181a42539bfd0b4f9561a)                                                                                   |
 | Gabriel Samfira (@gabriel-samfira) | [setup_buildkitd_on_windows.ps1](https://gist.github.com/gabriel-samfira/6e56238ad11c24f490ac109bdd378471)                                                                    |
@@ -162,6 +164,8 @@ Credits (in alphabetic order):
 | microsoft/Windows-Containers       | [install-containerd-runtime.ps1](https://github.com/microsoft/Windows-Containers/blob/Main/helpful_tools/Install-ContainerdRuntime/install-containerd-runtime.ps1)            |
 | Mirantis                           | [Install MCR on Windows Servers](https://docs.mirantis.com/mcr/20.10/install/mcr-windows.html)                                                                                |
 
+<!-- textlint-enable -->
+
 ## Container tools installed with this module
 
 - [Containerd](https://github.com/containerd/containerd)

diff --git a/docs/FAQs.md b/docs/FAQs.md
@@ -2,9 +2,8 @@
 
 ## Table of Contents
 
-- [Uninstall Error (Access to path denied)](#resolving-uninstall-error-access-to-path-denied)
 - [`Import-Module` issues](#import-module-issues)
-- [Uninstallation issues](#uninstallation-issues)
+- [Tool uninstall issues](#tool-uninstall-issues)
 - [`Initialize-NatNetwork` issues](#initialize-natnetwork-issues)
 
 ## `Import-Module` issues
@@ -13,7 +12,7 @@
 - [Error when running Import-Module](https://vnote42.net/2019/07/30/error-when-running-import-module/)
 - [Unblock a script to run it without changing the execution policy](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.4#example-7-unblock-a-script-to-run-it-without-changing-the-execution-policy)
 
-## Uninstallation issues
+## Tool uninstall issues
 
 <!-- 
 #####################################################################