Skip to content

Commit 4ab53dc

Browse files
committed
Fix broken and redirected links in the reference documentation
Fixes gh-18332
1 parent b483e78 commit 4ab53dc

File tree

8 files changed

+34
-35
lines changed

8 files changed

+34
-35
lines changed

spring-boot-project/spring-boot-docs/src/main/asciidoc/attributes.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@
1616
:spring-boot-version: current
1717

1818
:github-repo: spring-projects/spring-boot
19-
:github-raw: https://raw.github.com/{github-repo}/{github-tag}
19+
:github-raw: https://raw.githubusercontent.com/{github-repo}/{github-tag}
2020
:github-issues: https://github.com/{github-repo}/issues/
2121
:github-wiki: https://github.com/{github-repo}/wiki
2222

2323
:code-examples: {sources-root}/main/java/org/springframework/boot/docs
2424
:test-examples: {sources-root}/test/java/org/springframework/boot/docs
2525

2626
:spring-boot-code: https://github.com/{github-repo}/tree/{github-tag}
27-
:spring-boot-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/api
27+
:spring-boot-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/api/
2828
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference
2929
:spring-boot-master-code: https://github.com/{github-repo}/tree/master
3030
:spring-boot-current-docs: https://docs.spring.io/spring-boot/docs/current/reference
3131
:spring-boot-actuator-restapi: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/actuator-api/
32-
:spring-boot-maven-plugin-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/maven-plugin
33-
:spring-boot-gradle-plugin-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/html
32+
:spring-boot-maven-plugin-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/maven-plugin/
33+
:spring-boot-gradle-plugin-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/html/
3434
:spring-boot-gradle-plugin-pdfdocs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/pdf/spring-boot-gradle-plugin-reference.pdf
35-
:spring-boot-gradle-plugin-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/html
35+
:spring-boot-gradle-plugin-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/reference/api/
3636

