Issue-175 (chore) : Added a linter for the docs

[Abhijay007]

Pull Request Template

Description

Added a linter for the docs

Fixes #175

Type of change

code

Please delete options that are not relevant.

• [x] New feature (non-breaking change which adds functionality)

How Has This Been Tested?

testing in progress

Checklist:

• [x] My code follows the style guidelines of this project
• [x] I have performed a self-review of my own code
• [x] I have checked my code and corrected any misspellings
• [x] I have tagged the reviewers in a comment below incase my pull request is ready for a review
• [x] I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

[johnwalicki]

What options can be tweaked in the my_markdownlint.yml file?

[Abhijay007]

What options can be tweaked in the my_markdownlint.yml file?

I think there are not many options 😅 as it is using the pre-built action but we can exclude and include the files, you can read about this action here : https://github.com/marketplace/actions/my-markdown-linter

[johnwalicki]

There are lots and lots of linter errors caused by

  '''
  sudo some command
  '''
   {: codeblock}


## Header with an anchor
{: #ppc64le-machines}

[Abhijay007]

@johnwalicki, @joewxboy can you please tell me which files to include and exclude from the list, and one more thing I got a mail regarding the invalid YAML syntax in this PR, I re-checked this file couple of times but was not able to find any syntax error in line 11 (as mentioned by the report), can you please look into this too :)

[johnwalicki]

I got a mail regarding the invalid YAML syntax in this PR, I re-checked this file couple of times but was not able to find any syntax error in line 11 (as mentioned by the report), can you please look into this too :)

I pasted the yaml into http://www.yamllint.com/ It reported this error (<unknown>): mapping values are not allowed in this context at line 11 column 12

[joewxboy]

Hearing no objections, I'll close this issue since we appear to not need it anymore. Thanks.