Migrate reference documentation to Antora #390
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR attempts to migrate Reactor Kafka reference documentation to Antora, and includes the following logical commits:
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: