slachiewicz opened a new pull request, #692: URL: https://github.com/apache/maven-checkstyle-plugin/pull/692
Part of an estate-wide move of the remaining FAQ pages from FML to Markdown. FML is a FAQ-specific Doxia format with no Markdown counterpart and doxia-converter cannot target it, so the page is hand-written rather than converted. ### Two commits, deliberately 1. **A pure rename**, `src/site/fml/faq.fml` → `src/site/markdown/faq.md`, no content change. 2. **The rewrite.** Git records a rename plus a rewrite in a single commit as a delete and an add, which stops `git log --follow`. Splitting them keeps the history. **Please merge or rebase rather than squash**, since squashing collapses the rename again. ### Anchors are preserved, and that is the point This page has been on maven.apache.org for years and is linked from outside, so no URL may change. FML derives its anchor from the `<faq id=…>` attribute — and where that attribute is not a valid XML name, `DoxiaUtils.encodeId` rewrites it at render time. **Every id on this page is rewritten**, since all five contain spaces and two contain colons: | `<faq id=…>` | anchor actually served | |---|---| | `What is the difference between checkstyle:checkstyle and checkstyle:check` | `#What_is_the_difference_between_checkstyle.3Acheckstyle_and_checkstyle.3Acheck` | Markdown headings would instead get an anchor derived from the *question text* — a different string again, since the questions end in a question mark. So the `<a name>` written here reproduces **the anchor the live site serves today**, taken from the rendered HTML rather than from the raw attribute. ### Verification Built the site before and after and compared the set of anchors the generated `faq.html` actually serves: | | anchors served | |---|---| | before | the five encoded question ids, plus `top` and `bodyColumn` | | after | the same seven, plus six heading-derived ids | Every anchor present before is still present after — the set only grows. The `<head>` is byte-identical, so the title and metadata are unchanged. `site.xml` needs no edit: `src/site/fml/faq.fml` and `src/site/markdown/faq.md` both render to `faq.html`. ### What is lost FML generates a `[top]` back-link after each answer; those are dropped rather than hand-written. The question now renders as an `h3` heading instead of a definition term. Those are the only rendering differences. <sub>Drafted with Claude — please verify</sub> -- 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]
