Skip to content
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

Closed
wants to merge 18 commits into from
Closed

Conversation

rwinch
Copy link
Member

@rwinch rwinch commented Jul 21, 2023

Migrate to Antora based documentaiton

@fmbenhassine
Copy link
Contributor

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:

  • Is it intended that resources are duplicated in modules/ROOT/assets/images and src/main/asciidoc/images?
  • I noticed that the asciidoctor-maven-plugin was removed. Therefore the pdf and epub3 versions are not generated anymore. Is it possible to generate them with the antora-maven-plugin?
  • The maven-deploy-plugin was removed as well. This was required to skip deploying the docs as part of the release process as we have a separate action for that (and that is on purpose). Anything needed to update here?

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.

@rwinch
Copy link
Member Author

rwinch commented Aug 28, 2023

Is it intended that resources are duplicated in modules/ROOT/assets/images and src/main/asciidoc/images?

Thanks for noticing this. It is not intentional and I've added a commit that corrects this.

I noticed that the asciidoctor-maven-plugin was removed. Therefore the pdf and epub3 versions are not generated anymore. Is it possible to generate them with the antora-maven-plugin?

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 maven-deploy-plugin was removed as well. This was required to skip deploying the docs as part of the release process as we have a separate action for that (and that is on purpose). Anything needed to update here?

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

@fmbenhassine fmbenhassine added this to the 5.1.0-M3 milestone Aug 29, 2023
fmbenhassine pushed a commit that referenced this pull request Sep 6, 2023
@fmbenhassine
Copy link
Contributor

Rebased, squashed and merged as 2e8d506. Thank you for doing this!

@fmbenhassine fmbenhassine changed the title Antora Migrate documentation to Antora Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants