Skip to content

Commit 20d21a8

Browse files
committed
Rework links to Spring Boot in reference docs
Closes gh-33776
1 parent d8a6423 commit 20d21a8

File tree

11 files changed

+13
-12
lines changed

11 files changed

+13
-12
lines changed

framework-docs/antora.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ asciidoc:
4242
spring-framework-reference: '{spring-framework-docs-root}/{spring-version}/reference'
4343
#
4444
# Other Spring portfolio projects
45-
spring-boot-docs: '{docs-site}/spring-boot/docs/current/reference/html'
45+
spring-boot-docs: '{docs-site}/spring-boot'
46+
spring-boot-docs-ref: '{spring-boot-docs}/reference'
4647
spring-boot-issues: '{spring-github-org}/spring-boot/issues'
4748
# TODO add more projects / links or just build up on {docs-site}?
4849
# TODO rename the below using new conventions

framework-docs/modules/ROOT/pages/core/spring-jcl.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ known as _JUL_ or `java.util.logging`) if neither Log4j 2.x nor SLF4J is availab
99

1010
Put Log4j 2.x or Logback (or another SLF4J provider) in your classpath, without any extra
1111
bridges, and let the framework auto-adapt to your choice. For further information see the
12-
{spring-boot-docs}/features.html#features.logging[Spring
12+
{spring-boot-docs-ref}/features/logging.html[Spring
1313
Boot Logging Reference Documentation].
1414

1515
[NOTE]

framework-docs/modules/ROOT/pages/integration/observability.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Metrics can help you to track error rates, usage patterns, performance, and more
77
Traces provide a holistic view of an entire system, crossing application boundaries; you can zoom in on particular user requests and follow their entire completion across applications.
88

99
Spring Framework instruments various parts of its own codebase to publish observations if an `ObservationRegistry` is configured.
10-
You can learn more about {spring-boot-docs}/actuator.html#actuator.metrics[configuring the observability infrastructure in Spring Boot].
10+
You can learn more about {spring-boot-docs-ref}/actuator/observability.html[configuring the observability infrastructure in Spring Boot].
1111

1212

1313
[[observability.list]]

framework-docs/modules/ROOT/pages/languages/kotlin.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Most of the code samples of the reference documentation are
1313
provided in Kotlin in addition to Java.
1414

1515
The easiest way to build a Spring application with Kotlin is to leverage Spring Boot and
16-
its {spring-boot-docs}/boot-features-kotlin.html[dedicated Kotlin support].
16+
its {spring-boot-docs-ref}/features/kotlin.html[dedicated Kotlin support].
1717
{spring-site-guides}/tutorials/spring-boot-kotlin/[This comprehensive tutorial]
1818
will teach you how to build Spring Boot applications with Kotlin using https://start.spring.io/#!language=kotlin&type=gradle-project[start.spring.io].
1919

framework-docs/modules/ROOT/pages/languages/kotlin/spring-projects-in.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Therefore, if you wish to use the `@Value` annotation in Kotlin, you need to esc
186186
character by writing pass:q[`@Value("\${property}")`].
187187

188188
NOTE: If you use Spring Boot, you should probably use
189-
{spring-boot-docs}/boot-features-external-config.html#boot-features-external-config-typesafe-configuration-properties[`@ConfigurationProperties`]
189+
{spring-boot-docs-ref}/features/external-config.html#features.external-config.typesafe-configuration-properties[`@ConfigurationProperties`]
190190
instead of `@Value` annotations.
191191

192192
As an alternative, you can customize the property placeholder prefix by declaring the
@@ -323,7 +323,7 @@ The recommended testing framework is https://junit.org/junit5/[JUnit 5] along wi
323323
https://mockk.io/[Mockk] for mocking.
324324

325325
NOTE: If you are using Spring Boot, see
326-
{spring-boot-docs}/features.html#features.kotlin.testing[this related documentation].
326+
{spring-boot-docs-ref}/features/kotlin.html#features.kotlin.testing[this related documentation].
327327

328328

329329
[[constructor-injection]]

framework-docs/modules/ROOT/pages/testing/mockmvc/hamcrest/vs-streaming-response.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ streams because there is no way to cancel the server stream from the client side
77
To test infinite streams, you'll need to
88
xref:testing/webtestclient.adoc#webtestclient-server-config[bind to] a running server,
99
or when using Spring Boot,
10-
{spring-boot-docs}/spring-boot-features.html#boot-features-testing-spring-boot-applications-testing-with-running-server[test with a running server].
10+
{spring-boot-docs-ref}/testing/spring-boot-applications.html#testing.spring-boot-applications.with-running-server[test with a running server].
1111

1212
`MockMvcWebTestClient` does support asynchronous responses, and even streaming responses.
1313
The limitation is that it can't influence the server to stop, and therefore the server

framework-docs/modules/ROOT/pages/testing/mockmvc/vs-end-to-end-integration-tests.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ for rendering JSON, XML, and other formats through `@ResponseBody` methods.
2121

2222
Alternatively, you may consider the full end-to-end integration testing support from
2323
Spring Boot with `@SpringBootTest`. See the
24-
{spring-boot-docs}/spring-boot-features.html#boot-features-testing[Spring Boot Reference Guide].
24+
{spring-boot-docs-ref}/testing/spring-boot-applications.html[Spring Boot Reference Guide].
2525

2626
There are pros and cons for each approach. The options provided in Spring MVC Test are
2727
different stops on the scale from classic unit testing to full integration testing. To be

framework-docs/modules/ROOT/pages/web/webflux/config.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Kotlin::
4747
NOTE: When using Spring Boot, you may want to use `@Configuration` classes of type `WebFluxConfigurer` but without
4848
`@EnableWebFlux` to keep Spring Boot WebFlux customizations. See more details in
4949
xref:#webflux-config-customize[the WebFlux config API section] and in
50-
{spring-boot-docs}/web.html#web.reactive.webflux.auto-configuration[the dedicated Spring Boot documentation].
50+
{spring-boot-docs-ref}/web/reactive.html#web.reactive.webflux.auto-configuration[the dedicated Spring Boot documentation].
5151

5252
The preceding example registers a number of Spring WebFlux
5353
xref:web/webflux/dispatcher-handler.adoc#webflux-special-bean-types[infrastructure beans] and adapts to dependencies

framework-docs/modules/ROOT/pages/web/webmvc/mvc-config/enable.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can use the `@EnableWebMvc` annotation to enable MVC configuration with prog
77

88
include-code::./WebConfiguration[tag=snippet,indent=0]
99

10-
NOTE: When using Spring Boot, you may want to use `@Configuration` classes of type `WebMvcConfigurer` but without `@EnableWebMvc` to keep Spring Boot MVC customizations. See more details in xref:web/webmvc/mvc-config/customize.adoc[the MVC Config API section] and in {spring-boot-docs}/web.html#web.servlet.spring-mvc.auto-configuration[the dedicated Spring Boot documentation].
10+
NOTE: When using Spring Boot, you may want to use `@Configuration` classes of type `WebMvcConfigurer` but without `@EnableWebMvc` to keep Spring Boot MVC customizations. See more details in xref:web/webmvc/mvc-config/customize.adoc[the MVC Config API section] and in {spring-boot-docs-ref}/web/servlet.html#web.servlet.spring-mvc.auto-configuration[the dedicated Spring Boot documentation].
1111

1212
The preceding example registers a number of Spring MVC
1313
xref:web/webmvc/mvc-servlet/special-bean-types.adoc[infrastructure beans] and adapts to dependencies

framework-docs/modules/ROOT/pages/web/webmvc/mvc-config/message-converters.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can also customize the list of configured message converters at the end by o
1111

1212
TIP: In a Spring Boot application, the `WebMvcAutoConfiguration` adds any
1313
`HttpMessageConverter` beans it detects, in addition to default converters. Hence, in a
14-
Boot application, prefer to use the {spring-boot-docs}/web.html#web.servlet.spring-mvc.message-converters[HttpMessageConverters]
14+
Boot application, prefer to use the {spring-boot-docs-ref}/web/servlet.html#web.servlet.spring-mvc.message-converters[HttpMessageConverters]
1515
mechanism. Or alternatively, use `extendMessageConverters` to modify message converters
1616
at the end.
1717

framework-docs/modules/ROOT/pages/web/webmvc/mvc-servlet.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ the lifecycle of the Servlet container, Spring Boot uses Spring configuration to
111111
bootstrap itself and the embedded Servlet container. `Filter` and `Servlet` declarations
112112
are detected in Spring configuration and registered with the Servlet container.
113113
For more details, see the
114-
{spring-boot-docs}/web.html#web.servlet.embedded-container[Spring Boot documentation].
114+
{spring-boot-docs-ref}/web/servlet.html#web.servlet.embedded-container[Spring Boot documentation].
115115

116116

117117

0 commit comments

Comments
 (0)