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

   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. 
Both anchors here, `#question1` and `#question2`, are valid XML names, so Doxia 
serves them unchanged and the `<a name>` elements written here match the live 
URLs exactly.
   
   ### Verification
   
   Built the site with `mvn site` before and after and compared the set of 
anchors the generated `faq.html` actually serves. Every anchor served before is 
still served after; `<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.
   
   One extra difference in this repo: the second answer wraps two `<source>` 
blocks inside a single `<p>`, which FML rendered as code blocks interrupting a 
paragraph. In Markdown they become fenced code blocks with the surrounding 
prose split into paragraphs around them — same text, cleaner structure.
   
   <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]

Reply via email to