Migrate logging-flume-site content into this repository#462
Merged
Conversation
Update the latest version from 1.4 to 1.9
Flume uses TravisCI. Apache Infra does not support Sonar anymore.
* Convert website from reStructuredText to Antora/AsciiDoc Migrate the Flume website source from Sphinx/reStructuredText to an Antora/AsciiDoc layout under src/site/antora, and add antora-playbook.yaml and package.json at the repository root so the site can be generated with npm/Antora directly. The page conversion is deterministic and reproducible: - tools/rst2adoc.sh runs pandoc over every source/sphinx/**/*.rst, mirrors the directory layout into the Antora page tree, prepends the ASF license header (pandoc drops the RST comment header) and copies the images. - tools/fix_xrefs.py rewrites relative .html links to xref:*.adoc, but only when the target page exists, and strips the redundant images/ prefix from image macros. The original *.rst sources and the now-orphaned Sphinx scaffolding (conf.py, contents.rsx, _templates, _themes) are removed. Known manual follow-ups, not covered by the deterministic conversion: - pandoc drops `raw:: html` blocks (notably the News date headers on index) - nav.adoc is hand-authored - per-version doc archives (content/<ver>/...) and Javadoc remain plain links - pom.xml still references the sphinx-maven-plugin Assisted-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Output the generated site to target/site Match the output directory used by the Log4j website build, which generates into target/site. Drop the now-unused /build/ ignore entry, since /target/ already covers the Antora output. Assisted-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Restore the News date headers on the index page pandoc dropped the `.. raw:: html` <h3> blocks during conversion, so the dated News entries on the home page lost their headers. Restore them as a `== News` section with one `=== <date>` subsection per entry, matching the original page. Also remove the leftover `.. toctree::` entries that pandoc rendered as bare text at the bottom of the page; that navigation is provided by nav.adoc. Assisted-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Fix `.asf.yaml`
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
4 participants
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.
This PR moves the website content currently hosted in
logging-flume-siteinto this repo.Building the site
For now, the site can be generated manually with:
Next steps
Once the project is restructured on top of
logging-parent, these steps (including the NPM installation itself) will be handled automatically by: