chore: Antora in charge of single-sourcing and validating content, generating and validating the website #2455
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
|
🎊 Navigate the preview: https://6333ef5278cc094f86586c5d--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
themr0c
commented
Sep 22, 2022
themr0c
changed the title
…ension rather than gulp (and build.sh). chore: Validating content by using local Antora extensions rather than gulp (and build.sh). chore: Consistent output fix: fix build errors and warnings See: https://gitlab.com/antora/antora-collector-extension
themr0c
changed the title
max-cx
approved these changes
Sep 27, 2022
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.
Previously, we were piling up scripts in gulp and build.sh.
With this pull request, Antora is in charge:
Gulp has a more narrowed scope:
In details:
The Antora Collector extension single-sources external content into an uncommitted place (
build/collectorsubdirectories), and register the content to Antora:CheClusterreference./tools/checluster_docs_gen.sh./tools/environment_docs_gen.sh./tools/create_architecture_diagrams.py(New! It was not automated)./tools/detect-unused-content.sh./tools/validate_language_changes.shLocal Antora extensions validate the content:
extensions/antora-to-plain-asciidoc.jsextensions/htmltest.jsin the outputThis pull request also:
Additional resources:
A successful run example:
An error example: