Skip to content

Commit e325b88

Browse files
committed
Merge pull request #19936 from dreis2211
* pr/19936: Fix broken documentation links Closes gh-19936
2 parents 51f6256 + b49e01f commit e325b88

File tree

8 files changed

+17
-17
lines changed

8 files changed

+17
-17
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@
2727
: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
30-
:spring-boot-current-docs: https://docs.spring.io/spring-boot/docs/current/reference
30+
: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/
3232
:spring-boot-maven-plugin-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/maven-plugin/html/
3333
: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/api/
35+
:spring-boot-gradle-plugin-api: https://docs.spring.io/spring-boot/docs/{spring-boot-version}/gradle-plugin/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/docs/asciidoc/documentation-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ It serves as a map for the rest of the document.
1111
== About the Documentation
1212
The Spring Boot reference guide is available as:
1313

14-
* {spring-boot-docs}/html[Multi-page HTML]
15-
* {spring-boot-docs}/htmlsingle[Single page HTML]
14+
* {spring-boot-docs}/html/[Multi-page HTML]
15+
* {spring-boot-docs}/htmlsingle/[Single page HTML]
1616
* {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
1717

1818
The latest copy is available at {spring-boot-current-docs}.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -703,7 +703,7 @@ To do so, insert the following lines just below the `dependencies` section:
703703

704704
NOTE: The `spring-boot-starter-parent` POM includes `<executions>` configuration to bind the `repackage` goal.
705705
If you do not use the parent POM, you need to declare this configuration yourself.
706-
See the {spring-boot-maven-plugin-docs}/usage.html[plugin documentation] for details.
706+
See the {spring-boot-maven-plugin-docs}#getting-started[plugin documentation] for details.
707707

708708
Save your `pom.xml` and run `mvn package` from the command line, as follows:
709709

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ NOTE: Only production configuration is filtered that way (in other words, no fil
156156
TIP: If you enable the `addResources` flag, the `spring-boot:run` goal can add `src/main/resources` directly to the classpath (for hot reloading purposes).
157157
Doing so circumvents the resource filtering and this feature.
158158
Instead, you can use the `exec:java` goal or customize the plugin's configuration.
159-
See the {spring-boot-maven-plugin-docs}/usage.html[plugin usage page] for more details.
159+
See the {spring-boot-maven-plugin-docs}#getting-started[plugin usage page] for more details.
160160

161161
If you do not use the starter parent, you need to include the following element inside the `<build/>` element of your `pom.xml`:
162162

@@ -2224,7 +2224,7 @@ If you define a `@Configuration` with a `WebSecurityConfigurerAdapter` in your a
22242224
[[howto-change-the-user-details-service-and-add-user-accounts]]
22252225
=== Change the UserDetailsService and Add User Accounts
22262226
If you provide a `@Bean` of type `AuthenticationManager`, `AuthenticationProvider`, or `UserDetailsService`, the default `@Bean` for `InMemoryUserDetailsManager` is not created.
2227-
This means you have the full feature set of Spring Security available (such as {spring-security-docs}#jc-authentication[various authentication options]).
2227+
This means you have the full feature set of Spring Security available (such as {spring-security-docs}#servlet-authentication[various authentication options]).
22282228

22292229
The easiest way to add user accounts is to provide your own `UserDetailsService` bean.
22302230

@@ -2369,7 +2369,7 @@ To generate build information with Maven, add an execution for the `build-info`
23692369
</build>
23702370
----
23712371

2372-
TIP: See the {spring-boot-maven-plugin-docs}/#build-info[Spring Boot Maven Plugin documentation] for more details.
2372+
TIP: See the {spring-boot-maven-plugin-docs}#goals-build-info[Spring Boot Maven Plugin documentation] for more details.
23732373

23742374
The following example does the same with Gradle:
23752375

@@ -2481,7 +2481,7 @@ However, you must additionally add an `<executions>` section, as follows:
24812481
</build>
24822482
----
24832483

2484-
See the {spring-boot-maven-plugin-docs}/usage.html[plugin documentation] for full usage details.
2484+
See the {spring-boot-maven-plugin-docs}#getting-started[plugin documentation] for full usage details.
24852485

24862486

24872487

@@ -2595,7 +2595,7 @@ In Maven, the executable jar must be the main artifact and you can add a classif
25952595
=== Remote Debug a Spring Boot Application Started with Maven
25962596
To attach a remote debugger to a Spring Boot application that was started with Maven, you can use the `jvmArguments` property of the {spring-boot-maven-plugin-docs}[maven plugin].
25972597

2598-
See {spring-boot-maven-plugin-docs}/examples/run-debug.html[this example] for more details.
2598+
See {spring-boot-maven-plugin-docs}#run-example-debug[this example] for more details.
25992599

26002600

26012601

spring-boot-project/spring-boot-docs/src/docs/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#appendix-dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.
28+
<<appendix-dependency-versions.adoc#dependency-versions,Dependency Versions>> :: Details of the dependencies that are managed by Spring Boot.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ If your application is a web application (Spring MVC, Spring WebFlux, or Jersey)
147147
Requires a dependency on `micrometer-registry-prometheus`.
148148
|===
149149

150-
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]).
150+
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]).
151151

