Convert the FAQ from FML to Markdown - #231
Merged
Merged
Conversation
Git records a rename plus a rewrite in one commit as a delete and an add, which stops 'git log --follow'. Splitting the rename out keeps the history. Please merge or rebase rather than squash. Generated-by: Claude Opus 5 (1M context)
This was referenced Aug 9, 2026
doxia-converter cannot target FML usefully - 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. The page is written out by hand instead. Explicit <a id> anchors keep the existing deep links working. FML renders <faq id="Configure Reproducible Builds"> as the anchor #Configure_Reproducible_Builds, because DoxiaUtils.encodeId rewrites an id that is not a valid XML name. The <a name> emitted here reproduces that rendered form, not the raw attribute, so the live URL still resolves. Verified by building the site before and after and comparing the set of anchors the generated faq.html actually serves. Every anchor present before is still present after: before: Configure_Reproducible_Builds, top, bodyColumn after: the same three, plus two heading-derived ids 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. FML generates a [top] back-link after each answer; those are dropped rather than hand-written, which is the only rendering loss. The anchors are written <a id> rather than <a name>: maven-site-plugin 3.21.0 silently drops a name attribute from inline HTML, leaving the build green and every deep link broken. The id form works on every version and is the correct HTML5 spelling. Generated-by: Claude Opus 5 (1M context)
slachiewicz
force-pushed
the
faq-to-markdown
branch
from
August 10, 2026 00:26
146ae70 to
5907bd5
Compare
slachiewicz
marked this pull request as ready for review
August 10, 2026 00:31
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of an estate-wide move of the remaining FAQ pages from FML to Markdown. This repo is
one of three pilots; the pattern here is the one the rest will follow.
Two commits, deliberately
src/site/fml/faq.fml→src/site/markdown/faq.md, no content change.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 — it currently traces back to 2021.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. FML derives
its anchor from the
<faq id=…>attribute — and where that attribute is not a valid XMLname,
DoxiaUtils.encodeIdrewrites it at render time. Hereid="Configure Reproducible Builds"is served as#Configure_Reproducible_Builds.Markdown headings would instead get an anchor derived from the question text, which is a
different string. So the
<a name>written here reproduces the anchor the live siteserves today, not the raw attribute.
Verification
Built the site before and after and compared the set of anchors the generated
faq.htmlactually serves:
Configure_Reproducible_Builds,top,bodyColumnEvery anchor present before is still present after. The
<head>is byte-identical, so thetitle and metadata are unchanged.
site.xmlneeds no edit —src/site/fml/faq.fmlandsrc/site/markdown/faq.mdboth render tofaq.html.What is lost
FML generates a
[top]back-link after each answer. Those are dropped rather thanhand-written; it is the only rendering difference besides the question becoming an
h3heading instead of a definition term.
Drafted with Claude — please verify