Flag antora warnings [DOC-276]
#422
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JackPGreen
requested review from
oliverhowell,
amandalindsay and
Rob-Hazelcast
as code owners
fantkolja
approved these changes
Nov 26, 2024
oliverhowell
approved these changes
Dec 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We already need to build the documentation using Antora to check for dead links - currently we log (and fail) if
errorsare introduced, but we can drop towarnings to further improve quality.Note that it's likely that the existing documentation content already has these problems, so until addressed the exiting warnings are going to get flagged again and again.
An example of the output can be found in this (dummy) PR.
This is an alternative implementation of hazelcast/hz-docs#1397
Fixes: DOC-276, hazelcast/hz-docs#1397