Skip to content

Commit 70e14d6

Browse files
Polish documentation headings
Title case should be used in all headings.
1 parent 03a7f48 commit 70e14d6

File tree

27 files changed

+38
-38
lines changed

27 files changed

+38
-38
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/integrationgraph.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[integrationgraph]]
2-
= Spring Integration graph (`integrationgraph`)
2+
= Spring Integration Graph (`integrationgraph`)
33

44
The `integrationgraph` endpoint exposes a graph containing all Spring Integration components.
55

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ include::partial$rest/actuator/metrics/metric-with-tags/query-parameters.adoc[]
5555

5656

5757
[[metrics.retrieving-metric.response-structure]]
58-
=== Response structure
58+
=== Response Structure
5959

6060
The response contains details of the metric.
6161
The following table describes the structure of the response:

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/sbom.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `sbom` endpoint provides information about the software bill of materials (S
66

77

88
[[sbom.retrieving-available-sboms]]
9-
== Retrieving the available SBOMs
9+
== Retrieving the Available SBOMs
1010

1111
To retrieve the available SBOMs, make a `GET` request to `/actuator/sbom`, as shown in the following curl-based example:
1212

@@ -30,7 +30,7 @@ include::partial$rest/actuator/sbom/response-fields.adoc[]
3030

3131

3232
[[sbom.retrieving-single-sbom]]
33-
== Retrieving a single SBOM
33+
== Retrieving a Single SBOM
3434

3535
To retrieve the available SBOMs, make a `GET` request to `/actuator/sbom/\{id}`, as shown in the following curl-based example:
3636

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[howto.aot]]
2-
= Ahead-of-time processing
2+
= Ahead-of-Time Processing
33

44
A number of questions often arise when people use the ahead-of-time processing of Spring Boot applications.
55
This section addresses those questions.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This provides only one argument to the batch job: `someParameter=someValue`.
6868

6969

7070
[[howto.batch.restarting-a-failed-job]]
71-
== Restarting a stopped or failed Job
71+
== Restarting a Stopped or Failed Job
7272

7373
To restart a failed `Job`, all parameters (identifying and non-identifying) must be re-specified on the command line.
7474
Non-identifying parameters are *not* copied from the previous execution.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The buildpack environment variable `BP_SPRING_AOT_ENABLED` can also be set to `t
1818
The Paketo Buildpack for Spring Boot https://github.com/paketo-buildpacks/spring-boot?tab=readme-ov-file#configuration[documentation] has information on other configuration options that can be enabled with builder environment variables, like `CDS_TRAINING_JAVA_TOOL_OPTIONS` that allows to override the default `JAVA_TOOL_OPTIONS`, only for the CDS training run.
1919

2020
[[howto.class-data-sharing.training-run-configuration]]
21-
== Preventing remote services interaction during the training run
21+
== Preventing Remote Services Interaction During the Training Run
2222

2323
When performing the training run, it may be needed to customize the Spring Boot application configuration to prevent connections to remote services that may happen before the Spring lifecycle is started.
2424
This can typically happen with early database interactions and can be handled via related configuration that can be applied by default to your application (or specifically to the training run) to prevent such interactions, see https://github.com/spring-projects/spring-lifecycle-smoke-tests/blob/main/README.adoc#training-run-configuration[related documentation].

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ See xref:api:java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProp
190190

191191

192192
[[howto.data-initialization.migration-tool.flyway-tests]]
193-
=== Use Flyway for test-only migrations
193+
=== Use Flyway for Test-only Migrations
194194

195195
If you want to create Flyway migrations which populate your test database, place them in `src/test/resources/db/migration`.
196196
A file named, for example, `src/test/resources/db/migration/V9999__test-data.sql` will be executed after your production migrations and only if you're running the tests.
@@ -200,7 +200,7 @@ This file will not be packaged in your uber jar or your container.
200200

201201

202202
[[howto.data-initialization.migration-tool.liquibase-tests]]
203-
=== Use Liquibase for test-only migrations
203+
=== Use Liquibase for Test-only Migrations
204204

205205
If you want to create Liquibase migrations which populate your test database, you have to create a test changelog which also includes the production changelog.
206206

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ With this Docker Compose file in place, the JDBC URL used is `jdbc:postgresql://
3232

3333

3434
[[howto.docker-compose.sharing-services]]
35-
== Sharing services between multiple applications
35+
== Sharing Services Between Multiple Applications
3636

3737
If you want to share services between multiple applications, create the `compose.yaml` file in one of the applications and then use the configuration property configprop:spring.docker.compose.file[] in the other applications to reference the `compose.yaml` file.
3838
You should also set configprop:spring.docker.compose.lifecycle-management[] to `start-only`, as it defaults to `start-and-stop` and stopping one application would shut down the shared services for the other still running applications as well.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66
[[howto.jersey.spring-security]]
7-
== Secure Jersey endpoints with Spring Security
7+
== Secure Jersey Endpoints with Spring Security
88

99
Spring Security can be used to secure a Jersey-based web application in much the same way as it can be used to secure a Spring MVC-based web application.
1010
However, if you want to use Spring Security's method-level security with Jersey, you must configure Jersey to use `setStatus(int)` rather `sendError(int)`.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For native image testing, you're generally looking to ensure that the following
1414

1515

1616
[[howto.native-image.testing.with-the-jvm]]
17-
== Testing Ahead-of-time Processing With the JVM
17+
== Testing Ahead-of-Time Processing With the JVM
1818

1919
When a Spring Boot application runs, it attempts to detect if it is running as a native image.
2020
If it is running as a native image, it will initialize the application using the code that was generated during at build-time by the Spring AOT engine.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For more about Spring Security, see the {url-spring-security-site}[Spring Securi
88

99

1010
[[howto.security.switch-off-spring-boot-configuration]]
11-
== Switch off the Spring Boot Security Configuration
11+
== Switch Off the Spring Boot Security Configuration
1212

1313
If you define a `@Configuration` with a `SecurityFilterChain` bean in your application, this action switches off the default webapp security settings in Spring Boot.
1414

@@ -25,7 +25,7 @@ The easiest way to add user accounts is by providing your own `UserDetailsServic
2525

2626

2727
[[howto.security.enable-https]]
28-
== Enable HTTPS When Running behind a Proxy Server
28+
== Enable HTTPS When Running Behind a Proxy Server
2929

3030
Ensuring that all your main endpoints are only available over HTTPS is an important chore for any application.
3131
If you use Tomcat as a servlet container, then Spring Boot adds Tomcat's own `RemoteIpValve` automatically if it detects some environment settings, allowing you to rely on the `HttpServletRequest` to report whether it is secure or not (even downstream of a proxy server that handles the real SSL termination).

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Configuring the `DispatcherServlet` yourself is unusual but if you really need t
184184

185185

186186
[[howto.spring-mvc.switch-off-default-configuration]]
187-
== Switch off the Default MVC Configuration
187+
== Switch Off the Default MVC Configuration
188188

189189
The easiest way to take complete control over MVC configuration is to provide your own `@Configuration` with the `@EnableWebMvc` annotation.
190190
Doing so leaves all MVC configuration in your hands.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For additional details on Spring Security's testing support, see Spring Security
2222

2323

2424
[[howto.testing.slice-tests]]
25-
== Structure `@Configuration` classes for inclusion in slice tests
25+
== Structure `@Configuration` Classes for Inclusion in Slice Tests
2626

2727
Slice tests work by restricting Spring Framework's component scanning to a limited set of components based on their type.
2828
For any beans that are not created through component scanning, for example, beans that are created using the `@Bean` annotation, slice tests will not be able to include/exclude them from the application context.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ TIP: To learn more about Micrometer's capabilities, see its {url-micrometer-docs
2828

2929

3030
[[actuator.metrics.getting-started]]
31-
== Getting started
31+
== Getting Started
3232

3333
Spring Boot auto-configures a composite `MeterRegistry` and adds a registry to the composite for each of the supported implementations that it finds on the classpath.
3434
Having a dependency on `micrometer-registry-\{system}` in your runtime classpath is enough for Spring Boot to configure the registry.
@@ -206,7 +206,7 @@ This is the default behavior and requires no special setup beyond a dependency o
206206

207207

208208
[[actuator.metrics.export.dynatrace.v2-api.manual-config]]
209-
===== Manual configuration
209+
===== Manual Configuration
210210

211211
If no auto-configuration is available, the endpoint of the {url-dynatrace-docs-shortlink}/api-metrics-v2-post-datapoints[Metrics v2 API] and an API token are required.
212212
The {url-dynatrace-docs-shortlink}/api-authentication[API token] must have the "`Ingest metrics`" (`metrics.ingest`) permission set.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/observability.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To enable it, add the `io.r2dbc:r2dbc-proxy` dependency to your project.
3030

3131

3232
[[actuator.observability.common-tags]]
33-
== Common tags
33+
== Common Tags
3434

3535
Common tags are generally used for dimensional drill-down on the operating environment, such as host, instance, region, stack, and others.
3636
Common tags are applied to all observations as low cardinality tags and can be configured, as the following example shows:

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/dev-services.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[features.dev-services]]
2-
= Development-time services
2+
= Development-time Services
33

44
Development-time services provide external dependencies needed to run the application while developing it.
55
They are only supposed to be used while developing and are disabled when the application is deployed.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/kotlin.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Among other things, the extensions make it possible to take advantage of Kotlin
9898

9999

100100
[[features.kotlin.dependency-management]]
101-
== Dependency management
101+
== Dependency Management
102102

103103
In order to avoid mixing different versions of Kotlin dependencies on the classpath, Spring Boot imports the Kotlin BOM.
104104

@@ -155,7 +155,7 @@ If you need the `MockK` equivalent of the Mockito specific xref:testing/spring-b
155155

156156

157157
[[features.kotlin.resources.further-reading]]
158-
=== Further reading
158+
=== Further Reading
159159

160160
* {url-kotlin-docs}[Kotlin language reference]
161161
* https://kotlinlang.slack.com/[Kotlin Slack] (with a dedicated #spring channel)

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/messaging/rsocket.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Note that their `@Order` is important, as it determines the order of codecs.
2828

2929

3030
[[messaging.rsocket.server-auto-configuration]]
31-
== RSocket server Auto-configuration
31+
== RSocket Server Auto-configuration
3232

3333
Spring Boot provides RSocket server auto-configuration.
3434
The required dependencies are provided by the `spring-boot-starter-rsocket`.
@@ -63,7 +63,7 @@ spring:
6363

6464

6565
[[messaging.rsocket.messaging]]
66-
== Spring Messaging RSocket support
66+
== Spring Messaging RSocket Support
6767

6868
Spring Boot will auto-configure the Spring Messaging infrastructure for RSocket.
6969

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/aot.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[packaging.aot]]
2-
= Ahead-of-time Processing With the JVM
2+
= Ahead-of-Time Processing With the JVM
33

44
It's beneficial for the startup time to run your application using the AOT generated initialization code.
55
First, you need to ensure that the jar you are building includes AOT generated code.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/native-image/advanced-topics.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ But when you work with `WebClient`, `RestClient` or `RestTemplate` directly, you
171171

172172

173173
[[packaging.native-image.advanced.custom-hints.testing]]
174-
=== Testing custom hints
174+
=== Testing Custom Hints
175175

176176
The `RuntimeHintsPredicates` API can be used to test your hints.
177177
The API provides methods that build a `Predicate` that can be used to test a `RuntimeHints` instance.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/web/spring-graphql.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Spring Boot will automatically detect `DataFetcherExceptionResolver` beans and r
153153

154154

155155
[[web.graphql.graphiql]]
156-
== GraphiQL and Schema printer
156+
== GraphiQL and Schema Printer
157157

158158
Spring GraphQL offers infrastructure for helping developers when consuming or developing a GraphQL API.
159159

spring-boot-project/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ OS: Linux 6.2.12-200.fc37.aarch64 aarch64
7575

7676

7777
[[getting-started.first-application.pom]]
78-
== Setting up the project with Maven
78+
== Setting Up the Project With Maven
7979

8080
We need to start by creating a Maven `pom.xml` file.
8181
The `pom.xml` is the recipe that is used to build your project.
@@ -136,7 +136,7 @@ For simplicity, we continue to use a plain text editor for this example.
136136

137137

138138
[[getting-started.first-application.gradle]]
139-
== Setting up the project with Gradle
139+
== Setting Up the Project With Gradle
140140

141141
We need to start by creating a Gradle `build.gradle` file.
142142
The `build.gradle` is the build script that is used to build your project.

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/modules/gradle-plugin/pages/packaging-oci-image.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ You can override this behaviour as shown in the xref:packaging-oci-image.adoc#bu
242242

243243

244244
[[build-image.customization.tags]]
245-
=== Tags format
245+
=== Tags Format
246246

247247
The values provided to the `tags` option should be *full* image references.
248248
The accepted format is `[domainHost:port/][path/]name[:tag][@digest]`.

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/antora/modules/gradle-plugin/pages/running.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ include::example$running/application-plugin-main-class-name.gradle.kts[tags=main
9090

9191

9292
[[running-your-application.passing-arguments]]
93-
== Passing Arguments to your Application
93+
== Passing Arguments to Your Application
9494

9595
Like all `JavaExec` tasks, arguments can be passed into `bootRun` from the command line using `--args='<arguments>'` when using Gradle 4.9 or later.
9696
For example, to run your application with a profile named `dev` active the following command can be used:
@@ -105,7 +105,7 @@ See {url-gradle-javadoc}/org/gradle/api/tasks/JavaExec.html#setArgsString-java.l
105105

106106

107107
[[running-your-application.passing-system-properties]]
108-
== Passing System properties to your application
108+
== Passing System Properties to Your application
109109

110110
Since `bootRun` is a standard `JavaExec` task, system properties can be passed to the application's JVM by specifying them in the build script.
111111
To make that value of a system property to be configurable set its value using a {url-gradle-dsl}/org.gradle.api.Project.html#N14FE1[project property].

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/modules/maven-plugin/pages/build-image.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ For more details, see also xref:build-image.adoc#build-image.examples[examples].
250250

251251

252252
[[build-image.customization.tags]]
253-
=== Tags format
253+
=== Tags Format
254254

255255
The values provided to the `tags` option should be *full* image references.
256256
The accepted format is `[domainHost:port/][path/]name[:tag][@digest]`.

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/modules/maven-plugin/pages/integration-tests.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ You can now retrieve the `test.server.port` system property in any of your integ
6060

6161

6262
[[integration-tests.examples.jmx-port]]
63-
=== Customize JMX port
63+
=== Customize JMX Port
6464

6565
The `jmxPort` property allows to customize the port the plugin uses to communicate with the Spring Boot application.
6666

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/antora/modules/maven-plugin/pages/using.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ include::example$using/no-starter-parent-override-dependencies-pom.xml[tags=no-s
9494

9595

9696
[[using.overriding-command-line]]
97-
== Overriding settings on the command-line
97+
== Overriding Settings on the Command Line
9898

99-
The plugin offers a number of user properties, starting with `spring-boot`, to let you customize the configuration from the command-line.
99+
The plugin offers a number of user properties, starting with `spring-boot`, to let you customize the configuration from the command line.
100100

101101
For instance, you could tune the profiles to enable when running the application as follows:
102102

@@ -105,15 +105,15 @@ For instance, you could tune the profiles to enable when running the application
105105
$ mvn spring-boot:run -Dspring-boot.run.profiles=dev,local
106106
----
107107

108-
If you want to both have a default while allowing it to be overridden on the command-line, you should use a combination of a user-provided project property and MOJO configuration.
108+
If you want to both have a default while allowing it to be overridden on the command line, you should use a combination of a user-provided project property and MOJO configuration.
109109

110110
[source,xml,indent=0,subs="verbatim,attributes"]
111111
----
112112
include::example$using/default-and-override-pom.xml[tags=default-and-override]
113113
----
114114

115115
The above makes sure that `local` and `dev` are enabled by default.
116-
Now a dedicated property has been exposed, this can be overridden on the command-line as well:
116+
Now a dedicated property has been exposed, this can be overridden on the command line as well:
117117

118118
[source,shell]
119119
----

0 commit comments

Comments
 (0)