Fix documentation inconsistencies - #50800
Merged
wilkinsona merged 1 commit intoJun 24, 2026
Merged
Conversation
Member
|
Thanks very much, @doehyunbaek. Of the 6 inconsistencies, 5 apply to main but one (number 5) applies to 4.0.x and main. Would you mind dropping 5 (commit a35391b) from this PR and opening a new PR for that change which uses 4.0.x as its base branch? |
doehyunbaek
force-pushed
the
report-candidates-doc-fixes
branch
from
June 24, 2026 11:15
11d99f1 to
c66d494
Compare
Contributor
Author
|
Hi @wilkinsona. I opened a separate PR #50842 and made this PR contain only five commits bound to main. I'm not super confident I did everything right but hope I didn't mess up! Thank you very much for reviewing my PR. |
Signed-off-by: Doehyun Baek <doehyunbaek@gmail.com> See spring-projectsgh-50800
wilkinsona
force-pushed
the
report-candidates-doc-fixes
branch
from
June 24, 2026 14:44
c66d494 to
f7c2c0b
Compare
Member
|
You didn't mess up at all. Thanks very much for doing that and for the PR in general. Much appreciated. |
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.
I found five documentation issues that still appear to be present on current
mainas of f71e797.1. RestTemplateBuilder docs reference deprecated
rootUriAPIThe
@RestClientTestdocumentation still describesRestTemplateBuilder.rootUri(String)behavior:spring-boot/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/testing/spring-boot-applications.adoc
Lines 743 to 747 in f71e797
But
RestTemplateBuilder.rootUri(String)is deprecated in favor ofRestTemplateBuilder.baseUri(String):Introduced by:
2. LiveReload is documented as deprecated in one place but active elsewhere
The devtools reference documentation marks LiveReload as deprecated:
spring-boot/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/using/devtools.adoc
Line 285 in f71e797
But the Maven plugin and hotswapping documentation still present LiveReload as an active devtools feature without mentioning its deprecation:
Introduced by:
3. RabbitMQ Streams docs mention only the non-SSL port
The service connection docs state that RabbitMQ Streams containers need port
5552exposed:spring-boot/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/dev-services.adoc
Lines 131 to 132 in f71e797
But when SSL is configured, the connection details code uses port
5551:Introduced by:
4. Log4j2 rotation docs contain a typo
The logging documentation says
Logback of Log4J2:spring-boot/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/logging.adoc
Line 218 in f71e797
This should be
Logback or Log4j2.Introduced by:
5. OAuth2 provider documentation omits
xOAuth2ClientPropertiesdocuments the common OAuth2 providers asgoogle,github,facebook, andokta:spring-boot/module/spring-boot-security-oauth2-client/src/main/java/org/springframework/boot/security/oauth2/client/autoconfigure/OAuth2ClientProperties.java
Lines 81 to 82 in f71e797
But Spring Security 7.1.0's
CommonOAuth2Provideralso includesX:https://github.com/spring-projects/spring-security/blob/7.1.0/config/src/main/java/org/springframework/security/config/oauth2/client/CommonOAuth2Provider.java#L91-L102
Introduced by:
This PR fixes the above five issues.