Creation of Global Markdown Formatting and Linting GitHub Actions

[damienjburks]

Summary

PSA: It may look like a pretty beefy PR, but it isn't. Most of the added/deleted lines are due to formatting and linting fixes. 😉

I am introducing the GitHub Actions for linting and formatting all Markdown files within the project using markdownlint-cli and prettier. To get this GitHub Action to pass, I had to format and lint each Markdown file. I have also disabled quite a few rules for markdownlint-cli & prettier to conserve the current structure for referencing images and other forms of content.

You can view all of the disabled & enabled rules for markdownlint-cli in .config/.markdownlint-cli.yaml, and prettier in .config/.prettierrc file.

In addition, there is an end-user guide for everyone who uses VS Code on how to install and configure the extensions for easier formatting and linting, which is located here: docs/training/lint_format_user_guide.md

Linked issues

• Create GitHub Actions for Linting and Formatting for Markdown Content #212
• Create Formatting/Linting End-User Guide #210

Supported Links

• Markdown CLI Lint Rules
• Prettier Options

[eddie-knight]

Aside from two changes, this looks good to go.

[damienjburks]

Okay @eddie-knight we should be good to go now. Everything has been resolved and corrected. Also, I did ask @mlysaght2017 if he'd be an additional reviewer for delivery WG for PRs, and he agreed to do so until we get some more folks involved. Are you fine with that?

[eddie-knight]

Absolutely. Please update the GitHub issue when you action that!

[eddie-knight]

@smendis-scottlogic and @mlysaght2017 please review & approve to unlock the merge button on this PR.

To help streamline your approval, I've reviewed all of the files changed and confirmed that there are no impactful changes. Where polish was possible, I have left comments that are all now resolved.

[eddie-knight]

@TheJuanAndOnly99 I'm not sure why this isn't able to be merged, do you have any ideas?

[damienjburks]

@eddie-knight i seems as if I'm able to merge this in. Would you like me to do so?

[eddie-knight]

Yeah! Letsgoooo