Port the site documentation from APT to Markdown - #1110
Merged
slachiewicz merged 2 commits intoAug 7, 2026
Merged
Conversation
Kept as its own commit so that git log --follow and git blame still reach each page's history once the content changes.
The maintenance line still carried its site documentation in APT, so a release from it would have published the old pages while the default branch serves Markdown. Four things APT renders literally that Markdown would reinterpret: a double hyphen, which the typographic extension folds into an en dash; an asterisk mid-line, which is emphasis in Markdown but only a list marker in APT; and, in the pages that keep a .vm suffix, ## which Velocity reads as a line comment. Verified by building the site before and after and comparing all 27 generated pages: every one is identical in its title, author and date metadata, its visible text and every link target.
slachiewicz
merged commit Aug 7, 2026
6531b35
into
apache:maven-compiler-plugin-3.x
45 checks passed
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
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.
The
maven-compiler-plugin-3.xmaintenance line still carries its site documentation in APT, so a release from it would publish the old pages while the default branch serves Markdown. This brings the two into line.Two commits: a pure
git mvso thatgit log --followandgit blamestill reach each page's history, then the conversion. Please merge or rebase rather than squash — squashing collapses the rename.Things that needed doing by hand, each found by comparing generated HTML rather than by reading the converted source:
##as a line comment, so in a page that keeps its.vmsuffix every heading below level one would be silently deleted. Level two uses a setext underline, deeper ones an unparsed#[[ ]]#block.$\{foo\}for a reference it means to display, its parser strips the backslashes, so the converted page carried a live reference. Those are now${esc.d}{foo}— in.vmpages only, since a plain.mdis never run through Velocity and${esc.d}would render literally there.*.Verified by building the site before and after and comparing all 27 generated pages: every one is identical in its title, author and date metadata, its visible text and every link target.