Skip to content

Commit 03a7f48

Browse files
Polish documentation for xref hyperlink formatting consistency
This commit improves the consistency of xref link formatting (no quotes, italics, or other decoration) and uses automatic link text generation wherever possible.
1 parent 24a8bbd commit 03a7f48

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+163
-162
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Spring Boot dependencies use the `org.springframework.boot` group id.
4242
Typically, your Maven POM file inherits from the `spring-boot-starter-parent` project and declares dependencies to one or more xref:reference:using/build-systems.adoc#using.build-systems.starters[starters].
4343
Spring Boot also provides an optional xref:maven-plugin:index.adoc[Maven plugin] to create executable jars.
4444

45-
More details on getting started with Spring Boot and Maven can be found in the xref:maven-plugin:getting-started.adoc[Getting Started section] of the Maven plugin's reference guide.
45+
More details on getting started with Spring Boot and Maven can be found in the xref:maven-plugin:getting-started.adoc[] section of the Maven plugin's reference guide.
4646

4747

4848

@@ -63,7 +63,7 @@ It is a small script and library that you commit alongside your code to bootstra
6363
See {url-gradle-docs}/gradle_wrapper.html for details.
6464
****
6565

66-
More details on getting started with Spring Boot and Gradle can be found in the xref:gradle-plugin:getting-started.adoc[Getting Started section] of the Gradle plugin's reference guide.
66+
More details on getting started with Spring Boot and Gradle can be found in the xref:gradle-plugin:getting-started.adoc[] section of the Gradle plugin's reference guide.
6767

6868

6969

spring-boot-project/spring-boot-docs/src/docs/antora/modules/ROOT/pages/upgrading.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ If you are more than one release behind, please make sure that you also review t
1212
[[upgrading.from-1x]]
1313
== Upgrading From 1.x
1414

15-
If you are upgrading from the `1.x` release of Spring Boot, check the {url-github-wiki}/Spring-Boot-2.0-Migration-Guide["`migration guide`" on the project wiki] that provides detailed upgrade instructions.
16-
Check also the {url-github-wiki}["`release notes`"] for a list of "`new and noteworthy`" features for each release.
15+
If you are upgrading from the `1.x` release of Spring Boot, check the {url-github-wiki}/Spring-Boot-2.0-Migration-Guide[migration guide] on the project wiki that provides detailed upgrade instructions.
16+
Check also the {url-github-wiki}[release notes] for a list of "`new and noteworthy`" features for each release.
1717

1818

1919

spring-boot-project/spring-boot-docs/src/docs/antora/modules/appendix/pages/dependency-versions/properties.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
The following table provides all properties that can be used to override the versions managed by Spring Boot.
55
Browse the {code-spring-boot}/spring-boot-project/spring-boot-dependencies/build.gradle[`spring-boot-dependencies` build.gradle] for a complete list of dependencies.
6-
You can learn how to customize these versions in your application in the xref:build-tool-plugin:index.adoc[Build Tool Plugins documentation].
6+
You can learn how to customize these versions in your application in the xref:build-tool-plugin:index.adoc[] documentation.
77

88
include::partial$dependency-versions/documented-properties.adoc[]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/build-tool-plugin/pages/antlib.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ TIP: The "`Using Spring Boot`" section includes a more complete example of xref:
3030

3131
Once the `spring-boot-antlib` namespace has been declared, the following additional tasks are available:
3232

33-
* xref:antlib.adoc#build-tool-plugins.antlib.tasks.exejar[Using the "`exejar`" Task]
34-
* xref:antlib.adoc#build-tool-plugins.antlib.findmainclass[Using the "`findmainclass`" Task]
33+
* xref:antlib.adoc#build-tool-plugins.antlib.tasks.exejar[]
34+
* xref:antlib.adoc#build-tool-plugins.antlib.findmainclass[]
3535

3636

3737

spring-boot-project/spring-boot-docs/src/docs/antora/modules/build-tool-plugin/pages/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
Spring Boot provides build tool plugins for Maven and Gradle.
55
The plugins offer a variety of features, including the packaging of executable jars.
66
This section provides more details on both plugins as well as some help should you need to extend an unsupported build system.
7-
If you are just getting started, you might want to read "`xref:reference:using/build-systems.adoc[Build Systems]`" from the "`xref:reference:using/index.adoc[Developing with Spring Boot]`" section first.
7+
If you are just getting started, you might want to read xref:reference:using/build-systems.adoc[] from the xref:reference:using/index.adoc[] section first.
88

spring-boot-project/spring-boot-docs/src/docs/antora/modules/build-tool-plugin/pages/other-build-systems.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Supporting Other Build Systems
33

44
If you want to use a build tool other than Maven, Gradle, or Ant, you likely need to develop your own plugin.
5-
Executable jars need to follow a specific format and certain entries need to be written in an uncompressed form (see the "`xref:specification:/executable-jar/index.adoc[executable jar format]`" section in the appendix for details).
5+
Executable jars need to follow a specific format and certain entries need to be written in an uncompressed form (see the xref:specification:/executable-jar/index.adoc[executable jar format] section in the appendix for details).
66

77
The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to actually generate jars.
88
If you need to, you may use this library directly.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/cli/pages/installation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
= Installing the CLI
33

44
The Spring Boot CLI (Command-Line Interface) can be installed manually by using SDKMAN! (the SDK Manager) or by using Homebrew or MacPorts if you are an OSX user.
5-
See xref:ROOT:installing.adoc#getting-started.installing.cli[_Installing the Spring Boot CLI_] in the "`Getting started`" section for comprehensive installation instructions.
5+
See xref:ROOT:installing.adoc#getting-started.installing.cli[] in the "`Getting Started`" section for comprehensive installation instructions.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/actuator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In a standalone application, the Actuator HTTP port defaults to the same as the
1313
To make the application listen on a different port, set the external property: configprop:management.server.port[].
1414
To listen on a completely different network address (such as when you have an internal network for management and an external one for user applications), you can also set `management.server.address` to a valid IP address to which the server is able to bind.
1515

16-
For more detail, see the xref:api:java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.html[`ManagementServerProperties`] source code and "`xref:reference:actuator/monitoring.adoc#actuator.monitoring.customizing-management-server-port[Customizing the Management Server Port]`" in the "`Production-ready features`" section.
16+
For more detail, see the xref:api:java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.html[`ManagementServerProperties`] source code and xref:reference:actuator/monitoring.adoc#actuator.monitoring.customizing-management-server-port[Customizing the Management Server Port] in the "`Production-Ready Features`" section.
1717

1818

1919

@@ -33,7 +33,7 @@ In general, you need a `View` that resolves with a name of `error` or a `@Contro
3333
Unless you replaced some of the default configuration, you should find a `BeanNameViewResolver` in your `ApplicationContext`, so a `@Bean` named `error` would be one way of doing that.
3434
See {code-spring-boot-autoconfigure-src}/web/servlet/error/ErrorMvcAutoConfiguration.java[`ErrorMvcAutoConfiguration`] for more options.
3535

36-
See also the section on "`xref:reference:web/servlet.adoc#web.servlet.spring-mvc.error-handling[Error Handling]`" for details of how to register handlers in the servlet container.
36+
See also the section on xref:reference:web/servlet.adoc#web.servlet.spring-mvc.error-handling[] for details of how to register handlers in the servlet container.
3737

3838

3939

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/application.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ The Spring Boot auto-configuration tries its best to "`do the right thing`", but
3636

3737
There is a really useful `ConditionEvaluationReport` available in any Spring Boot `ApplicationContext`.
3838
You can see it if you enable `DEBUG` logging output.
39-
If you use the `spring-boot-actuator` (see xref:actuator.adoc[the Actuator chapter]), there is also a `conditions` endpoint that renders the report in JSON.
39+
If you use the `spring-boot-actuator` (see the xref:actuator.adoc[] section), there is also a `conditions` endpoint that renders the report in JSON.
4040
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.
4141

42-
Many more questions can be answered by looking at the source code and the Javadoc.
42+
Many more questions can be answered by looking at the source code and the API documentation.
4343
When reading the code, remember the following rules of thumb:
4444

4545
* Look for classes called `+*AutoConfiguration+` and read their sources.
@@ -68,7 +68,7 @@ There is more than one way to register additional customizations:
6868
* Declaratively, for all applications, by adding a `META-INF/spring.factories` and packaging a jar file that the applications all use as a library.
6969

7070
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.
71-
See "`xref:reference:features/spring-application.adoc#features.spring-application.application-events-and-listeners[Application Events and Listeners]`" in the '`Spring Boot features`' section for a complete list.
71+
See xref:reference:features/spring-application.adoc#features.spring-application.application-events-and-listeners[] in the "`Spring Boot Features`" section for a complete list.
7272

7373
It is also possible to customize the `Environment` before the application context is refreshed by using `EnvironmentPostProcessor`.
7474
Each implementation should be registered in `META-INF/spring.factories`, as shown in the following example:
@@ -98,7 +98,7 @@ This is too late to configure certain properties such as `+logging.*+` and `+spr
9898
== Build an ApplicationContext Hierarchy (Adding a Parent or Root Context)
9999

100100
You can use the `ApplicationBuilder` class to create parent/child `ApplicationContext` hierarchies.
101-
See "`xref:reference:features/spring-application.adoc#features.spring-application.fluent-builder-api[Fluent Builder API]`" in the '`Spring Boot features`' section for more information.
101+
See xref:reference:features/spring-application.adoc#features.spring-application.fluent-builder-api[] in the "`Spring Boot Features`" section for more information.
102102

103103

104104

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/batch.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Spring Batch expects a single `DataSource` by default.
1414
To have it use a `DataSource` other than the application’s main `DataSource`, declare a `DataSource` bean, annotating its `@Bean` method with `@BatchDataSource`.
1515
If you do so and want two data sources, remember to mark the other one `@Primary`.
1616
To take greater control, add `@EnableBatchProcessing` to one of your `@Configuration` classes or extend `DefaultBatchConfiguration`.
17-
See the Javadoc of {url-spring-batch-javadoc}/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.html[`@EnableBatchProcessing`]
17+
See the API documentation of {url-spring-batch-javadoc}/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.html[`@EnableBatchProcessing`]
1818
and {url-spring-batch-javadoc}/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.html[`DefaultBatchConfiguration`] for more details.
1919

2020
For more info about Spring Batch, see the {url-spring-batch-site}[Spring Batch project page].
@@ -24,7 +24,7 @@ For more info about Spring Batch, see the {url-spring-batch-site}[Spring Batch p
2424
[[howto.batch.specifying-a-transaction-manager]]
2525
== Specifying a Batch Transaction Manager
2626

27-
Similar to xref:batch.adoc#howto.batch.specifying-a-data-source[Specifying a Batch Data Source], you can define a `PlatformTransactionManager` for use in the batch processing by marking it as `@BatchTransactionManager`.
27+
Similar to xref:batch.adoc#howto.batch.specifying-a-data-source[], you can define a `PlatformTransactionManager` for use in the batch processing by marking it as `@BatchTransactionManager`.
2828
If you do so and want two transaction managers, remember to mark the other one as `@Primary`.
2929

3030

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/build.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ The Spring Boot plugins for Maven and Gradle allow these managed dependency vers
9696
WARNING: Each Spring Boot release is designed and tested against this specific set of third-party dependencies.
9797
Overriding versions may cause compatibility issues.
9898

99-
To override dependency versions with Maven, see xref:maven-plugin:using.adoc[this section] of the Maven plugin's documentation.
99+
To override dependency versions with Maven, see xref:maven-plugin:using.adoc[] in the Maven plugin's documentation.
100100

101-
To override dependency versions in Gradle, see xref:gradle-plugin:managing-dependencies.adoc#managing-dependencies.dependency-management-plugin.customizing[this section] of the Gradle plugin's documentation.
101+
To override dependency versions in Gradle, see xref:gradle-plugin:managing-dependencies.adoc#managing-dependencies.dependency-management-plugin.customizing[] in the Gradle plugin's documentation.
102102

103103

104104

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/class-data-sharing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Class Data Sharing
33

44
This section includes information about using Class Data Sharing (CDS) with Spring Boot applications.
5-
For an overview of Spring Boot support for CDS, see xref:reference:packaging/class-data-sharing.adoc[Class Data Sharing].
5+
For an overview of Spring Boot support for CDS, see xref:reference:packaging/class-data-sharing.adoc[].
66

77

88
[[howto.class-data-sharing.buildpacks]]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-access.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This section answers questions related to doing so.
1111

1212
To configure your own `DataSource`, define a `@Bean` of that type in your configuration.
1313
Spring Boot reuses your `DataSource` anywhere one is required, including database initialization.
14-
If you need to externalize some settings, you can bind your `DataSource` to the environment (see "`xref:reference:features/external-config.adoc#features.external-config.typesafe-configuration-properties.third-party-configuration[Third-party Configuration]`").
14+
If you need to externalize some settings, you can bind your `DataSource` to the environment (see xref:reference:features/external-config.adoc#features.external-config.typesafe-configuration-properties.third-party-configuration[]).
1515

1616
The following example shows how to define a data source in a bean:
1717

@@ -103,7 +103,7 @@ This example uses a more generic `configuration` sub namespace as the example do
103103
NOTE: Because your custom configuration chooses to go with Hikari, `app.datasource.type` has no effect.
104104
In practice, the builder is initialized with whatever value you might set there and then overridden by the call to `.type()`.
105105

106-
See "`xref:reference:data/sql.adoc#data.sql.datasource[Configure a DataSource]`" in the "`Spring Boot features`" section and the {code-spring-boot-autoconfigure-src}/jdbc/DataSourceAutoConfiguration.java[`DataSourceAutoConfiguration`] class for more details.
106+
See xref:reference:data/sql.adoc#data.sql.datasource[] in the "`Spring Boot Features`" section and the {code-spring-boot-autoconfigure-src}/jdbc/DataSourceAutoConfiguration.java[`DataSourceAutoConfiguration`] class for more details.
107107

108108

109109

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-initialization.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This will defer data source initialization until after any `EntityManagerFactory
6060
NOTE: The initialization scripts support `--` for single line comments and `/++*++ ++*++/` for block comments.
6161
Other comment formats are not supported.
6262

63-
If you are using a xref:data-initialization.adoc#howto.data-initialization.migration-tool[Higher-level Database Migration Tool], like Flyway or Liquibase, you should use them alone to create and initialize the schema.
63+
If you are using a xref:data-initialization.adoc#howto.data-initialization.migration-tool[higher-level database migration tool], like Flyway or Liquibase, you should use them alone to create and initialize the schema.
6464
Using the basic `schema.sql` and `data.sql` scripts alongside Flyway or Liquibase is not recommended and support will be removed in a future release.
6565

6666
If you need to initialize test data using a higher-level database migration tool, please see the sections about xref:data-initialization.adoc#howto.data-initialization.migration-tool.flyway-tests[Flyway] and xref:data-initialization.adoc#howto.data-initialization.migration-tool.liquibase-tests[Liquibase].

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/cloud.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ include-code::MyBean[]
100100

101101
All Cloud Foundry properties are prefixed with `vcap`.
102102
You can use `vcap` properties to access application information (such as the public URL of the application) and service information (such as database credentials).
103-
See the xref:api:java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.html[`CloudFoundryVcapEnvironmentPostProcessor`] Javadoc for complete details.
103+
See the xref:api:java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.html[`CloudFoundryVcapEnvironmentPostProcessor`] API documentation for complete details.
104104

105105
TIP: The https://github.com/pivotal-cf/java-cfenv/[Java CFEnv] project is a better fit for tasks such as configuring a DataSource.
106106

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/traditional-deployment.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ dependencies {
6464
TIP: `providedRuntime` is preferred to Gradle's `compileOnly` configuration.
6565
Among other limitations, `compileOnly` dependencies are not on the test classpath, so any web-based integration tests fail.
6666

67-
If you use the xref:build-tool-plugin:index.adoc[Spring Boot build tools], marking the embedded servlet container dependency as provided produces an executable war file with the provided dependencies packaged in a `lib-provided` directory.
67+
If you use the Spring Boot xref:build-tool-plugin:index.adoc[], marking the embedded servlet container dependency as provided produces an executable war file with the provided dependencies packaged in a `lib-provided` directory.
6868
This means that, in addition to being deployable to a servlet container, you can also run your application by using `java -jar` on the command line.
6969

7070

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/hotswapping.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The `spring-boot-devtools` module includes support for automatic application res
6464
While not as fast as technologies such as https://www.jrebel.com/products/jrebel[JRebel] it is usually significantly faster than a "`cold start`".
6565
You should probably give it a try before investigating some of the more complex reload options discussed later in this document.
6666

67-
For more details, see the xref:reference:using/devtools.adoc[Developer Tools] section.
67+
For more details, see the xref:reference:using/devtools.adoc[] section.
6868

6969

7070

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/logging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ By default, Spring Boot picks up the native configuration from its default locat
4040

4141
If you need to apply customizations to logback beyond those that can be achieved with `application.properties`, you will need to add a standard logback configuration file.
4242
You can add a `logback.xml` file to the root of your classpath for logback to find.
43-
You can also use `logback-spring.xml` if you want to use the xref:reference:features/logging.adoc#features.logging.logback-extensions[Spring Boot Logback extensions].
43+
You can also use `logback-spring.xml` if you want to use the Spring Boot xref:reference:features/logging.adoc#features.logging.logback-extensions[].
4444

4545
TIP: The Logback documentation has a https://logback.qos.ch/manual/configuration.html[dedicated section that covers configuration] in some detail.
4646

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/native-image/developing-your-first-application.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The included `HELP.md` file will provide getting started hints.
1515
== Sample Application
1616

1717
We need an example application that we can use to create our native image.
18-
For our purposes, the simple "Hello World!" web application that's covered in the xref:tutorial:first-application/index.adoc[Developing Your First Spring Boot Application] section will suffice.
18+
For our purposes, the simple "Hello World!" web application that's covered in the xref:tutorial:first-application/index.adoc[] section will suffice.
1919

2020
To recap, our main application code looks like this:
2121

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/native-image/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33

44
This section contains details on developing and testing Spring Boot applications as GraalVM native images.
55

6-
TIP: For an overview of GraalVM native image concepts, see the xref:reference:packaging/native-image/introducing-graalvm-native-images.adoc[Introducing GraalVM Native Images] section.
6+
TIP: For an overview of GraalVM native image concepts, see the xref:reference:packaging/native-image/introducing-graalvm-native-images.adoc[] section.
77

0 commit comments

Comments
 (0)