Devdocs: Markdown linting: Spaces after list markers (MD030)

[dshevtsov]

Bug report

We're no longer accepting PRS for this issue.

Description

The Markdown linter reports about 11851 issues when the rule 'MD030' is enabled.

Instructions

1. Add a comment to this issue requesting the devdocs-admins to assign the issue to you.
2. Checkout the MD030-integration branch.
3. In the _checks/styles/style-rules-prod change exclude_rule 'MD030' to rule 'MD030', :ul_single => 2, :ol_single => 1, :ul_multi => 2, :ol_multi => 1.
4. In your terminal, run rake test:md.
5. Review the list of errors.
6. Add a comment to this issue claiming a directory that you want to work on (should include both v2.2 and v2.3 directories when applicable).
7. Fix errors.

Test your updates

1. Follow "Steps to reproduce" locally to get list of errors to fix.
2. Preview the HTML locally to ensure your changes did not break formatting in the resulting HTML (run rake:preview). For more information, refer to the README.

Note-->Do NOT use special keywords in your commit message or PR comments.

Expected result

All the reported issues are fixed.
The rake test:md command returns No issues found.

Additional information

• Scope: Limit your changes to resolving only MD030 errors.
• See the Markdown linting issues wiki page for detailed guidelines.

[atwixfirster]

Working on files in _includes directory:

• https://github.com/magento/devdocs/pull/5707
• https://github.com/magento/devdocs/pull/5709

[jeff-matthews]

@atwixfirster, you're going to hate me, but I forgot to update this issue with the proper rule syntax:

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

You'll need to update your PRs accordingly. Sorry.

[drpayyne]

@jeff-matthews Hello, again! Woud love to work on this issue. Please assign this to me too. Will choose a directory now.

[drpayyne]

WIP in directory/file:

• guides/v2.3/ui_comp_guide
• redoc
• release
• system-requirements.md

PRs created:

• #5720

[jeff-matthews]

Welcome to the party @drpayyne!

[eduard13]

Hi @jeff-matthews, I'd also love to join the party 👯‍♂. Could you please assign me to the ticket?
I'l be working on the following folders if you don't mind.

• extensions/
• guides/v2.2/advanced-reporting/
• guides/v2.2/architecture/

PRs:

• #5724
• #5727

[atwixfirster]

Working on files in the next directories:

• guides/v2.2/b2b
• guides/v2.3/b2b

PR: https://github.com/magento/devdocs/pull/5723

[jeff-matthews]

Welcome aboard @eduard13 !

[atwixfirster]

Working on files in the next directories:

• guides/v2.2/cloud
• guides/v2.3/cloud

PRs:

• https://github.com/magento/devdocs/pull/5728
• https://github.com/magento/devdocs/pull/5729
• https://github.com/magento/devdocs/pull/5730
• https://github.com/magento/devdocs/pull/5731
• https://github.com/magento/devdocs/pull/5733

[atwixfirster]

Working on files in the next directories:

• guides/v2.2/coding-standards
• guides/v2.3/coding-standards

PR:

• https://github.com/magento/devdocs/pull/5734

[atwixfirster]

Working on files in the next directories:

• guides/v2.2/comp-mgr
• guides/v2.3/comp-mgr

PR:

• https://github.com/magento/devdocs/pull/5735

[eduard13]

Working on the following directories:

• guides/v2.2/javascript-dev-guide
• guides/v2.3/javascript-dev-guide

PRs:

• #5768
• #5769
• #5772

[atwixfirster]

Working on files in the next directories:

• guides/v2.2/config-guide
• guides/v2.3/config-guide

PRs:

• https://github.com/magento/devdocs/pull/5737
• https://github.com/magento/devdocs/pull/5736
• https://github.com/magento/devdocs/pull/5739
• https://github.com/magento/devdocs/pull/5738

[atwixfirster]

Working on files in the next directories:

• guides/v2.2/contributor-guide
• guides/v2.3/contributor-guide
• guides/v2.2/design-styleguide
• guides/v2.3/design-styleguide

PR:

• https://github.com/magento/devdocs/pull/5740

[atwixfirster]

Working on files in the next directories:

• guides/v2.2/ext-best-practices
• guides/v2.3/extension-dev-guide
• guides/v2.2/ext-best-practices
• guides/v2.3/extension-dev-guide

PRs:

• https://github.com/magento/devdocs/pull/5742
• https://github.com/magento/devdocs/pull/5773
• https://github.com/magento/devdocs/pull/5774
• https://github.com/magento/devdocs/pull/5775
• https://github.com/magento/devdocs/pull/5776
• https://github.com/magento/devdocs/pull/5777

[drpayyne]

WIP in directory/file:

• guides/v2.3/ui_comp_guide
• guides/v2.3/test
• guides/v2.2/test
• guides/v2.3/soap
• guides/v2.2/soap
• guides/v2.3/security
• guides/v2.2/security
• guides/v2.3/rest
• guides/v2.2/rest
• guides/v2.3/release-notes
• guides/v2.2/release-notes
• guides/v2.3/performance-best-practices
• guides/v2.2/performance-best-practices
• guides/v2.3/payments-integrations
• guides/v2.2/payments-integrations
• guides/v2.3/pattern-library
• guides/v2.3/page-builder
• guides/v2.3/mtf
• guides/v2.3/mrg
• guides/v2.2/mrg
• guides/v2.3/migration
• guides/v2.3/marketplace
• guides/v2.3/install-gde
• guides/v2.2/install-gde
• guides/v2.3/howdoi
• guides/v2.3/graphql
• guides/v2.3/get-started
• guides/v2.3/inventory
• guides/v2.3/frontend-dev-guide
• guides/v2.2/frontend-dev-guide
• community
• .github

PRs created:

• #5743
• #5744
• #5745
• #5746
• #5747
• #5748
• #5749
• #5750
• #5752
• #5753
• #5754
• #5755
• #5756
• #5757
• #5758
• #5759
• #5760
• #5761
• #5762
• #5763
• #5764
• #5765
• #5766
• #5767

[drpayyne]

@jeff-matthews Have refactored all code, in the above PRs _except_ the following directories which have been chosen by developers already, to avoid conflicts

• guides/v2.2/javascript-dev-guide
• guides/v2.3/javascript-dev-guide
• guides/v2.2/extension-dev-guide
• guides/v2.3/extension-dev-guide
• _includes

I believe there are no remaining issues to take up, regarding MD030.
Thank you.

[jeff-matthews]

Thanks for all your help @drpayyne, @atwixfirster, and @eduard13! I'm going to run some checks on the integration branch and make any final changes necessary before creating a PR to master.

Please do not submit any new PRs.

[atwixfirster]

@jeff-matthews , for your notice: extension-dev-guide is not fixed. I am working on files from that folder but I did not create PRs yet.

Thanks

[jeff-matthews]

Oh ok. Thanks @atwixfirster. In that case, submit your PRs when you're ready. I think I got ahead of myself and assumed all work was complete.

[eduard13]

@jeff-matthews, the same here, planning to finish with javascript-dev-guide folder soon.
Thanks.

[jeff-matthews]

No problem @eduard13!

[atwixfirster]

@jeff-matthews , I've finished all my pending files. All PRs from my side were created.

Thank you and have fun in review ;)