errose28 opened a new pull request, #81: URL: https://github.com/apache/ozone-site/pull/81
## Summary Markdown has many different ways to do the same thing, and some catches that can cause things to render in unexpected ways. This PR proposes the following changes: 1. Add a markdownlint check to CI to enforce consistent formatting. 2. Configure markdownlint rules for validating files. 3. Fix existing markdown files to comply with the rules. Most of the fixes were done by passing the `--fix` flag to markdownlint. While most of the configurations for markdownlint are set to prevent errors or enforce consistent formatting across documents, some of them, like line length, are more opinionated. I've set what I think are sensible values based on my experience but I'm open to other thoughts on these as well. If you are only interested in the formatting rules, see `.markdownlint.yaml`. ## Jira HDDS-10254 ## Testing - [This run on my fork](https://github.com/errose28/ozone-site/actions/runs/8070380491/job/22047564772) failed with just the linting check applied and no changes to existing markdown documents. - [This run on my fork](https://github.com/errose28/ozone-site/actions/runs/8070334754) passed after fixing the markdown documents to comply with the linting rules. - CI on this PR should pass. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
