ppkarwasz opened a new pull request, #6:
URL: https://github.com/apache/logging-flume-site/pull/6
Migrates the Flume website source from Sphinx/reStructuredText to an
Antora/AsciiDoc layout. This is the **deterministic** part of the migration:
the mechanical RST -> AsciiDoc conversion plus the Antora scaffolding. The site
can be generated locally with `npm install && npx antora antora-playbook.yaml`
(output in `build/site`).
## What changed
- **`src/site/antora/`** - Antora component (`antora.yml`),
`modules/ROOT/{pages,images,nav.adoc}`. 35 pages converted, 8 images.
- **`antora-playbook.yaml`** (root) - reads from `src/site/antora`, default
Antora UI bundle, `@asciidoctor/tabs`, output to `build/site`.
- **`package.json`** (root) - Antora 3.1.x dependencies.
- **`tools/rst2adoc.sh`** - re-runnable conversion: `pandoc -f rst -t
asciidoc -s` per page, ASF license header, image copy.
- **`tools/fix_xrefs.py`** - rewrites relative `.html` links to
`xref:*.adoc` only when the target page exists; strips the redundant `images/`
prefix from image macros.
- Removed all `*.rst` sources and the orphaned Sphinx scaffolding
(`conf.py`, `contents.rsx`, `_templates/`, `_themes/`). Git records
`index`/`license` and all 8 images as renames.
## Verification
`npx antora` builds clean (no errors/warnings): 37 HTML pages, images and
cross-page xrefs resolve.
## Known manual follow-ups (not part of the deterministic pass)
- pandoc drops `raw:: html` blocks - notably the 15 News date headers on
`index` (announcement text survives, the `<h3>` dates do not); also 2 in
`documentation`, 1 each in `source` / `flume-spring-boot/source`.
- `nav.adoc` is hand-authored (ordering/labels), open to review.
- Per-version doc archives (`content/<ver>/FlumeUserGuide.html`, Javadoc
`apidocs/`) are left as plain links; how to host them on the Antora site is a
separate decision.
- `pom.xml` still wires the `sphinx-maven-plugin` to the now-removed
`source/sphinx` (build migration is the separate npm-driven follow-up).
- Cosmetic: pandoc escapes some commas as `,` and `rubric::` becomes
bold text.
Assisted-By: Claude Opus 4.8 (1M context)
--
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]
