Skip to content

Lead with Markdown in the site and plugin documentation guides - #1633

Merged
slachiewicz merged 1 commit into
apache:masterfrom
slachiewicz:lead-with-markdown
Aug 9, 2026
Merged

Lead with Markdown in the site and plugin documentation guides#1633
slachiewicz merged 1 commit into
apache:masterfrom
slachiewicz:lead-with-markdown

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

Sits on top of #1632 — the first two commits here are that PR, since the plugin documentation guide has to be Markdown before its content can be rewritten. Review the last commit only; once #1632 merges this will rebase down to two files.

Two pieces of normative guidance still point new documentation at APT:

guides/mini/guide-site.md lists apt first and calls it the format "like this one" — which stopped being true when that guide itself became Markdown. It now lists markdown first, says plainly that new documentation should use it, and describes APT as a format that predates Maven's Markdown support: still supported, but the Maven project has moved its own documentation off it. Adds a pointer to doxia-converter for anyone converting an existing page.

guides/development/guide-plugin-documentation is the canonical instruction for documenting a plugin, and it gave a full APT template for src/site/apt/index.apt — so an author following it started in APT. It now shows the same page as src/site/markdown/index.md, with the YAML front matter that carries the title, author and date, plus a note about naming the file index.md.vm and keeping headings away from ## if the page needs Velocity.

One thing worth seeing: that guide is itself a Velocity template, and Velocity reads ## as a line comment even inside a fenced code block. The first version of this change silently lost ## Goals Overview and ## Usage from the rendered sample. It is now wrapped in #[[ ]]#. That only showed up because the built page was checked rather than the source.

Verified by building the site: the sample renders all its headings and no #[[ markup leaks into the page.

Javadoc API
-----------

Here is some useful Javadoc API links to the current version of Maven:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is --> are

@slachiewicz

slachiewicz commented Aug 9, 2026

Copy link
Copy Markdown
Member Author

This is pure apt to Markdown conversion and now with Your previous commits I have conflicts

The site guide listed apt first and described it as the format 'like this one',
which stopped being true when that guide became Markdown. It now lists markdown
first, says plainly that new documentation should use it, and describes apt as a
format that predates Maven's Markdown support - still supported, but the Maven
project has moved its own documentation off it - with a pointer to doxia-converter.

The plugin documentation guide gave a full APT template for src/site/apt/index.apt,
so a plugin author following it started in APT. It now shows the same page as
src/site/markdown/index.md, and explains the front matter and the ## trap for
anyone whose page needs Velocity.

The sample is wrapped in an unparsed block: the guide is itself a Velocity
template, and without it Velocity reads the sample's own ## headings as line
comments and deletes them - which it did, until the built page was checked.
@slachiewicz
slachiewicz merged commit 9e86535 into apache:master Aug 9, 2026
1 check passed
@slachiewicz
slachiewicz deleted the lead-with-markdown branch August 9, 2026 22:20
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.

2 participants