docs: wrap shorthand admonition blocks in ==== delimiters#53808
Open
rolfedh wants to merge 1 commit intoquarkusio:mainfrom
Open
docs: wrap shorthand admonition blocks in ==== delimiters#53808rolfedh wants to merge 1 commit intoquarkusio:mainfrom
rolfedh wants to merge 1 commit intoquarkusio:mainfrom
Conversation
Across 13 docs guides, single-paragraph admonitions use the bare-attribute shorthand ([NOTE], [TIP], [WARNING] on a line by itself with the next paragraph as content, no ==== delimiters). The shorthand form renders but produces inconsistent output across renderers (Asciidoctor vs. DITA vs. downstream tools) and hinders programmatic content transformation. Wrap each affected block in the explicit `==== ... ====` delimited form, no content changes. Files touched: - aws-lambda-http.adoc - building-my-first-extension.adoc - building-native-image.adoc - getting-started-dev-services.adoc - getting-started-testing.adoc - gradle-tooling.adoc - hibernate-search-orm-elasticsearch.adoc - hibernate-search-standalone-elasticsearch.adoc - mailer-reference.adoc - quarkus-reactive-architecture.adoc - redis-reference.adoc - rest-client.adoc - security-customization.adoc
|
Thanks for your pull request! Your pull request does not follow our editorial rules. Could you have a look?
This message is automatically generated by a bot. |
Status for workflow
|
| Status | Name | Step | Failures | Logs | Raw logs | Build scan |
|---|---|---|---|---|---|---|
| ❌ | Documentation Build | Build |
Failures | Logs | Raw logs | 🚧 |
Failures
⚙️ Documentation Build #
- Failing: docs
📦 docs
❌ Failed to execute goal org.asciidoctor:asciidoctor-maven-plugin:3.2.0:process-asciidoc (output-html) on project quarkus-documentation: Found 2 issue(s) of severity WARN or higher during conversion
This file contains hidden or 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
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.
Summary
Across 13 guides in
docs/src/main/asciidoc/, single-paragraph admonitions use the bare-attribute shorthand ([NOTE]/[TIP]/[WARNING]on a line by itself, followed by a single paragraph, no====delimiters). The shorthand form renders in Asciidoctor but:Wrap each affected block in the explicit
====delimited form. No content changes — 38 lines added, 0 removed, all of them====delimiter lines.Files touched (19 blocks across 13 files)
aws-lambda-http.adocbuilding-my-first-extension.adocbuilding-native-image.adocgetting-started-dev-services.adocgetting-started-testing.adocgradle-tooling.adoc(4 blocks)hibernate-search-orm-elasticsearch.adoc(2 blocks)hibernate-search-standalone-elasticsearch.adoc(2 blocks)mailer-reference.adoc(2 blocks)quarkus-reactive-architecture.adocredis-reference.adocrest-client.adocsecurity-customization.adoc