Enable markdownlint plugin (#2)

* Add markdown lint support so editor and CI are aligned.
* Update markdown linter and improve markdown files to pass

.markdownlint.yaml

@@ -0,0 +1,14 @@
+## @file
+# markdownlint configuration
+#
+# Copyright (c) Microsoft Corporation
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+# Rules can be found here: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+# Config info: https://github.com/DavidAnson/markdownlint#configuration
+{
+  "default": true,
+  "MD013": {"line_length": 120, "code_blocks": false, "tables": false},
+  "MD033": {"allowed_elements": ["br", "center", "img"]}
+}

.markdownlintignore

@@ -0,0 +1,9 @@
+# Ignore build directory
+/Build/
+
+# Ignore external dependencies
+*_extdep/
+
+# Ignore submdules
+/Common
+/MU_BASECORE

CODE_OF_CONDUCT.md

@@ -6,4 +6,4 @@ Resources:
 
 - [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
 - [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
-- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

Platforms/OvmfPkg/PlatformCI/ReadMe.md

@@ -124,8 +124,8 @@ an error occurs. Locally you don't need to set this.
 
 ### Passing Build Defines
 
-To pass build defines through _stuart_build_, prepend `BLD_*_`to the define name and pass it on the
-command-line. _stuart_build_ currently requires values to be assigned, so add an`=1` suffix for bare defines.
+To pass build defines through _stuart_build_, prepend `BLD_*_` to the define name and pass it on the
+command-line.  *stuart_build* currently requires values to be assigned, so add an`=1` suffix for bare defines.
 For example, to enable the TPM2 support, instead of the traditional "-D E1000_ENABLE", the stuart_build
 command-line would be:
 

Platforms/QemuQ35Pkg/Docs/building.md

@@ -16,7 +16,7 @@ with VS2019 and Ubuntu 18.04 with GCC5 toolchain.
 This build uses edk2-pytools for functionality.  Documentation can be
 found [here](https://github.com/tianocore/edk2-pytool-extensions/tree/master/docs).
 On most Linux distros this requires an extra step for mono and nuget support.
-https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/usability/using_extdep.md#a-note-on-nuget-on-linux
+<https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/usability/using_extdep.md#a-note-on-nuget-on-linux>
 
 ## Building with Pytools
 
@@ -51,7 +51,8 @@ https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/usability/u
     stuart_setup -c Platforms/QemuQ35Pkg/PlatformBuild.py TOOL_CHAIN_TAG=<TOOL_CHAIN_TAG>
     ```
 
-    - `TOOL_CHAIN_TAG` being the toolchain you want to build with, currently `VS2017`, `VS2019`, and `GCC5` are supported values
+    - `TOOL_CHAIN_TAG` being the toolchain you want to build with, currently `VS2017`, `VS2019`, and `GCC5` are
+      supported values
 
 5. Initialize & Update Dependencies - only as needed when ext_deps change
 
@@ -101,7 +102,8 @@ https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/usability/u
 1. QEMU must be on your path.  On Windows this is a manual process and not part of the QEMU installer.
 2. QEMU output will be in Build/BUILDLOG_QemuQ35Pkg.txt as well as Build/QemuQ35Pkg/QEMULOG_QemuQ35Pkg.txt
 
-**NOTE:** Logging the execution output will be in the normal stuart log as well as to your console (if you have the correct logging level set, by default it doesn't output to console).
+**NOTE:** Logging the execution output will be in the normal stuart log as well as to your console (if you have the
+correct logging level set, by default it doesn't output to console).
 
 ### Custom Build Options
 
@@ -124,4 +126,4 @@ command-line would be:
 ## References
 
 - [Installing and using Pytools](https://github.com/tianocore/edk2-pytool-extensions/blob/master/docs/using.md#installing)
-- More on [python virtual environments](https://docs.python.org/3/library/venv.html)
+- More on [python virtual environments](https://docs.python.org/3/library/venv.html)

Platforms/QemuQ35Pkg/Docs/feature_dfci.md

@@ -1,3 +1,3 @@
 # Device Firmware Configuration Interface (DFCI)
 
-Todo
+Todo

Platforms/QemuQ35Pkg/Docs/feature_frontpage.md

@@ -2,4 +2,4 @@
 
 Todo
 
-![Front page in Q35](q35_mu.gif)
+![Front page in Q35](q35_mu.gif)

Platforms/QemuQ35Pkg/Docs/feature_whea.md

@@ -1,3 +1,3 @@
 # Mu Telemetry / WHEA
 
-Todo
+Todo

Platforms/QemuQ35Pkg/ReadMe.md

@@ -22,7 +22,7 @@ Below is a diagram from Qemu.org about the Q35 chipset which emulates a ICH9 (I/
 The advantages of the ICH9 over the I440FX (which is what QEMU often emulates) is that it has PCI-E instead of just PCI
 as well as having an integrated AHCI controller and no ISA bus.
 
-Visit the feature wiki detailing QEMU Q35 for more information: https://wiki.qemu.org/Features/Q35
+Visit the feature wiki detailing QEMU Q35 for more information: <https://wiki.qemu.org/Features/Q35>
 
 ## Firmware Features
 

RepoDetails.md

@@ -37,7 +37,7 @@ Details about the platform and how to build/use each platform can be found in th
 - [Q35 Platform](Platforms/QemuQ35Pkg/ReadMe.md)
 - [Ovmf upstream Platform](Platforms/OvmfPkg/ReadMe.md)
 
-For general details about Project Mu please see the Project Mu docs (https://github.com/Microsoft/mu).
+For general details about Project Mu please see the Project Mu docs (<https://github.com/Microsoft/mu>).
 
 ## Microsoft Open Source Code of Conduct
 
@@ -68,7 +68,7 @@ Please follow the general Project Mu Pull Request process.
 
 Project Mu contributions will be licensed as BSD-2-Clause-Patent and will contain the SPDX-License-Identifier.
 
-```
+```text
 Copyright (C) Microsoft Corporation
 SPDX-License-Identifier: BSD-2-Clause-Patent
 ```

SECURITY.md

@@ -1,34 +1,46 @@
 <!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
 
-## Security
+# Security
 
-Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
+Microsoft takes the security of our software products and services seriously, which includes all source code
+repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft),
+ [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet),
+ [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
 
-If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets
+[Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)),
+please report it to us as described below.
 
 ## Reporting Security Issues
 
 **Please do not report security vulnerabilities through public GitHub issues.**
 
-Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
+Instead, please report them to the Microsoft Security Response Center (MSRC) at
+[https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
 
-If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If
+possible, encrypt your message with our PGP key; please download it from the
+[Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
 
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we
+received your original message. Additional information can be found at
+[microsoft.com/msrc](https://www.microsoft.com/msrc).
 
-Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
+Please include the requested information listed below (as much as you can provide) to help us better understand the
+nature and scope of the possible issue:
 
-  * Type of issue (e.g. buffer overflow, use after free, etc.)
-  * Full paths of source file(s) related to the manifestation of the issue
-  * The location of the affected source code (tag/branch/commit or direct URL)
-  * Any special configuration required to reproduce the issue
-  * Step-by-step instructions to reproduce the issue
-  * Proof-of-concept or exploit code (if possible)
-  * Impact of the issue, including how an attacker might exploit the issue
+* Type of issue (e.g. buffer overflow, use after free, etc.)
+* Full paths of source file(s) related to the manifestation of the issue
+* The location of the affected source code (tag/branch/commit or direct URL)
+* Any special configuration required to reproduce the issue
+* Step-by-step instructions to reproduce the issue
+* Proof-of-concept or exploit code (if possible)
+* Impact of the issue, including how an attacker might exploit the issue
 
 This information will help us triage your report more quickly.
 
-If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit
+our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
 
 ## Preferred Languages
 

docs/BranchReadme_template.md

@@ -22,4 +22,5 @@ Fill in your expected roadmap, what do you hope to accomplish? What still needs
 
 The goal of feature branches in `mu_tiano_platforms` is to showcase a feature and allow for development of that feature.
 Branches shouldn't linger on unnecessarily.
-They exist as proofs of concept and should try to become ready to be merged into a release branch or be archived as a useful learning exercise.
+They exist as proofs of concept and should try to become ready to be merged into a release branch or be archived as a
+useful learning exercise.