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

   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. 
Five of the six ids are valid XML names and are served unchanged — `#cli`, 
`#missing`, `#question`, `#includes`, `#unused`. The sixth, `<faq id="plugin 
name">`, is not, so `DoxiaUtils.encodeId` serves it as `#plugin_name`; that 
rewritten form is what the Markdown writes, not the raw attribute.
   
   ### One broken outbound link fixed
   
   The `cli` answer pointed at `examples/copying-artifacts.html#Copying From 
the Command Line`. Doxia encodes the fragment, so the live page serves 
`#Copying_From_the_Command_Line` — but `copying-artifacts.md.vm` generates 
`#Copying_from_the_command_line`, lower case. The capitalised form has never 
resolved. The link now uses the anchor the target page actually has. Flagging 
it because it is the one intentional content change in this PR.
   
   ### 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. `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 `<pre>` block in the `cli` answer becomes a fenced code 
block. 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]

Reply via email to