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 #390

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

pderop
Copy link
Contributor

@pderop pderop commented Jun 5, 2024

This PR attempts to migrate Reactor Kafka reference documentation to Antora, and includes the following logical commits:

  • 492f407: moved adoc files to Antora directory structure
  • ee74aea: added source highligher
  • a2c98ec: adapted adoc files to Antora
  • 20becb5: updated gradle version to be able to build antora docs using jdk version >= 17
  • 8a28b2d: added antora yaml files
  • b27e675: adapted gradle scripts for antora
  • 6e0e8b5: updated github publish workflow in order to build docs using JDK17+ version separately

How to build and publish the doc to your local M2:

You must install two JDKs in your system: JDK8 (used to build and test everything, as before), and a JDK17 compatible JDK version (>= 17) that is required to build the antora docs.

if you only install JDK8, the documentation won't be generated and won't be included in your local M2 when doing for example ./gradlew publishToMavenLocal).

Now, there are two ways to build and publish the doc: in two steps or in one shot.

Building or publishing the doc in one shot:

Set the current active JDK to the one that is compatible with JDK17, then type usual commands to build and/or deploy the docs (./gradlew docs or ./gradlews publishToMavenLocal)

if you need to also include PDF, then add -PforcePdf option in the gradle options.

the JDK17+ version is only used to generate the doc, everything else is built using your other JDK8 version.

Building or publishing the doc in two steps:

if you need to build reactor-kafka using JDK8, then you need to build the doc in two steps:

  • step 1: set the current active JDK to the one that is compatible to JDK17+ version, then generate the doc with ./gadlew docs or ./gradlew docs -PforcePdf

  • step 2: set the current active JDK version to the JDK8 JDK, then when you type ./gradlew publishToMavenLocal or ./gradlew publishToMavenLocal -PforcePdf, the reactor-kafka--SNAPSHOT-docs.zip artifact will also be published in your local M2 (it will include the docs generated in previous step 1).

Notes:

  • if you only install JDK8, doing ./gradlew docs won't work, and ./gradlew publishToMavenLocal won't include the reactor-kafka--SNAPSHOT-docs.zip file.

  • when also generating PDF documentation, you first need to pre install the asciidoctor-pdf tool because the antora pdf assembler requires it:

brew install asciidoctor

@pderop pderop added the type/documentation A documentation update label Jun 5, 2024
@pderop pderop added this to the 1.4.0-M2 milestone Jun 5, 2024
@pderop pderop self-assigned this Jun 5, 2024
@pderop pderop requested review from a team June 5, 2024 14:18
@pderop
Copy link
Contributor Author

pderop commented Jun 5, 2024

@violetagg , or @chemicL ,

can someone of you please have a look ?

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.

None yet

1 participant