slachiewicz opened a new pull request, #3422:
URL: https://github.com/apache/maven-surefire/pull/3422
APT is a dead format; Doxia 2 keeps it only for backwards compatibility.
These 35 pages were the last APT sources in this repository.
Two commits, deliberately kept apart:
1. **`Rename the site documents ahead of converting them`** — pure `git mv`,
no content change.
2. **`Convert the site documents from APT to Markdown`** — the conversion.
Please **merge or rebase, rather than squash**. Git's rename detection is
similarity-based, so squashing collapses the rename back into a delete plus an
add and `git log --follow` stops at this PR. Review is easiest on the second
commit alone.
## What was converted
| Module | Pages |
|:---|---:|
| `maven-surefire-plugin` | 27 (`index`, `usage`, `api`, `developing`,
`history` + 22 under `examples/`) |
| `maven-surefire-report-plugin` | 7 (`index`, `usage` + 5 under
`examples/`) |
| `surefire-api` | 1 (`index`) |
## How it was verified
The site was generated before and after the change and the rendered HTML
compared page by page — 150 pages, including document title, author and date
metadata, visible text and every link target.
`maven-failsafe-plugin` is in that set on purpose: it renders
`maven-surefire-plugin`'s site sources from the `site-source` artifact, so
every `#if` on `${project.artifactId}` has to keep working for both plugins.
Each conditional page was converted once per branch and the two results merged
back together, so both renderings are reproduced exactly.
All 150 pages render identically apart from:
* **`surefire-api/index.html`** — a Markdown table must have a header row
and the APT table had none, so the page now shows an empty header band. This is
the one intended rendering change; say the word if you would rather the table
were given real column headings.
* project-info reports (`dependencies`, `dependency-convergence`) and the
Surefire test report, which differ only because of how the two comparison
builds were invoked.
## Things the converter cannot get right on its own
* Pages that still need Velocity keep the `.vm` suffix. In such a file `##`
opens a Velocity line comment and would silently swallow the heading, so level
two headings use a setext underline and deeper levels are wrapped in `#[[###
...]]#`.
* `api.md`, `developing.md`, `examples/cwd.md` and the report plugin's
`examples/linking-to-tests.md` contain no Velocity at all, so they drop the
`.vm` suffix.
* References the page means to *show* rather than resolve are written
`${esc.d}{...}`. A backslash only unescapes when the name happens not to
resolve in the document's context — `${project.build.outputDirectory}` does
resolve, and was being substituted with a real path.
* APT figures became `<figure>`/`<figcaption>` so captions stay visible on
the page instead of disappearing into an `alt` attribute.
* A few bold runs and literal asterisks needed escaping to survive as text.
Only `master` is touched; `surefire-3.5.x` is deliberately left alone.
Generated-by: Claude Opus 5
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
