-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate documentation to Antora #4422
Conversation
find modules/ROOT/pages -name "*.adoc" | xargs sed -i 's#image::{batch-asciidoc}images/#image::#'
Thank you for opening the PR! I tested it locally and seems to correctly generate the HTML version of the docs. However, a couple notes:
The goal is to be able to keep the distribution generation process as described in the REAME. If we have that, it won't be necessary to modify the release process (which I would prefer). Otherwise I am open to update the instructions if needed as well. |
Thanks for noticing this. It is not intentional and I've added a commit that corrects this.
At the moment we are not trying to do any other formats. We will likely investigate using Antora Assembler to output PDFs in a later iteration.
The PR has a GitHub action that takes care of pushing your documentation for you. The build is structured in a way that rsync is preferred because it can copy only the files that have changed and sync a single version if that is all that is needed to be built. See https://github.com/spring-projects/spring-batch/pull/4423/files#diff-87e860af4b9db6c503ed680b6edb6333c6f8d7659f7d1a779a2487466bbc50f6R41 |
Rebased, squashed and merged as 2e8d506. Thank you for doing this! |
Migrate to Antora based documentaiton