Problem with markdown lint errors MD013 and MD024 about dscresource.tests HOT 7 CLOSED

I would prefer that both MD013 and MD024 were disabled. They should be disabled in this central repo, but with the option 2 to overwrite them if necessary.

from dscresource.tests.

I made this test a warning only with #102 due to multiple issues of this type until this can be resolved.

I like option 2 as well.

from dscresource.tests.

I'm also having issues getting MD002 and MD041 fixed.
dsccommunity/xWindowsUpdate#41 (comment)

C:\projects\xwindowsupdate\README.md: 17: MD002 First header should be a top level header
C:\projects\xwindowsupdate\README.md: 1: MD041 First line in file should be a top level header

but line 1 is a top level header and 17 isn't the first header.

Option 2 would allow me to disable these rules, but feel free to take a look and see what I did wrong in the markdown.

from dscresource.tests.

I'd go with Option 2 as well. Although like the PSSA rules it might be worth limiting the rules that can be suppressed.

Although because VSCode automatically underlines in red all MD violations regardless of any "suppression" we might add, it is sort of hard to identify violations of the other rules. So IMHO it is a better idea to solve all rule violations

Once you move over to (assuming you are planning to) automatic documentation generation (like SharePointDsc) then the MD violations stop existing because each of these "sections" gets moved into their own file. However the long lines should still be solved I reckon. My 2c!

from dscresource.tests.

@kwirkykat - as long as we can enable these rules on a repo basis, I'm ok with that - because we've put quite a bit of time making sure MD013 and MD024 are met on xNetworking, xStorage etc so we'd want to be able to keep enforcing this rule.

from dscresource.tests.

MD024 seems to be handle better by GitHub now. Saw that the other day. GitHub seems to have started to handle them by adding a number after each header that are similar. I haven't seen this before, but might have missed it.

Example in the README.md of the PSDscResources, for the Parameters header.

First: https://github.com/PowerShell/PSDscResources#parameters
Second: https://github.com/PowerShell/PSDscResources#parameters-1
Third: https://github.com/PowerShell/PSDscResources#parameters-2

Just noting it here that overriding MD024 wouldn't be a problem.

When MD024 is disabled in the common tests, then I could just fix MD013 (in progress) in xSQLServer and opt-in for all the common tests, then this issue would be a non-issue for xSQLServer at least.

But we need to add the functionality to enable MD024 for those repos that still like to enforce it.

I can put some time on this and send in a proposed PR for this issue.

from dscresource.tests.

I sent in a PR for this in PR #146.

from dscresource.tests.