Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HDDS-11979. Fix heading and list checks in markdownlint. #121

Merged

Conversation

errose28
Copy link
Contributor

@errose28 errose28 commented Jan 2, 2025

What changes were proposed in this pull request?

The current markdownlint configuration has a typo that mixes the settings for headings and unordered lists:

  • heading-increment uses sensible default values, it does not need to be added to the config
  • heading-style should be specified as atx only
  • ul-style should be dash. This config was incorrectly put under heading-increment

This was noticed during the review of #116, where * for lists was not flagged.

What is the link to the Apache Jira?

HDDS-11979

How was this patch tested?

Check off which of the following tests were done on this change. If additional testing was done, please elaborate here as well.

  • The CI checks on my fork are passing
    • This run shows existing pages already conform to these rules
  • I verified the rendered content using a local preview
  • I manually verified the steps provided in this change work as described
    • This run adds a failing file and shows heading-style, heading-increment, and ul-style getting flagged

@github-actions github-actions bot added the website-v2 Tasks for the new ozone website targeting the HDDS-9225-website-v2 branch label Jan 2, 2025
@errose28 errose28 requested a review from adoroszlai January 2, 2025 19:16
@adoroszlai adoroszlai merged commit d882a3a into apache:HDDS-9225-website-v2 Jan 3, 2025
14 checks passed
@adoroszlai
Copy link
Contributor

Thanks @errose28 for the patch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website-v2 Tasks for the new ozone website targeting the HDDS-9225-website-v2 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants