Skip to content

docs: wrap shorthand admonition blocks in ==== delimiters#53808

Open
rolfedh wants to merge 1 commit intoquarkusio:mainfrom
rolfedh:docs-fix-admonition-delimiters
Open

docs: wrap shorthand admonition blocks in ==== delimiters#53808
rolfedh wants to merge 1 commit intoquarkusio:mainfrom
rolfedh:docs-fix-admonition-delimiters

Conversation

@rolfedh
Copy link
Copy Markdown
Contributor

@rolfedh rolfedh commented Apr 24, 2026

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:

  • produces inconsistent output across renderers (Asciidoctor vs. DITA vs. downstream tooling),
  • hinders programmatic content transformation (linters and doc pipelines have to special-case both forms).

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.adoc
  • building-my-first-extension.adoc
  • building-native-image.adoc
  • getting-started-dev-services.adoc
  • getting-started-testing.adoc
  • gradle-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.adoc
  • redis-reference.adoc
  • rest-client.adoc
  • security-customization.adoc

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
@quarkus-bot
Copy link
Copy Markdown

quarkus-bot Bot commented Apr 24, 2026

Thanks for your pull request!

Your pull request does not follow our editorial rules. Could you have a look?

  • title should preferably start with an uppercase character (if it makes sense!)
  • title should not start with chore/docs/feat/fix/refactor but be a proper sentence

This message is automatically generated by a bot.

@quarkus-bot
Copy link
Copy Markdown

quarkus-bot Bot commented Apr 24, 2026

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit dc6be24.

Failing Jobs

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant