Port the site documentation from APT to Markdown - #12682
Conversation
fb6dae4 to
693ffc6
Compare
gnodet
left a comment
There was a problem hiding this comment.
Great work on this APT-to-Markdown migration! The conversion is well-executed across most of the 76 files — links, tables, macros, license headers, and Velocity template handling are all cleanly converted.
A handful of conversion artifacts worth addressing before merge:
Medium:
-
Spurious HTML anchors in property references —
${maven.home}became$<a id="maven.home"></a>maven.homeinconfiguration-management.md(6 occurrences) andgetting-to-container-configured-mojos.md(1 occurrence). These should remain as literal${maven.home}or in backticks. -
Lost structure in Properties subsection — In
configuration-management.md, the "Properties" subsection heading became plain text and three property definitions collapsed into a single paragraph, losing readability. -
XML elements rendered as emphasis —
<developerConnection/>became_developerConnection/_(italic) inconfiguration-management.md(3 occurrences). Should use backticks:`<developerConnection/>`.
Low:
4. Leading spaces in link text — [ Settings Reference](...) instead of [Settings Reference](...) in maven-settings/index.md (5 links), maven-compat/index.md (1 link), and artifact-handlers.md (1 link).
unknowncode fence language — 12 code fences across 6 files use```unknownas language identifier. Should use bare```or```text.
This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.
Claude Code on behalf of gnodet
49627cf to
913d842
Compare
A pure rename, so that git records it and `git log --follow` and `git blame` still reach the history of each page after the conversion that follows. The content is still APT at this point and the site does not build between the two commits.
de70e2e to
e7dabca
Compare
38 page(s) converted with doxia-converter and then cleaned up by hand:
- <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
becomes [text](url)
- the ASF license header becomes a single block HTML comment
- a page whose only Velocity reference was ${project.name} is now a plain
.md with the title spelled out
- a page that keeps a reference stays a .vm. Velocity reads ## as a line
comment and would silently swallow every ATX heading below level one, so
subsections use setext underlines and anything deeper is wrapped in
#[[ ... ]]#
- a reference APT rendered literally is escaped with ${esc.d}
Two tests read the dependency types table straight out of the site
documentation to check it against DefaultTypeProvider, so they follow the
page to Markdown. APT let a table carry a second header row part way down to
group the rows beneath it; a Markdown table has one header row only, so those
group labels are now ordinary rows carrying bold text, and the tests skip a
row whose only filled column is the first.
Verified by building the site before and after and comparing every generated
page: the visible text and the link targets are unchanged apart from <b>/<i>
becoming <strong>/<em> and quotes and ellipses in prose picking up the
Markdown module's typographic substitution. The four modules under its/ could
not be built here, so their five pages are converted but unverified.
e7dabca to
a1d6473
Compare
gnodet
left a comment
There was a problem hiding this comment.
All 5 previously identified conversion artifacts have been fixed in the latest commits:
- ✅ Spurious HTML anchors in property references — now properly rendered in backticks
- ✅ Lost structure in Properties subsection — proper heading and fenced code block
- ✅ XML elements rendered as emphasis — now using backticks
- ✅ Leading spaces in link text — cleaned up
- ✅ Unknown code fence language — removed
The Velocity template handling in .md.vm files is well done, and the test file updates correctly parse the new Markdown table format.
This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.
Claude Code on behalf of gnodet
Converts the 76 pages under
src/site/aptto Markdown. APT is a format onlyDoxia understands; Markdown is already supported by
maven-site-pluginout ofthe box, so no POM change is needed.
The pages were converted with
doxia-converterand then cleaned up by hand:<<<code>>>becomes backticks,<<bold>>becomes**bold**, and{{{url}text}}becomes[text](url)${project.name}is now a plain.mdwith the title spelled out.vm. Velocity reads##as a linecomment and would silently swallow every ATX heading below level one, so
subsections use setext underlines and anything deeper is wrapped in
#[[ ... ]]#${esc.d}{...}Verified by building the site before and after the change and comparing every
generated page. The visible text and the link targets are unchanged, apart
from
<b>/<i>rendering as<strong>/<em>and quotes and ellipses inprose picking up the Markdown module's typographic substitution.
The four modules under
its/could not be built in my environment, so theirfive pages are converted but unverified. Their
%{snippet}macros were checkedby hand against the originals.
Part of the wider migration tracked in
apache/maven-doxia-converter#139