Skip to content

Port the site documentation from APT to Markdown - #504

Open
slachiewicz wants to merge 2 commits into
apache:masterfrom
slachiewicz:site-apt-to-markdown-master
Open

Port the site documentation from APT to Markdown#504
slachiewicz wants to merge 2 commits into
apache:masterfrom
slachiewicz:site-apt-to-markdown-master

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

Converts the 11 page(s) under src/site/apt to Markdown. APT is a format only
Doxia understands; Markdown is already supported by maven-site-plugin out of
the box, so no POM change is needed.

This PR targets master. The maven-resources-plugin-3.x maintenance line is covered by the sibling
PR #503, so the conversion lands on both lines and is not lost on the next
merge.

The pages were converted with doxia-converter and then cleaned up by hand:

  • <<<code>>> becomes backticks, <<bold>> becomes **bold**, and
    {{{url}text}} becomes [text](url)
  • the ASF licence 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 the page means to display rather than resolve is written
    ${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 in
prose picking up the Markdown module's typographic substitution.

Part of the wider migration tracked in
apache/maven-doxia-converter#139

One thing worth a reviewer's eye, pre-existing on master only: in
examples/custom-resource-filters.apt.vm three paragraphs start in column 1,
which APT reads as a section title, so the current site renders them as
top-level headings rather than prose. The Markdown keeps that rendering so this
change stays a pure format migration and the page-by-page comparison comes out
empty. It is an authoring slip in the APT and is probably worth a separate
follow-up to turn those three headings back into paragraphs.

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.
11 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}, which always
  yields a literal dollar; a backslash only works when the reference itself
  resolves

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.
@slachiewicz
slachiewicz force-pushed the site-apt-to-markdown-master branch from 5fa3df3 to 318478f Compare August 6, 2026 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant