Skip to content

fix(docs): correct URLs and enhance clarity in documentation#5158

Open
SteKoe wants to merge 13 commits intomasterfrom
docs/refine
Open

fix(docs): correct URLs and enhance clarity in documentation#5158
SteKoe wants to merge 13 commits intomasterfrom
docs/refine

Conversation

@SteKoe
Copy link
Contributor

@SteKoe SteKoe commented Mar 13, 2026

No description provided.

@SteKoe SteKoe requested a review from a team as a code owner March 13, 2026 10:16
Copilot AI review requested due to automatic review settings March 13, 2026 10:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Spring Boot Admin documentation to fix incorrect URLs and improve clarity around upgrade notes, Jolokia/JMX guidance, clustering behavior, and security configuration examples.

Changes:

  • Update Spring Boot Admin 4 upgrade notes to reflect current Jolokia compatibility guidance.
  • Improve/modernize documentation links and wording (e.g., Thymeleaf link formatting, snapshot repo URL, clustering explanation).
  • Update code snippets in docs (e.g., Spring Security matcher examples, Jolokia artifactIds, reactive status updater example).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Updates Jolokia compatibility section and related upgrade checklist wording.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Adjusts a reactive example by removing a timeout operator in the snippet.
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Adds clarification note for Jolokia artifacts and fixes Spring Boot 3 artifactId format.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf link syntax for MDX rendering.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Clarifies clustering behavior and operational implications (polling/load).
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates Spring Security matcher examples to PathPatternRequestMatcher.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes snapshot repository URL typo to a valid HTTPS URL.
Comments suppressed due to low confidence (1)

spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md:66

  • The Jolokia dependency examples hard-code version 2.5.0, but the project BOM currently manages jolokia-support-springboot at 2.5.1 (see root pom property jolokia-support-springboot.version). To avoid drift and copy/paste of an outdated version, update this snippet to the managed version or omit the <version> and mention relying on dependency management.
