Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Markdown linting: Ordered list item prefix (MD029) #5248

Closed
dshevtsov opened this issue Aug 22, 2019 · 14 comments · Fixed by #5698
Closed

Markdown linting: Ordered list item prefix (MD029) #5248

dshevtsov opened this issue Aug 22, 2019 · 14 comments · Fixed by #5698
Labels
Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies

Comments

@dshevtsov
Copy link
Collaborator

dshevtsov commented Aug 22, 2019

Bug report

Description

The Markdown linter reports about 3867 issues when the rule 'MD029' is enabled.

Instructions

  1. Add a comment to this issue requesting the devdocs-admins to assign the issue to you.
  2. Checkout the MD029-integration branch.
  3. In the _checks/styles/style-rules-prod change exclude_rule 'MD029' to rule 'MD029'.
  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: It makes sense to fix the following issues at the same time as MD029:

    • MD030: Spaces after list markers
  • See the Markdown linting issues wiki page for detailed guidelines.

@dshevtsov dshevtsov added the Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies label Aug 22, 2019
@jeff-matthews jeff-matthews self-assigned this Oct 11, 2019
@jeff-matthews
Copy link
Contributor

I'm working on the following directories:

  • guides/v2.2/rest/
  • guides/v2.2/test/
  • guides/v2.2/ui_comp_guide/

@jeff-matthews
Copy link
Contributor

I'm working on the following directories:

  • release-notes/
  • performance-best-practices/

@jeff-matthews
Copy link
Contributor

I'm working on the following directories:

  • pattern-library/
  • payments-integrations/

@jeff-matthews
Copy link
Contributor

jeff-matthews commented Oct 11, 2019

I'm working on the following directories:

  • marketplace/
  • migration/
  • guides/v2.2/mrg/
  • mtf/

@jeff-matthews
Copy link
Contributor

jeff-matthews commented Oct 11, 2019

I'm working on the following directories:

  • install-gde/
  • inventory/
  • javascript-dev-guide

@jeff-matthews
Copy link
Contributor

I'm working on the following directories:

  • design-styleguide/
  • contributor-guide/
  • comp-mgr/
  • coding-standards/

@jeff-matthews
Copy link
Contributor

I'm working on the following directories:

  • advanced-reporting/
  • architecture/
  • _vidoes/

@jeff-matthews
Copy link
Contributor

I'm working on all _include/ files except cloud.

@jeff-matthews
Copy link
Contributor

All remaining MD029 errors are in cloud files. I'm working on that next.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants