magento/devdocs#5249: Markdown linting: Spaces after list markers (MD030). Part 01

[atwixfirster]

Purpose of this pull request

This pull request provides changes regarding Markdown linting: Spaces after list markers (MD030) rule in the folder: _includes.

Part 01

Affected DevDocs pages

• ...

Links to Magento source code

• ...

[devops-devdocs]

An admin must run tests on this PR before it can be merged.

[jeff-matthews]

I neglected to add the proper rule syntax in the description for #5249. We are not using the default 1 space configuration. We're using the following custom configuration:

rule 'MD030', :ul_single => 2, :ol_single => 1, :ul_multi => 2, :ol_multi => 1 

Sorry about that @atwixfirster. You'll either need to update your PR or close and start over.

[atwixfirster]

Sorry about that @atwixfirster. You'll either need to update your PR or close and start over.

fixed

@jeff-matthews , could you please review?

Thank you!

[jeff-matthews]

It looks like you removed spaces entirely in some cases, which is incorrect.

• Unordered lists require two spaces after the list marker.
• Ordered lists require one space after the list marker.

Don't forget to run tests locally after making changes to verify you fixed all errors in a particular file.

[atwixfirster]

Don't forget to run tests locally after making changes to verify you fixed all errors in a particular file.

I ran tests after changes that I've made.

It looks like you removed spaces entirely in some cases, which is incorrect.
I am rechecking this point.

Thanks, @jeff-matthews

[atwixfirster]

@jeff-matthews , could you please verify now.

Many thanks as always :)

[jeff-matthews]

Looks great @atwixfirster!

Try to resist the urge to change note classes in future PRs ;)

[ghost]

Hi @atwixfirster, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

[atwixfirster]

Try to resist the urge to change note classes in future PRs ;)

@jeff-matthews , you are the BOSS here but I want to inform you what regarding to Dmitry Shevtsov notice in #4908 we should use a short format for note classes.

Thank you!

[jeff-matthews]

Yes of course. That's true, but per issue description in #5249, you should limit scope to resolving MD030 errors only. It'll make PR reviews faster and easier.

[atwixfirster]

Yes of course. That's true, but per issue description in #5249, you should limit scope to resolving MD030 errors only. It'll make PR reviews faster and easier.

sure, BOSS

Thank you!

[jeff-matthews]

@atwixfirster,

It appears that I made a mistake when planning the initiative for #5249. I failed to take into account how many PRs would be associated with this effort. Awarding a Special achievement label (30 points) for each of the 26 PRs that you created creates imbalance in the community and is contrary to the spirit and intent of the rewards program.

I apologize for the mistake, but I'm going to have to award you a single Special achievement label for all the PRs that you created related to this issue. The remaining will receive the Editorial label.

I'm reviewing all other MD linting issues and PRs to apply the same standard to other contributors. See #5720.

Thank you for your all of your contributions to devdocs. We truly appreciate it.

[atwixfirster]

Awarding a Special achievement label (30 points) for each of the 26 PRs that you created creates imbalance in the community and is contrary to the spirit and intent of the rewards program.

I am totally agreed with this point.

The remaining will receive the Editorial label.

Agreed

but ...

I apologize for the mistake,

your apologies are not accepted because of

Thanks, @jeff-matthews

[jeff-matthews]

@atwixfirster,

I'm not denying that I made that announcement. I consider that announcement the mistake. I am taking responsibility.

[atwixfirster]

I'm not denying that I made that announcement. I consider that announcement the mistake. I am taking responsibility.

Thank you @jeff-matthews !

Anyway that was a good chance to increase contributors points. ;)