From b7b17641d0c17bfa5e1f8c77b9c232da73bbedcd Mon Sep 17 00:00:00 2001
From: John Bampton <jbampton@users.noreply.github.com>
Date: Thu, 6 May 2021 18:52:45 +1000
Subject: [PATCH] Add docs to the markdownlint and yamllint config files
 (#15682)

---
 .markdownlint.yml   | 27 ++++++++++++++-------------
 yamllint-config.yml |  1 +
 2 files changed, 15 insertions(+), 13 deletions(-)

diff --git a/.markdownlint.yml b/.markdownlint.yml
index b30e3d38ae7cb..69793feedb1f1 100644
--- a/.markdownlint.yml
+++ b/.markdownlint.yml
@@ -16,41 +16,42 @@
 # under the License.
 #
 ---
-# MD004/ul-style
+# https://github.com/DavidAnson/markdownlint#rules--aliases
+# MD004 ul-style - Unordered list style
 MD004: false
 
-# MD007/ul-indent
+# MD007 ul-indent - Unordered list indentation
 MD007: false
 
-# MD012/no-multiple-blanks
+# MD012 no-multiple-blanks - Multiple consecutive blank lines
 MD012: false
 
-# MD013 Line length
+# MD013 line-length - Line length
 MD013: false
 
-# MD024/no-duplicate-heading/no-duplicate-header
+# MD024 no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
 MD024: false
 
-# MD026/no-trailing-punctuation
+# MD026 no-trailing-punctuation - Trailing punctuation in heading
 MD026: false
 
-# MD029/ol-prefix
+# MD029 ol-prefix - Ordered list item prefix
 MD029: false
 
-# MD030/list-marker-space
+# MD030 list-marker-space - Spaces after list markers
 MD030: false
 
-# MD033/no-inline-html
+# MD033 no-inline-html - Inline HTML
 MD033: false
 
-# MD034/no-bare-urls
+# MD034 no-bare-urls - Bare URL used
 MD034: false
 
-# MD036/no-emphasis-as-heading/no-emphasis-as-header
+# MD036 no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
 MD036: false
 
-# MD040/fenced-code-language
+# MD040 fenced-code-language - Fenced code blocks should have a language specified
 MD040: false
 
-# MD041/first-line-heading/first-line-h1
+# MD041 first-line-heading/first-line-h1 - First line in a file should be a top-level heading
 MD041: false
diff --git a/yamllint-config.yml b/yamllint-config.yml
index 10fbd3db48f92..a88c0eab9fe16 100644
--- a/yamllint-config.yml
+++ b/yamllint-config.yml
@@ -15,6 +15,7 @@
 # specific language governing permissions and limitations
 # under the License.
 ---
+# https://yamllint.readthedocs.io/en/stable/
 extends: default
 
 rules: