[PR] Convert the FAQ from FML to Markdown [maven-compiler-plugin]

["slachiewicz (via GitHub)" <gi...@apache.org>]

slachiewicz opened a new pull request, #1111:
URL: https://github.com/apache/maven-compiler-plugin/pull/1111

   Part of the estate-wide move of the remaining FAQ pages from FML to Markdown, following the pattern reviewed in apache/maven-artifact-plugin#231, apache/maven-assembly-plugin#1354 and apache/maven-javadoc-plugin#1358.
   
   ### 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 one commit as a delete and an add, which stops `git log --follow`. Splitting them keeps the history. **Please merge or rebase rather than squash.**
   
   ### Anchors are preserved, and that is the point
   
   This page has been on maven.apache.org for years and is linked from outside. 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. The `<a name>` elements here reproduce **the anchor the live site serves today**, not the raw attribute.
   
   ### Verification
   
   Built the site before and after and compared the set of anchors the generated `faq.html` actually serves:
   
   ```
   bodyColumn
   how-to-add-generated-sources
   top
   ```
   
   Every anchor served before is still served after. The `<head>` is byte-identical, so title and metadata are unchanged, and every link target on the page is unchanged. `site.xml` needs no edit - both paths 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 renders as an `h3` heading instead of a definition term. 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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Convert the FAQ from FML to Markdown [maven-compiler-plugin]

["slachiewicz (via GitHub)" <gi...@apache.org>]

slachiewicz merged PR #1111:
URL: https://github.com/apache/maven-compiler-plugin/pull/1111


-- 
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: issues-unsubscribe@maven.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org