HDDS-10254. Add GitHub Actions check for Markdown style. #81
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Conflicting files have been renamed/moved/deleted since the change was originally done. They were ignored and not added as part of the cherry pick Conflicts: docs/03-core-concepts/04-security/01-authentication/02-spnego.md docs/03-core-concepts/04-security/01-authentication/04-s3-secrets.md docs/05-administrator-guide/03-operations/02-upgrades-and-downgrades.md docs/05-administrator-guide/03-operations/09-observability/03-component-web-uis.md
github-actions
bot
added
the
website-v2
adoroszlai
approved these changes
Mar 2, 2024
|
Thanks @adoroszlai and @swagle for review and merge. |
errose28
added a commit
to errose28/ozone-site
that referenced
this pull request
Mar 5, 2024
…ting-guide * HDDS-9225-website-v2: HDDS-10254. Add GitHub Actions check for Markdown style. (apache#81)
errose28
added a commit
to errose28/ozone-site
that referenced
this pull request
Mar 5, 2024
* HDDS-9225-website-v2: HDDS-10254. Add GitHub Actions check for Markdown style. (apache#81) HDDS-10349. Add GitHub Actions check for consistent file name formatting. (apache#79) HDDS-10426. Crop ozone-logo.svg to a proper size (apache#80) HDDS-10353. Add GitHub Actions check of all generated URLs in the sitemap. (apache#77)
errose28
added a commit
to errose28/ozone-site
that referenced
this pull request
May 30, 2024
* HDDS-9225-website-v2: Bump docusaurus to 3.3.2 (apache#93) HDDS-10667. Improvements to spelling checks. (apache#89) HDDS-10698. Bump skywalking-eyes to v0.6.0 (apache#90) HDDS-10449. Add quick start to the top of contributing guide. (apache#83) HDDS-10351. Add GitHub Actions check for yaml formatting (apache#87) HDDS-9567. Add GitHub Actions license header check for relevant files. (apache#86) HDDS-10506. Reduce directory iterations in sidebar check (apache#85) HDDS-9866. Add GitHub Actions checks for consistent Docusaurus formatting. (apache#84) HDDS-10254. Add GitHub Actions check for Markdown style. (apache#81) HDDS-10349. Add GitHub Actions check for consistent file name formatting. (apache#79) HDDS-10426. Crop ozone-logo.svg to a proper size (apache#80) HDDS-10353. Add GitHub Actions check of all generated URLs in the sitemap. (apache#77) HDDS-9868. Add GitHub Actions check for spelling. (apache#76) HDDS-10400. Fix event condition in website publish workflow (apache#78) HDDS-10352. Add GitHub Actions workflow to build and run the website. (apache#74) HDDS-10222. Add pnpm guide to contributing guide. (apache#64) HDDS-10313. Update "Redundant" to "Reliable" in new website. (apache#73)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
--fixflag 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