```xml title="pom.xml"
<dependency>
    <groupId>org.jolokia</groupId>
    <artifactId>jolokia-support-springboot</artifactId>
    <version>2.5.0</version>
</dependency>

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 10:21
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-focused PR improving clarity and fixing/modernizing links and snippets across the Spring Boot Admin docs, especially around Spring Boot Admin 4 upgrading guidance and Jolokia/JMX setup.

Changes:

  • Update Spring Boot Admin 4 upgrade notes for Jolokia compatibility and related checklist wording.
  • Clarify Jolokia artifact naming for Spring Boot 3 vs 4 and adjust dependency snippets.
  • Fix/modernize documentation links and improve wording in several server docs (mail notifier, clustering, security snippet, snapshot repository URL).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Updates Jolokia compatibility guidance and related migration checklist items.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Adjusts a custom StatusUpdater example (removes Reactor .timeout(...)).
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Clarifies Jolokia artifact names for Boot 3 vs 4 and updates Maven snippets.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf link formatting for MDX.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Rewords clustering behavior explanation for clarity.
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates security snippet to use PathPatternRequestMatcher instead of AntPathRequestMatcher.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes snapshot repository URL scheme/typo.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 10:28
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Spring Boot Admin’s documentation to correct broken URLs and improve clarity around configuration and dependencies, particularly for Jolokia/JMX usage and Spring Security matcher examples.

Changes:

  • Update the SBA 4 upgrade guide’s Jolokia compatibility notes and related checklist items.
  • Clarify Jolokia artifact naming for Spring Boot 3 vs 4 in the client features documentation.
  • Fix/modernize several docs snippets and links (snapshot repo URL, MDX links, clustering explanation, security matcher examples).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Updates Jolokia guidance in the SBA 4 upgrade guide and adjusts upgrade checklist wording.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Adjusts a customization example snippet for status updating.
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Clarifies Jolokia Spring Boot integration artifact naming for Boot 3 vs Boot 4 and updates dependency snippets.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf link formatting for MDX.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Rewords clustering behavior explanation for clarity.
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates security examples to use PathPatternRequestMatcher patterns.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes the Sonatype/Spring snapshot repository URL.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 10:46
SteKoe and others added 2 commits March 13, 2026 11:46
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Spring Boot Admin’s documentation to correct broken/incorrect URLs and refresh guidance around Jolokia/Spring Boot 4 and Spring Security matcher APIs, improving accuracy and clarity across the docs site.

Changes:

  • Update the Spring Boot Admin 4 upgrade guide’s Jolokia section to reflect Jolokia 2.5.x and current client requirements.
  • Improve/modernize documentation snippets and links (e.g., Thymeleaf link formatting, Spring snapshot repository URL).
  • Clarify operational behavior text (e.g., clustering application polling behavior) and update Spring Security matcher examples to PathPatternRequestMatcher.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Refreshes Jolokia compatibility/requirements messaging for SBA 4 upgrades.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Adjusts example code for custom health status updating.
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Clarifies Jolokia artifact naming for Spring Boot 3 vs 4 and updates dependency examples.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf link formatting for MDX.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Rewords clustering behavior explanation for clarity.
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates Spring Security examples from AntPathRequestMatcher to PathPatternRequestMatcher.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes malformed Spring snapshot repository URL.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 10:54
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-focused PR to improve accuracy and clarity across Spring Boot Admin docs, notably around Jolokia/JMX configuration and general reference links.

Changes:

  • Update Jolokia/JMX documentation for Spring Boot Admin 4 and client setup (artifact names, versions, guidance).
  • Improve/modernize documentation snippets (Spring Security matcher usage, custom status updater example).
  • Fix or modernize documentation links and wording (Thymeleaf link formatting, clustering explanation, snapshot repo URL).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Updates Jolokia compatibility guidance in the SBA 4 upgrade guide.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Fixes/improves the custom health status updater example code.
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Clarifies Jolokia Spring Boot integration artifacts and replaces pinned versions with placeholders.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf URL formatting using proper MDX/Markdown link syntax.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Clarifies clustering behavior and implications for load on monitored services.
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates the Spring Security example to use PathPatternRequestMatcher.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes the Spring snapshot repository URL.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 11:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-focused PR that updates Spring Boot Admin docs for accuracy (notably around Jolokia/Spring Boot 4), fixes broken URLs/link formatting, and improves explanatory wording in a few sections.

Changes:

  • Update the Spring Boot Admin 4 upgrade guide to reflect current Jolokia compatibility and clarify client-side dependency requirements for JMX.
  • Improve multiple documentation pages with corrected/modernized links and clearer wording (mail notifier, clustering).
  • Update code samples (custom status updater; security configuration) to reflect newer APIs/usage patterns.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Updates Jolokia guidance for SBA 4 / SB 4 and adjusts upgrade checklist wording.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Refines the custom health status updater example implementation.
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Clarifies Jolokia artifact naming for SB4 vs SB3 and replaces hardcoded versions with placeholders.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf link formatting for MDX/Markdown.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Improves wording explaining clustering behavior and operational impact.
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates security code sample to use PathPatternRequestMatcher instead of AntPathRequestMatcher.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes an invalid snapshot repository URL.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 11:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Spring Boot Admin documentation to correct outdated Jolokia guidance and improve clarity/formatting across several docs pages.

Changes:

  • Update Spring Boot Admin 4 upgrade notes to reflect Jolokia 2.5.x compatibility and clarify client-side dependencies for JMX-Bean management.
  • Improve Jolokia dependency guidance in client features documentation (artifact naming, placeholders).
  • Fix and modernize various doc links/wording (Thymeleaf link formatting, snapshot repo URL, clustering explanation, security matcher example).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Updates Jolokia compatibility guidance for SBA 4 upgrading and links to JMX-Bean management details.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Adjusts a custom StatusUpdater example for health endpoint overrides.
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Clarifies Jolokia Spring Boot integration artifacts for Boot 3 vs 4 and updates dependency snippets.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf URL formatting to proper Markdown link syntax.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Rewords clustering behavior to better explain polling/load implications.
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates security config example to use PathPatternRequestMatcher with HTTP-method-specific matchers.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes snapshot repository URL typo and upgrades to https.

You can also share your feedback on Copilot code review. Take the survey.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 13, 2026 11:35
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Spring Boot Admin documentation to correct broken URLs and clarify Jolokia/Spring Boot 4 guidance, plus improves readability of several docs examples.

Changes:

  • Clarifies Jolokia compatibility and dependency selection for Spring Boot Admin 4 / Spring Boot 3 vs 4 clients.
  • Fixes/normalizes documentation links (e.g., Thymeleaf link formatting; Spring snapshot repo URL).
  • Improves clarity of clustering and status-updater example snippets.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
spring-boot-admin-docs/src/site/docs/11-upgrading/01-spring-boot-admin-4.md Updates upgrade guidance, especially around Jolokia integration for SBA 4.
spring-boot-admin-docs/src/site/docs/06-customization/monitoring/02-custom-health-status.md Adjusts custom health status updater example code.
spring-boot-admin-docs/src/site/docs/03-client/10-client-features.md Clarifies Jolokia artifact naming for Spring Boot 3 vs 4 and avoids hardcoding versions.
spring-boot-admin-docs/src/site/docs/02-server/notifications/notifier-mail.mdx Fixes Thymeleaf link syntax for MDX rendering.
spring-boot-admin-docs/src/site/docs/02-server/20-Clustering.mdx Rewords clustering explanation for clarity.
spring-boot-admin-docs/src/site/docs/02-server/02-security.md Updates Spring Security snippet to PathPatternRequestMatcher and method matchers.
spring-boot-admin-docs/src/site/docs/01-getting-started/50-snapshots.md Fixes snapshot repository URL typo (http → https).

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +244 to 249
return this.instanceWebClient.instance(instance)
.get()
.uri(customHealthPath)
.exchangeToMono(this::convertStatusInfo)
.timeout(getTimeoutWithMargin())
.onErrorResume(this::handleError)
.map(instance::withStatusInfo);
Comment on lines 15 to +16

import org.springframework.http.HttpMethod;
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