Fix Docs generation - allow each table to have Duration note #26305
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
Fixes: 19330 Currently where 2+ tables with generated configuration properties are included in `adoc` file and these config tables contain `Duration` config key, an exception is thrown and documentation build fails. That's because block id must be unique and [Asciidoctor documentation explain how to solve this problem](https://docs.asciidoctor.org/asciidoc/latest/directives/include-multiple-times-in-same-document/). As I read it in order to use solution, [I had](asciidoctor/asciidoctor#1381) to switch from [legacy block anchor syntax](https://docs.asciidoctor.org/asciidoc/latest/attributes/id/#block-assignment) to longhand syntax. I mentioned you are using workaround `no-duration-note`, but that's not desirable as each summary table should have it's Duration note if needed, however I left possibility to to disable duration note as an option for authors (f.e. you have multiple tables one after another and you feel the note should be included just after the last one...). I checked and there are no changes required to quarkusio.github.io as there is no specific styling applied base on note block id.
+1 |
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.
Fixes: #19330
Currently when 2+ tables with generated configuration properties are included in
adocfile and these config tables containDurationconfig key, an exception is thrown and documentation build fails. That's because block id must be unique and Asciidoctor documentation explain how to solve this problem. As I read it in order to use solution, I had to switch from legacy block anchor syntax to longhand syntax. I mentioned you are using workaroundno-duration-note, but that's not desirable as each summary table should have it's Duration note if needed, however I left possibility to disable duration note as an option for authors (f.e. you have multiple tables one after another and you feel the note should be included just after the last one...). I checked the quarkusio.github.io and there are no changes required to quarkusio.github.io as there is no specific styling applied base on note block id.As an example, you can checkout current upstream doc for Datasources and compare it with attached example that I generated with changes included in this PR.
generated_datasource_guide_2_durations.tar.gz