nevzheng opened a new pull request, #12618: URL: https://github.com/apache/gravitino/pull/12618
### What changes were proposed in this pull request? Add a Markdown formatting standard for `design-docs/` and enforce it with rumdl. - The human-readable rule set is `design-docs/markdown-formatting.md` (markdownlint defaults plus a short override list). - `.rumdl.toml` is the machine config. - `./gradlew markdownlint` is **blocking** locally (downloads pinned rumdl 0.2.60). - CI runs the same Gradle task with `-Pmarkdownlint.failOn=never`, so findings are warnings until a follow-up formats existing files. This PR does not rewrite existing design-doc tables. ### Why are the changes needed? Design-doc reviews keep spending time on table alignment and other formatting nits because there is no shared standard or lint path. Related to: #12617 ### Does this PR introduce _any_ user-facing change? No. Documentation-process only. No API or configuration-key changes. ### How was this patch tested? - `./gradlew markdownlint` fails as intended on current `design-docs/` (1507 issues in 18 files). - `./gradlew markdownlint -Pmarkdownlint.failOn=never` reports the same findings and exits 0. - `rumdl check design-docs/markdown-formatting.md` reports no issues. Nevin Sent from my 🤖 (Cursor) Made with [Cursor](https://cursor.com) -- 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]
