slachiewicz opened a new pull request, #510: URL: https://github.com/apache/maven-resources-plugin/pull/510
Part of an estate-wide move of the remaining FAQ pages from FML to Markdown. ### Two commits, deliberately 1. **A pure rename**, `src/site/fml/faq.fml` -> `src/site/markdown/faq.md`, no content change. 2. **The rewrite**, written by hand. 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.** ### Why by hand doxia-converter cannot target FML: the questions come out as link-reference syntax rather than headings, the `[top]` back-links become links to a nonexistent `top` page, and the contents links lose their `#` anchors. ### Anchors are preserved, and that is the point This page has been on maven.apache.org for years and is linked from outside. None of the four `<faq id=…>` values is a valid XML name, so `DoxiaUtils.encodeId` rewrites all four at render time: `?` becomes `.3F` and `'` becomes `.27`. The `<a name>` elements written here reproduce **the anchor the live site serves today**, not the raw attribute. **One to look at closely in review:** the `id` for question 2 misspells "resources" and capitalises differently from the question itself, so the anchor the site serves is ``` #When_should_I_use_the_resouces_plugin.27s_goal_outside_a_lifecycle.3F ``` while the heading reads "When should I use the Resources Plugin's goal outside a lifecycle?". The typo is kept **deliberately** — that is the URL people have bookmarked. ### Verification Built the site with `mvn site` before and after and compared the set of anchors the generated `faq.html` actually serves. All four plus `#top` are still served; `<head>` byte-identical, so title and metadata are unchanged; no link target on the page changed. `site.xml` needs no edit — FML and Markdown both render to `faq.html`, so the menu entry and the `./faq.html` link in `index.md` keep working. ### What is lost FML generates a `[top]` back-link after each answer. Those are dropped rather than hand-written. The question becomes an `h3` heading instead of a definition term. The two `<source>` blocks become fenced code blocks. Nothing else changes. <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]
