Skip to content

Reword micrometer shutdown-filters Javadoc to avoid mis-nested AsciiDoc - #1973

Merged
davsclaus merged 1 commit into
apache:mainfrom
ammachado:chore/website-asciidoc-fixes
Sep 14, 2026
Merged

davsclaus merged 1 commit into
apache:mainfrom
ammachado:chore/website-asciidoc-fixes

Conversation

@ammachado

@ammachado ammachado commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Summary

The starters/micrometer page (next and 4.22.x) is one of the 35 documentation pages with no .md twin on the website, see apache/camel-website#1746.

The Javadoc of camel.metrics.log-metrics-on-shutdown-filters is copied into the generated option table of docs/spring-boot/modules/ROOT/pages/starters/micrometer.adoc. It contains two * characters (`*` and `camel.exchanges.*`), which Asciidoctor pairs as constrained bold across the monospace spans:

<code><strong></code> character to log any metrics containing the wildcard, for example <code>camel.exchanges.</strong></code>

Browsers tolerate this, but the website's HTML-to-Markdown step (node-html-parser) loses article.doc and skips the page.

Change

Reword the Javadoc so only one * remains in the table cell:

List of metrics (comma separated) to log when application is shutting down. You can use a wildcard to log any metrics matching a pattern, for example camel.exchanges.* (default to all metrics available).

A +...+ passthrough is avoided on purpose: the same text ends up in the Spring configuration-metadata tooltip, where the + signs would show literally.

micrometer.json and micrometer.adoc are regenerated by building the starter (-pl components-starter/camel-micrometer-starter -am), not edited by hand.

Verification

Rendered the generated micrometer.adoc with Asciidoctor.js and parsed it with the website's node-html-parser:

valid() article.doc found <code>..<strong></code>
before false no (page skipped) 1
after true yes 0

The example still renders as <code>camel.exchanges.*</code>. Module tests were not run: the change touches a Javadoc comment and generated docs only.

The same fix for camel-spring-boot-4.22.x is in #1974. The option does not exist on 4.18.x or 4.14.x.

🤖 Generated with Claude Code on behalf of Adriano Machado (@ammachado)

This was generated by an AI agent and may contain inaccuracies. Please verify before relying on it.

The Javadoc of camel.metrics.log-metrics-on-shutdown-filters is copied
into the generated starters/micrometer.adoc table. Its two `*` characters
(`*` and `camel.exchanges.*`) pair up as AsciiDoc constrained bold across
the monospace spans, so Asciidoctor emits <code>...<strong></code>. The
website's HTML-to-Markdown step cannot recover from that nesting and
skips the page, leaving starters/micrometer.md missing.

Reword the sentence so only one `*` remains. A passthrough (+...+) is
avoided because it would also show up literally in the Spring
configuration-metadata tooltip.

See apache/camel-website#1746

_Claude Code on behalf of Adriano Machado (@ammachado)_

_This was generated by an AI agent and may contain inaccuracies.
Please verify before relying on it._
@davsclaus
davsclaus merged commit 66f3832 into apache:main Sep 14, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants