Skip to content

Commit c416c17

Browse files
committed
Polish documentation title case
1 parent 65bdcdb commit c416c17

File tree

23 files changed

+44
-44
lines changed

23 files changed

+44
-44
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1034,7 +1034,7 @@ This would make `liveness` available at `/livez` and `readiness` at `readyz` on
10341034

10351035

10361036
[[actuator.endpoints.kubernetes-probes.external-state]]
1037-
==== Checking External State with Kubernetes Probes
1037+
==== Checking External State With Kubernetes Probes
10381038
Actuator configures the "`liveness`" and "`readiness`" probes as Health Groups.
10391039
This means that all the <<actuator#actuator.endpoints.health.groups, health groups features>> are available for them.
10401040
You can, for example, configure additional Health Indicators:

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/monitoring.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[actuator.monitoring]]
2-
== Monitoring and Management over HTTP
2+
== Monitoring and Management Over HTTP
33
If you are developing a web application, Spring Boot Actuator auto-configures all enabled endpoints to be exposed over HTTP.
44
The default convention is to use the `id` of the endpoint with a prefix of `/actuator` as the URL path.
55
For example, `health` is exposed as `/actuator/health`.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/cli/groovy-beans-dsl.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cli.groovy-beans-dsl]]
2-
== Developing Applications with the Groovy Beans DSL
2+
== Developing Applications With the Groovy Beans DSL
33
Spring Framework 4.0 has native support for a `beans{}` "`DSL`" (borrowed from https://grails.org/[Grails]), and you can embed bean definitions in your Groovy application scripts by using the same format.
44
This is sometimes a good way to include external features like middleware declarations, as shown in the following example:
55

spring-boot-project/spring-boot-docs/src/docs/asciidoc/cli/maven-setting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cli.maven-setting]]
2-
== Configuring the CLI with settings.xml
2+
== Configuring the CLI With settings.xml
33
The Spring Boot CLI uses Maven Resolver, Maven's dependency resolution engine, to resolve dependencies.
44
The CLI makes use of the Maven configuration found in `~/.m2/settings.xml` to configure Maven Resolver.
55
The following configuration settings are honored by the CLI:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The `version` command provides a quick way to check which version of Spring Boot
5050

5151

5252
[[cli.using-the-cli.run]]
53-
=== Running Applications with the CLI
53+
=== Running Applications With the CLI
5454
You can compile and run Groovy source code by using the `run` command.
5555
The Spring Boot CLI is completely self-contained, so you do not need any external Groovy installation.
5656

@@ -197,7 +197,7 @@ However, to ensure consistent ordering of the dependency management, you can use
197197

198198

199199
[[cli.using-the-cli.multiple-source-files]]
200-
=== Applications with Multiple Source Files
200+
=== Applications With Multiple Source Files
201201
You can use "`shell globbing`" with all commands that accept file input.
202202
Doing so lets you use multiple files from a single directory, as shown in the following example:
203203

spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/efficient-images.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[container-images.efficient-images]]
2-
== Efficient container images
2+
== Efficient Container Images
33
It is easily possible to package a Spring Boot fat jar as a docker image.
44
However, there are various downsides to copying and running the fat jar as is in the docker image.
55
There’s always a certain amount of overhead when running a fat jar without unpacking it, and in a containerized environment this can be noticeable.
@@ -9,7 +9,7 @@ If you put jar files in the layer before your application classes, Docker often
99

1010

1111
[[container-images.efficient-images.unpacking]]
12-
=== Unpacking the fat jar
12+
=== Unpacking the Executable JAR
1313
If you are running your application from a container, you can use an executable jar, but it is also often an advantage to explode it and run it in a different way.
1414
Certain PaaS implementations may also choose to unpack archives before they run.
1515
For example, Cloud Foundry operates this way.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ Spring Boot provides a dedicated "`Starter`", `spring-boot-starter-data-elastics
275275

276276

277277
[[data.nosql.elasticsearch.connecting-using-rest]]
278-
==== Connecting to Elasticsearch using REST clients
278+
==== Connecting to Elasticsearch Using REST clients
279279
Elasticsearch ships https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/index.html[two different REST clients] that you can use to query a cluster: the "Low Level" client and the "High Level" client.
280280
Spring Boot provides support for the "High Level" client, which ships with `org.elasticsearch.client:elasticsearch-rest-high-level-client`.
281281
Additionally, Spring Boot provides support for a reactive client, based on Spring Framework's `WebClient`, that ships with `org.springframework.data:spring-data-elasticsearch`.
@@ -293,7 +293,7 @@ You can use `spring.elasticsearch.*` properties to further tune how the clients
293293
----
294294

295295
[[data.nosql.elasticsearch.connecting-using-rest.restclient]]
296-
===== Connecting to Elasticsearch using RestHighLevelClient
296+
===== Connecting to Elasticsearch Using RestHighLevelClient
297297
If you have `elasticsearch-rest-high-level-client` on the classpath, Spring Boot will auto-configure and register a `RestHighLevelClient` bean.
298298
In addition to the properties described previously, to fine-tune the `RestHighLevelClient`, you can register an arbitrary number of beans that implement `RestClientBuilderCustomizer` for more advanced customizations.
299299
To take full control over its registration, define a `RestClientBuilder` bean.
@@ -316,7 +316,7 @@ You can further tune how `Sniffer` is configured, as shown in the following exam
316316

317317

318318
[[data.nosql.elasticsearch.connecting-using-rest.webclient]]
319-
===== Connecting to Elasticsearch using ReactiveElasticsearchClient
319+
===== Connecting to Elasticsearch Using ReactiveElasticsearchClient
320320
{spring-data-elasticsearch}[Spring Data Elasticsearch] ships `ReactiveElasticsearchClient` for querying Elasticsearch instances in a reactive fashion.
321321
It is built on top of WebFlux's `WebClient`, so both `spring-boot-starter-elasticsearch` and `spring-boot-starter-webflux` dependencies are useful to enable this support.
322322

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[documentation.using]]
2-
== Developing with Spring Boot
2+
== Developing With Spring Boot
33
Ready to actually start using Spring Boot? <<using#using, We have you covered>>:
44

55
* *Build systems:* <<using#using.build-systems.maven, Maven>> | <<using#using.build-systems.gradle, Gradle>> | <<using#using.build-systems.ant, Ant>> | <<using#using.build-systems.starters, Starters>>

spring-boot-project/spring-boot-docs/src/docs/asciidoc/executable-jar/jarfile-class.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ We do not need to unpack the archive, and we do not need to read all entry data
2626

2727

2828
[[appendix.executable-jar.jarfile-class.compatibility]]
29-
=== Compatibility with the Standard Java "`JarFile`"
29+
=== Compatibility With the Standard Java "`JarFile`"
3030
Spring Boot Loader strives to remain compatible with existing code and libraries.
3131
`org.springframework.boot.loader.jar.JarFile` extends from `java.util.jar.JarFile` and should work as a drop-in replacement.
3232
The `getURL()` method returns a `URL` that opens a connection compatible with `java.net.JarURLConnection` and can be used with Java's `URLClassLoader`.

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ This means that the JSON cannot override properties from lower order property so
101101

102102

103103
[[features.external-config.files]]
104-
=== External Application Properties [[features.external-config.files]]
104+
=== External Application Properties
105105
Spring Boot will automatically find and load `application.properties` and `application.yaml` files from the following locations when your application starts:
106106

107107
. From the classpath
@@ -474,7 +474,7 @@ See the _<<howto#howto.properties-and-configuration.short-command-line-arguments
474474

475475

476476
[[features.external-config.files.multi-document]]
477-
==== Working with Multi-Document Files
477+
==== Working With Multi-Document Files
478478
Spring Boot allows you to split a single physical file into multiple logical documents which are each added independently.
479479
Documents are processed in order, from top to bottom.
480480
Later documents can override the properties defined in earlier ones.
@@ -567,7 +567,7 @@ If you need a secure way to store credentials and passwords, the https://cloud.s
567567

568568

569569
[[features.external-config.yaml]]
570-
=== Working with YAML
570+
=== Working With YAML
571571
https://yaml.org[YAML] is a superset of JSON and, as such, is a convenient format for specifying hierarchical configuration data.
572572
The `SpringApplication` class automatically supports YAML as an alternative to properties whenever you have the https://github.com/snakeyaml/snakeyaml[SnakeYAML] library on your classpath.
573573

@@ -680,7 +680,7 @@ TIP: See also the <<features#features.external-config.typesafe-configuration-pro
680680

681681

682682
[[features.external-config.typesafe-configuration-properties.java-bean-binding]]
683-
==== JavaBean properties binding
683+
==== JavaBean Properties Binding
684684
It is possible to bind a bean declaring standard JavaBean properties as shown in the following example:
685685

686686
[source,java,indent=0,subs="verbatim"]
@@ -721,7 +721,7 @@ Finally, only standard Java Bean properties are considered and binding on static
721721

722722

723723
[[features.external-config.typesafe-configuration-properties.constructor-binding]]
724-
==== Constructor binding
724+
==== Constructor Binding
725725
The example in the previous section can be rewritten in an immutable fashion as shown in the following example:
726726

727727
[source,java,indent=0,subs="verbatim"]
@@ -760,7 +760,7 @@ For consistency with properties of other types, if you do declare an `Optional`
760760

761761

762762
[[features.external-config.typesafe-configuration-properties.enabling-annotated-types]]
763-
==== Enabling @ConfigurationProperties-annotated types
763+
==== Enabling @ConfigurationProperties-annotated Types
764764
Spring Boot provides infrastructure to bind `@ConfigurationProperties` types and register them as beans.
765765
You can either enable configuration properties on a class-by-class basis or enable configuration property scanning that works in a similar manner to component scanning.
766766

@@ -798,7 +798,7 @@ If you still want to inject other beans using the constructor, the configuration
798798

799799

800800
[[features.external-config.typesafe-configuration-properties.using-annotated-types]]
801-
==== Using @ConfigurationProperties-annotated types
801+
==== Using @ConfigurationProperties-annotated Types
802802
This style of configuration works particularly well with the `SpringApplication` external YAML configuration, as shown in the following example:
803803

804804
[source,yaml,indent=0,subs="verbatim"]
@@ -941,7 +941,7 @@ For example, binding `a.b=c` to `Map<String, Object>` will return a Map with the
941941

942942

943943
[[features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables]]
944-
===== Binding from Environment Variables
944+
===== Binding From Environment Variables
945945
Most operating systems impose strict rules around the names that can be used for environment variables.
946946
For example, Linux shell variables can contain only letters (`a` to `z` or `A` to `Z`), numbers (`0` to `9`) or the underscore character (`_`).
947947
By convention, Unix shell variables will also have their names in UPPERCASE.
@@ -1117,7 +1117,7 @@ Doing so gives a transparent upgrade path while supporting a much richer format.
11171117

11181118

11191119
[[features.external-config.typesafe-configuration-properties.conversion.periods]]
1120-
===== Converting periods
1120+
===== Converting Periods
11211121
In addition to durations, Spring Boot can also work with `java.time.Period` type.
11221122
The following formats can be used in application properties:
11231123

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[features.kotlin]]
2-
== Kotlin support
2+
== Kotlin Support
33
https://kotlinlang.org[Kotlin] is a statically-typed language targeting the JVM (and other platforms) which allows writing concise and elegant code while providing {kotlin-docs}java-interop.html[interoperability] with existing libraries written in Java.
44

55
Spring Boot provides Kotlin support by leveraging the support in other Spring projects such as Spring Framework, Spring Data, and Reactor.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ include::{docs-java}/features/testing/springbootapplications/usingapplicationarg
171171

172172

173173
[[features.testing.spring-boot-applications.with-mock-environment]]
174-
==== Testing with a mock environment
174+
==== Testing With a Mock Environment
175175
By default, `@SpringBootTest` does not start the server but instead sets up a mock environment for testing web endpoints.
176176

177177
With Spring MVC, we can query our web endpoints using {spring-framework-docs}/testing.html#spring-mvc-test-framework[`MockMvc`] or `WebTestClient`, as shown in the following example:
@@ -203,7 +203,7 @@ If you need to test these lower-level concerns, you can start a fully running se
203203

204204

205205
[[features.testing.spring-boot-applications.with-running-server]]
206-
==== Testing with a running server
206+
==== Testing With a Running Server
207207
If you need to start a full running server, we recommend that you use random ports.
208208
If you use `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)`, an available port is picked at random each time your test runs.
209209

@@ -710,7 +710,7 @@ It can also be used to configure the host, scheme, and port that appears in any
710710

711711

712712
[[features.testing.spring-boot-applications.autoconfigured-spring-restdocs.with-mock-mvc]]
713-
===== Auto-configured Spring REST Docs Tests with Mock MVC
713+
===== Auto-configured Spring REST Docs Tests With Mock MVC
714714
`@AutoConfigureRestDocs` customizes the `MockMvc` bean to use Spring REST Docs when testing servlet-based web applications.
715715
You can inject it by using `@Autowired` and use it in your tests as you normally would when using Mock MVC and Spring REST Docs, as shown in the following example:
716716

@@ -738,7 +738,7 @@ include::{docs-java}/features/testing/springbootapplications/autoconfiguredsprin
738738

739739

740740
[[features.testing.spring-boot-applications.autoconfigured-spring-restdocs.with-web-test-client]]
741-
===== Auto-configured Spring REST Docs Tests with WebTestClient
741+
===== Auto-configured Spring REST Docs Tests With WebTestClient
742742
`@AutoConfigureRestDocs` can also be used with `WebTestClient` when testing reactive web applications.
743743
You can inject it by using `@Autowired` and use it in your tests as you normally would when using `@WebFluxTest` and Spring REST Docs, as shown in the following example:
744744

@@ -765,7 +765,7 @@ include::{docs-java}/features/testing/springbootapplications/autoconfiguredsprin
765765

766766

767767
[[features.testing.spring-boot-applications.autoconfigured-spring-restdocs.with-rest-assured]]
768-
===== Auto-configured Spring REST Docs Tests with REST Assured
768+
===== Auto-configured Spring REST Docs Tests With REST Assured
769769
`@AutoConfigureRestDocs` makes a `RequestSpecification` bean, preconfigured to use Spring REST Docs, available to your tests.
770770
You can inject it by using `@Autowired` and use it in your tests as you normally would when using REST Assured and Spring REST Docs, as shown in the following example:
771771

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ See {spring-boot-autoconfigure-module-code}/batch/BatchAutoConfiguration.java[Ba
3030

3131

3232
[[howto.batch.running-from-the-command-line]]
33-
=== Running from the Command Line
33+
=== Running From the Command Line
3434
Spring Boot converts any command line argument starting with `--` to a property to add to the `Environment`, see <<features#features.external-config.command-line-args,accessing command line properties>>.
3535
This should not be used to pass arguments to batch jobs.
3636
To specify batch arguments on the command line, use the regular format (that is without `--`), as shown in the following example:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ See {spring-boot-maven-plugin-docs}#run-example-debug[this example] for more det
257257

258258

259259
[[howto.build.build-an-executable-archive-with-ant-without-using-spring-boot-antlib]]
260-
=== Build an Executable Archive from Ant without Using spring-boot-antlib
260+
=== Build an Executable Archive From Ant without Using spring-boot-antlib
261261
To build with Ant, you need to grab dependencies, compile, and then create a jar or war archive.
262262
To make it executable, you can either use the `spring-boot-antlib` module or you can follow these instructions:
263263

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ The details of the `h2` support depend on the chosen web server and the applicat
219219

220220

221221
[[howto.webserver.configure-http2.tomcat]]
222-
==== HTTP/2 with Tomcat
222+
==== HTTP/2 With Tomcat
223223
Spring Boot ships by default with Tomcat 9.0.x which supports `h2c` out of the box and `h2` out of the box when using JDK 9 or later.
224224
Alternatively, `h2` can be used on JDK 8 if the `libtcnative` library and its dependencies are installed on the host operating system.
225225

@@ -239,7 +239,7 @@ This error is not fatal, and the application still starts with HTTP/1.1 SSL supp
239239

240240

241241
[[howto.webserver.configure-http2.jetty]]
242-
==== HTTP/2 with Jetty
242+
==== HTTP/2 With Jetty
243243
For HTTP/2 support, Jetty requires the additional `org.eclipse.jetty.http2:http2-server` dependency.
244244
To use `h2c` no other dependencies are required.
245245
To use `h2`, you also need to choose one of the following dependencies, depending on your deployment:
@@ -251,7 +251,7 @@ To use `h2`, you also need to choose one of the following dependencies, dependin
251251

252252

253253
[[howto.webserver.configure-http2.netty]]
254-
==== HTTP/2 with Reactor Netty
254+
==== HTTP/2 With Reactor Netty
255255
The `spring-boot-webflux-starter` is using by default Reactor Netty as a server.
256256
Reactor Netty supports `h2c` using JDK 8 or later with no additional dependencies.
257257
Reactor Netty supports `h2` using the JDK support with JDK 9 or later.
@@ -264,7 +264,7 @@ Developers can choose to import only the required dependencies using a classifie
264264

265265

266266
[[howto.webserver.configure-http2.undertow]]
267-
==== HTTP/2 with Undertow
267+
==== HTTP/2 With Undertow
268268
As of Undertow 1.4.0+, both `h2` and `h2c` are supported on JDK 8 without any additional dependencies.
269269

270270

spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/jta.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[io.jta]]
2-
== Distributed Transactions with JTA
2+
== Distributed Transactions With JTA
33
Spring Boot supports distributed JTA transactions across multiple XA resources by using an https://www.atomikos.com/[Atomikos] embedded transaction manager.
44
JTA transactions are also supported when deploying to a suitable Java EE Application Server.
55

spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/amqp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Spring Boot offers several conveniences for working with AMQP through RabbitMQ,
77

88

99
[[messaging.amqp.rabbitmq]]
10-
=== RabbitMQ support
10+
=== RabbitMQ Support
1111
https://www.rabbitmq.com/[RabbitMQ] is a lightweight, reliable, scalable, and portable message broker based on the AMQP protocol.
1212
Spring uses `RabbitMQ` to communicate through the AMQP protocol.
1313

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[upgrading.from-1x]]
2-
== Upgrading from 1.x
2+
== Upgrading From 1.x
33

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

spring-boot-project/spring-boot-docs/src/docs/asciidoc/upgrading/to-feature.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[upgrading.to-feature]]
2-
== Upgrading to a new feature release
2+
== Upgrading to a New Feature Release
33

44
When upgrading to a new feature release, some properties may have been renamed or removed.
55
Spring Boot provides a way to analyze your application's environment and print diagnostics at startup, but also temporarily migrate properties at runtime for you.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ These work by rewriting classes as they are loaded to make them more amenable to
130130

131131

132132
[[using.devtools.restart.logging-condition-delta]]
133-
==== Logging changes in condition evaluation
133+
==== Logging Changes in Condition Evaluation
134134
By default, each time your application restarts, a report showing the condition evaluation delta is logged.
135135
The report shows the changes to your application's auto-configuration as you make changes such as adding or removing beans and setting configuration properties.
136136

spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/running-your-application.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you choose to package your application as a war file, see your server and IDE
1010

1111

1212
[[using.running-your-application.from-an-ide]]
13-
=== Running from an IDE
13+
=== Running From an IDE
1414
You can run a Spring Boot application from your IDE as a Java application.
1515
However, you first need to import your project.
1616
Import steps vary depending on your IDE and build system.

0 commit comments

Comments
 (0)