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 reference documentation to Antora #3120

Merged
merged 4 commits into from
Apr 2, 2024
Merged

Conversation

pderop
Copy link
Contributor

@pderop pderop commented Mar 26, 2024

This PR is first attempt to migrate Reactor Netty 1.2.x documentation to Antora

There are three logical commits in this PR:

  • bfb304d: it contains all modifs done in .adoc files, and also contains antora yaml files
  • 7cf6e25: contains all adaptation done in various gradle scripts
  • 5c90740: contains adaptations done in the GH worfklows.

To test this PR, you can proceed like the following:

Testing without PDF:

  • clone this PR
  • switch to java 17 (the docs sub project requires java17)
  • build the doc and generate it to docs/build/site/index.html:
./gradlew antora
  • you can now browse docs/build/site/index.html
  • switch to java 8
  • deploy reactor-netty docs to your local M2
./gradlew publishToMavenLocal
  • now, you can verify the content of ~/.m2/repository/io/projectreactor/netty/reactor-netty/1.2.0-SNAPSHOT/reactor-netty-1.2.0-SNAPSHOT-docs.zip or ~/.m2/repository/io/projectreactor/netty/reactor-netty/1.2.0-SNAPSHOT/reactor-netty-1.2.0-SNAPSHOT-javadoc.jar

Testing with PDF:

As before, PDF are not generated by default in snapshot mode. If you want to also include a PDF in the generated docs zip, then do the following:

  • first, you will need to install asciidoctor-pdf command, because the antora pdf assembler requires it (this command is provided when doing "brew install asciidoctor"):
brew install asciidoctor
  • switch to java17
  • build antora and force PDF generation (in release mode, no need to use -PforcePdf, it's like before):
./gradlew antora -PforcePdf
this will generate  ./docs/build/assembler/reactor-netty/1.2.0/reactor-netty-reference-guide.pdf
  • switch to java 8
  • deploy reactor-netty docs to your local M2:
./gradlew publishToMavenLocal -PforcePdf
  • verify the content of ~/.m2/repository/io/projectreactor/netty/reactor-netty/1.2.0-SNAPSHOT/reactor-netty-1.2.0-SNAPSHOT-docs.zip, which should also include a pdf in the root dir of the zip.

@pderop pderop added the type/enhancement A general enhancement label Mar 26, 2024
@pderop pderop added this to the 1.2.0-M1 milestone Mar 26, 2024
@pderop pderop self-assigned this Mar 26, 2024
@pderop pderop requested a review from violetagg March 26, 2024 16:55
@pderop
Copy link
Contributor Author

pderop commented Mar 26, 2024

force-pushed for centralizing antora versions in top level build.gradle

docs/antora-playbook.yml Outdated Show resolved Hide resolved
@violetagg
Copy link
Member

@pderop Nice! Let's merge it!

@pderop
Copy link
Contributor Author

pderop commented Apr 2, 2024

@violetagg , thank you for your review !

@pderop pderop merged commit 65ea125 into reactor:main Apr 2, 2024
14 checks passed
@pderop pderop deleted the 1.2.x-antora branch April 2, 2024 12:17
@violetagg violetagg added type/documentation A documentation update and removed type/enhancement A general enhancement labels Apr 2, 2024
@violetagg violetagg changed the title Migrate 1.2.x doc to Antora Migrate reference documentation to Antora Apr 2, 2024
pderop added a commit that referenced this pull request Apr 2, 2024
@violetagg violetagg changed the title Migrate reference documentation to Antora Migrate reference documentation to Antora Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants