This is an automated email from the ASF dual-hosted git repository. asf-gitbox-commits pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/tapestry-5-site.git
commit 2e6b8ae26c306362ce4a0c0f4b8d830c58c9f9ba Author: Volker Lamp <[email protected]> AuthorDate: Wed Jul 17 21:19:16 2024 +0200 Added a description of the migration strategy. --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b0bb5cc..30c7c90 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ # tapestry-antora-site-poc-content +## About Proof of concept of how the Tapestry website and documentation could be based on Antora. Intended for futher discussion with the Tapestry team. This repo exclusively contains the website and documentation sources. -See the `tapestry-antora-site-poc-builder` repo for how Antora is configured to build a static website from these sources. +See the [tapestry-antora-site-poc-builder](https://github.com/vjlamp/tapestry-antora-site-poc-builder) repo for how Antora is configured to build a static website from these sources. + +## Why isn't this hosted in an official Apache repo? +We may convert it into one eventually. +To get started, this personal repo was a quick and easy for me to have a shared repo - essential for the intended Antora setup. + +## Migration Strategy +Currently, the Tapestry website is generated from a Confluence Wiki hosted by the Apache Software Foundation. +In contrast, Antora works with Asciidoc sources. +The strategy is to migrate the content manually. +. Copy the content from the current Tapestry website and paste it into the corresponding Asciidoc page. +. Enhance the source by recreating (i.e. adding missing) typography and by adding `javadoc:` and `issue:` macros where appropriate. +. Copy the Asciidoc page to the version branches. +. For each version branch, remove content no longer, or not yet, relevant for that branch. + +Using automated scripts to convert Confluence sources to Asciidoc sources could be of some use. However, the larger part of the work is to split up the version-specific parts across the branches. Probably not worth the time to develop scripts for that. + +## Contributing +* This is hosted on GitHub so please feel invited to send pull requests. +* If you would, please follow the [One sentence per line](https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line) principle. +