3737
:spring-boot-module-code: {spring-boot-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot
3838
:spring-boot-module-api: {spring-boot-api}/org/springframework/boot

spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ To build a war file that is both executable and deployable into an external cont
151151
</project>
152152
----
153153

154-
TIP: See the "`<<howto-create-a-deployable-war-file>>`" section for more details on how to create a deployable war file.
154+
TIP: See the "`<<howto.adoc#howto-create-a-deployable-war-file>>`" section for more details on how to create a deployable war file.
155155

156156
Advanced configuration options and examples are available in the {spring-boot-maven-plugin-docs}[plugin info page].
157157

@@ -350,7 +350,7 @@ If your archive already includes libraries, you can use `Libraries.NONE`.
350350

351351
[[build-tool-plugins-find-a-main-class]]
352352
=== Finding a Main Class
353-
If you do not use `Repackager.setMainClass()` to specify a main class, the repackager uses https://asm.ow2.org/[ASM] to read class files and tries to find a suitable class with a `public static void main(String[] args)` method.
353+
If you do not use `Repackager.setMainClass()` to specify a main class, the repackager uses https://asm.ow2.io/[ASM] to read class files and tries to find a suitable class with a `public static void main(String[] args)` method.
354354
An exception is thrown if more than one candidate is found.
355355

356356

spring-boot-project/spring-boot-docs/src/main/asciidoc/deployment.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ Google Cloud has several options that can be used to launch Spring Boot applicat
342342
The easiest to get started with is probably App Engine, but you could also find ways to run Spring Boot in a container with Container Engine or on a virtual machine with Compute Engine.
343343

344344
To run in App Engine, you can create a project in the UI first, which sets up a unique identifier for you and also sets up HTTP routes.
345-
Add a Java app to the project and leave it empty and then use the https://cloud.google.com/sdk/downloads[Google Cloud SDK] to push your Spring Boot app into that slot from the command line or CI build.
345+
Add a Java app to the project and leave it empty and then use the https://cloud.google.com/sdk/install[Google Cloud SDK] to push your Spring Boot app into that slot from the command line or CI build.
346346

347347
App Engine Standard requires you to use WAR packaging.
348348
Follow https://github.com/GoogleCloudPlatform/getting-started-java/blob/master/appengine-standard-java8/springboot-appengine-standard/README.md[these steps] to deploy App Engine Standard application to Google Cloud.

spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ Need more details about Spring Boot's core features?
7777
== Moving to Production
7878
When you are ready to push your Spring Boot application to production, we have <<production-ready-features.adoc#production-ready, some tricks>> that you might like:
7979

80-
* *Management endpoints:* <<production-ready-features.adoc#production-ready-endpoints, Overview>> | <<production-ready-features.adoc#production-ready-customizing-endpoints, Customization>>
80+
* *Management endpoints:* <<production-ready-features.adoc#production-ready-endpoints, Overview>>
8181
* *Connection options:* <<production-ready-features.adoc#production-ready-monitoring, HTTP>> | <<production-ready-features.adoc#production-ready-jmx, JMX>>
82-
* *Monitoring:* <<production-ready-features.adoc#production-ready-metrics, Metrics>> | <<production-ready-features.adoc#production-ready-auditing, Auditing>> | <<production-ready-features.adoc#production-ready-tracing, Tracing>> | <<production-ready-features.adoc#production-ready-process-monitoring, Process>>
82+
* *Monitoring:* <<production-ready-features.adoc#production-ready-metrics, Metrics>> | <<production-ready-features.adoc#production-ready-auditing, Auditing>> | <<production-ready-features.adoc#production-ready-http-tracing, HTTP Tracing>> | <<production-ready-features.adoc#production-ready-process-monitoring, Process>>
8383

8484

8585

spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The Spring Boot auto-configuration tries its best to "`do the right thing`", but
4848

4949
There is a really useful `ConditionEvaluationReport` available in any Spring Boot `ApplicationContext`.
5050
You can see it if you enable `DEBUG` logging output.
51-
If you use the `spring-boot-actuator` (see <<production-ready-features.adoc,the Actuator chapter>>), there is also a `conditions` endpoint that renders the report in JSON.
51+
If you use the `spring-boot-actuator` (see <<production-ready-features.adoc#production-ready,the Actuator chapter>>), there is also a `conditions` endpoint that renders the report in JSON.
5252
Use that endpoint to debug the application and see what features have been added (and which have not been added) by Spring Boot at runtime.
5353

5454
Many more questions can be answered by looking at the source code and the Javadoc.
@@ -80,7 +80,7 @@ There is more than one way to register additional customizations:
8080
* Declaratively, for all applications, by adding a `META-INF/spring.factories` and packaging a jar file that the applications all use as a library.
8181

8282
The `SpringApplication` sends some special `ApplicationEvents` to the listeners (some even before the context is created) and then registers the listeners for events published by the `ApplicationContext` as well.
83-
See "`<<spring-boot-features.adoc#boot-features-application-events-and-listeners>>`" in the '`Spring Boot features`' section for a complete list.
83+
See "`<<spring-boot-features.adoc#boot-features-application-events-and-listeners,Application Events and Listeners>>`" in the '`Spring Boot features`' section for a complete list.
8484

8585
It is also possible to customize the `Environment` before the application context is refreshed by using `EnvironmentPostProcessor`.
8686
Each implementation should be registered in `META-INF/spring.factories`, as shown in the following example:
@@ -397,7 +397,7 @@ There is not (and technically cannot be) an exhaustive list of all supported pro
397397

398398
A running application with the Actuator features has a `configprops` endpoint that shows all the bound and bindable properties available through `@ConfigurationProperties`.
399399

400-
The appendix includes an <<application-properties.adoc#common-application-properties, `application.properties`>> example with a list of the most common properties supported by Spring Boot.
400+
The appendix includes an <<appendix-application-properties.adoc#common-application-properties, `application.properties`>> example with a list of the most common properties supported by Spring Boot.
401401
The definitive list comes from searching the source code for `@ConfigurationProperties` and `@Value` annotations as well as the occasional use of `Binder`.
402402
For more about the exact ordering of loading properties, see "<<spring-boot-features#boot-features-external-config>>".
403403

@@ -643,7 +643,7 @@ Developers can choose to import only the required dependencies using a classifie
643643
=== Configure the Web Server
644644
Generally, you should first consider using one of the many available configuration keys and customize your web server by adding new entries in your `application.properties` (or `application.yml`, or environment, etc. see "`<<howto-discover-build-in-options-for-external-properties>>`").
645645
The `server.{asterisk}` namespace is quite useful here, and it includes namespaces like `server.tomcat.{asterisk}`, `server.jetty.{asterisk}` and others, for server-specific features.
646-
See the list of <<common-application-properties>>.
646+
See the list of <<appendix-application-properties.adoc#common-application-properties>>.
647647

648648
The previous sections covered already many common use cases, such as compression, SSL or HTTP/2.
649649
However, if a configuration key doesn't exist for your use case, you should then look at {spring-boot-module-api}/web/server/WebServerFactoryCustomizer.html[`WebServerFactoryCustomizer`].
@@ -1059,7 +1059,7 @@ These features are described in six enums (in Jackson) that map onto properties
10591059
|===
10601060

10611061
For example, to enable pretty print, set `spring.jackson.serialization.indent_output=true`.
1062-
Note that, thanks to the use of <<boot-features-external-config-relaxed-binding, relaxed binding>>, the case of `indent_output` does not have to match the case of the corresponding enum constant, which is `INDENT_OUTPUT`.
1062+
Note that, thanks to the use of <<spring-boot-features.adoc#boot-features-external-config-relaxed-binding, relaxed binding>>, the case of `indent_output` does not have to match the case of the corresponding enum constant, which is `INDENT_OUTPUT`.
10631063

10641064
This environment-based configuration is applied to the auto-configured `Jackson2ObjectMapperBuilder` bean and applies to any mappers created by using the builder, including the auto-configured `ObjectMapper` bean.
10651065

@@ -1373,7 +1373,7 @@ You also need to add `logging.file.name` to your `application.properties`, as sh
13731373

13741374
[[howto-configure-log4j-for-logging]]
13751375
=== Configure Log4j for Logging
1376-
Spring Boot supports https://logging.apache.org/log4j/2.x[Log4j 2] for logging configuration if it is on the classpath.
1376+
Spring Boot supports https://logging.apache.org/log4j/2.x/[Log4j 2] for logging configuration if it is on the classpath.
13771377
If you use the starters for assembling dependencies, you have to exclude Logback and then include log4j 2 instead.
13781378
If you do not use the starters, you need to provide (at least) `spring-jcl` in addition to Log4j 2.
13791379

@@ -1898,7 +1898,7 @@ Be careful when switching from in-memory to a '`real`' database that you do not
18981898
You either have to set `ddl-auto` explicitly or use one of the other mechanisms to initialize the database.
18991899

19001900
NOTE: You can output the schema creation by enabling the `org.hibernate.SQL` logger.
1901-
This is done for you automatically if you enable the <<boot-features-logging-console-output,debug mode>>.
1901+
This is done for you automatically if you enable the <<spring-boot-features.adoc#boot-features-logging-console-output,debug mode>>.
19021902

19031903
In addition, a file named `import.sql` in the root of the classpath is executed on startup if Hibernate creates the schema from scratch (that is, if the `ddl-auto` property is set to `create` or `create-drop`).
19041904
This can be useful for demos and for testing if you are careful but is probably not something you want to be on the classpath in production.
@@ -2136,7 +2136,7 @@ In general, you need a `View` that resolves with a name of `error` or a `@Contro
21362136
Unless you replaced some of the default configuration, you should find a `BeanNameViewResolver` in your `ApplicationContext`, so a `@Bean` named `error` would be a simple way of doing that.
21372137
See {spring-boot-autoconfigure-module-code}/web/servlet/error/ErrorMvcAutoConfiguration.java[`ErrorMvcAutoConfiguration`] for more options.
21382138

2139-
See also the section on "`<<boot-features-error-handling, Error Handling>>`" for details of how to register handlers in the servlet container.
2139+
See also the section on "`<<spring-boot-features.adoc#boot-features-error-handling, Error Handling>>`" for details of how to register handlers in the servlet container.
21402140

21412141

21422142

@@ -2263,7 +2263,7 @@ See {spring-boot-autoconfigure-module-code}/groovy/template/GroovyTemplateAutoCo
22632263
[[howto-reload-fast-restart]]
22642264
=== Fast Application Restarts
22652265
The `spring-boot-devtools` module includes support for automatic application restarts.
2266-
While not as fast as technologies such as https://zeroturnaround.com/software/jrebel/[JRebel] it is usually significantly faster than a "`cold start`".
2266+
While not as fast as technologies such as https://jrebel.com/software/jrebel/[JRebel] it is usually significantly faster than a "`cold start`".
22672267
You should probably give it a try before investigating some of the more complex reload options discussed later in this document.
22682268

22692269
For more details, see the <<using-spring-boot.adoc#using-boot-devtools>> section.

spring-boot-project/spring-boot-docs/src/main/asciidoc/index.htmladoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ The reference documentation has the following appendices:
2525
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes,Auto-configuration Classes>> :: Auto-configuration classes provided by Spring Boot.
2626
<<appendix-test-auto-configuration.adoc#test-auto-configuration,Test Auto-configuration Annotations>> :: Test-autoconfiguration annotations used to test slices of your application.
2727
<<appendix-executable-jar-format.adoc#executable-jar,Executable Jars>> :: Spring Boot's executable jars, their launchers, and their format.
28-
<<appendix-dependency-versions.adoc#appendex-dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.
28+
<<appendix-dependency-versions.adoc#appendix-dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.

spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ If your application is a web application (Spring MVC, Spring WebFlux, or Jersey)
162162
| Yes
163163
|===
164164

165-
To learn more about the Actuator's endpoints and their request and response formats, please refer to the separate API documentation ({spring-boot-actuator-restapi}/html[HTML] or {spring-boot-actuator-restapi}/pdf/spring-boot-actuator-web-api.pdf[PDF]).
165+
To learn more about the Actuator's endpoints and their request and response formats, please refer to the separate API documentation ({spring-boot-actuator-restapi}/html/[HTML] or {spring-boot-actuator-restapi}/pdf/spring-boot-actuator-web-api.pdf[PDF]).
166166

167167

168168

@@ -1562,7 +1562,7 @@ For advanced configuration, you can also provide your own `PrometheusPushGateway
15621562
[[production-ready-metrics-export-signalfx]]
15631563
==== SignalFx
15641564
SignalFx registry pushes metrics to {micrometer-registry-docs}/signalfx[SignalFx] periodically.
1565-
To export metrics to https://signalfx.com[SignalFx], your access token must be provided:
1565+
To export metrics to https://www.signalfx.com[SignalFx], your access token must be provided:
15661566

15671567
[source,properties,indent=0]
15681568
----
@@ -1658,7 +1658,7 @@ Spring Boot registers the following core metrics when applicable:
16581658
* Logback metrics: record the number of events logged to Logback at each level
16591659
* Uptime metrics: report a gauge for uptime and a fixed gauge representing the application's absolute start time
16601660
* Tomcat metrics (`server.tomcat.mbeanregistry.enabled` must be set to `true` for all Tomcat metrics to be registered)
1661-
* {spring-integration-docs}#micrometer-integration[Spring Integration] metrics
1661+
* {spring-integration-docs}system-management.html#micrometer-integration[Spring Integration] metrics
16621662

16631663

16641664

@@ -2138,6 +2138,6 @@ include::{code-examples}/cloudfoundry/CloudFoundryCustomContextPathExample.java[
21382138
[[production-ready-whats-next]]
21392139
== What to Read Next
21402140
If you want to explore some of the concepts discussed in this chapter, you can take a look at the actuator {spring-boot-code}/spring-boot-samples[sample applications].
2141-
You also might want to read about graphing tools such as https://graphite.wikidot.com/[Graphite].
2141+
You also might want to read about graphing tools such as https://graphiteapp.org[Graphite].
21422142

21432143
Otherwise, you can continue on, to read about <<deployment.adoc#deployment, '`deployment options`'>> or jump ahead for some in-depth information about Spring Boot's _<<build-tool-plugins.adoc#build-tool-plugins, build tool plugins>>_.

0 commit comments

Comments
 (0)