152152

153153

@@ -363,7 +363,7 @@ A typical Spring Security configuration might look something like the following
363363

364364
The preceding example uses `EndpointRequest.toAnyEndpoint()` to match a request to any endpoint and then ensures that all have the `ENDPOINT_ADMIN` role.
365365
Several other matcher methods are also available on `EndpointRequest`.
366-
See the API documentation ({spring-boot-actuator-restapi}/html[HTML] or {spring-boot-actuator-restapi}/pdf/spring-boot-actuator-web-api.pdf[PDF]) for details.
366+
See the API documentation ({spring-boot-actuator-restapi}html[HTML] or {spring-boot-actuator-restapi}pdf/spring-boot-actuator-web-api.pdf[PDF]) for details.
367367

368368
If you deploy applications behind a firewall, you may prefer that all your actuator endpoints can be accessed without requiring authentication.
369369
You can do so by changing the configprop:management.endpoints.web.exposure.include[] property, as follows:

spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3249,7 +3249,7 @@ Alternatively, you can define your own `OpaqueTokenIntrospector` bean for servle
32493249
==== Authorization Server
32503250
Currently, Spring Security does not provide support for implementing an OAuth 2.0 Authorization Server.
32513251
However, this functionality is available from the {spring-security-oauth2}[Spring Security OAuth] project, which will eventually be superseded by Spring Security completely.
3252-
Until then, you can use the `spring-security-oauth2-autoconfigure` module to easily set up an OAuth 2.0 authorization server; see its https://docs.spring.io/spring-security-oauth2-boot[documentation] for instructions.
3252+
Until then, you can use the `spring-security-oauth2-autoconfigure` module to easily set up an OAuth 2.0 authorization server; see its https://docs.spring.io/spring-security-oauth2-boot/[documentation] for instructions.
32533253

32543254

32553255
[[boot-features-security-saml]]
@@ -4393,7 +4393,7 @@ TIP: If you want to fully bypass the auto-configuration for Spring Data Couchbas
43934393
[[boot-features-ldap]]
43944394
=== LDAP
43954395
https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol[LDAP] (Lightweight Directory Access Protocol) is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an IP network.
4396-
Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from https://www.ldap.com/unboundid-ldap-sdk-for-java[UnboundID].
4396+
Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from https://ldap.com/unboundid-ldap-sdk-for-java/[UnboundID].
43974397

43984398
LDAP abstractions are provided by https://github.com/spring-projects/spring-data-ldap[Spring Data LDAP].
43994399
There is a `spring-boot-starter-data-ldap` "`Starter`" for collecting the dependencies in a convenient way.
@@ -7234,7 +7234,7 @@ These annotations include:
72347234
[[boot-features-class-conditions]]
72357235
==== Class Conditions
72367236
The `@ConditionalOnClass` and `@ConditionalOnMissingClass` annotations let `@Configuration` classes be included based on the presence or absence of specific classes.
7237-
Due to the fact that annotation metadata is parsed by using https://asm.ow2.org/[ASM], you can use the `value` attribute to refer to the real class, even though that class might not actually appear on the running application classpath.
7237+
Due to the fact that annotation metadata is parsed by using https://asm.ow2.io/[ASM], you can use the `value` attribute to refer to the real class, even though that class might not actually appear on the running application classpath.
72387238
You can also use the `name` attribute if you prefer to specify the class name by using a `String` value.
72397239

72407240
This mechanism does not apply the same way to `@Bean` methods where typically the return type is the target of the condition: before the condition on the method applies, the JVM will have loaded the class and potentially processed method references which will fail if the class is not present.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The parent project provides the following features:
4444
* UTF-8 source encoding.
4545
* A <<using-boot-dependency-management,Dependency Management section>>, inherited from the spring-boot-dependencies pom, that manages the versions of common dependencies.
4646
This dependency management lets you omit <version> tags for those dependencies when used in your own pom.
47-
* An execution of the {spring-boot-maven-plugin-docs}/repackage-mojo.html[`repackage` goal] with a `repackage` execution id.
47+
* An execution of the {spring-boot-maven-plugin-docs}#goals-repackage[`repackage` goal] with a `repackage` execution id.
4848
* Sensible https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html[resource filtering].
4949
* Sensible plugin configuration (https://www.mojohaus.org/exec-maven-plugin/[exec plugin], https://github.com/ktoso/maven-git-commit-id-plugin[Git commit ID], and https://maven.apache.org/plugins/maven-shade-plugin/[shade]).
5050
* Sensible resource filtering for `application.properties` and `application.yml` including profile-specific files (for example, `application-dev.properties` and `application-dev.yml`)

0 commit comments

Comments
 (0)