Skip to content

Commit f82b336

Browse files
committed
Add missing asciidoctor heading anchors
Closes gh-26239
1 parent 4a990f3 commit f82b336

11 files changed

+80
-11
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,8 @@ To improve the user experience and further assist the user in configuring a give
333333
* Associates a provider, to attach a well defined semantic to a property, so that a tool can discover the list of potential values based on the project's context.
334334

335335

336+
337+
[[configuration-metadata-providing-manual-hints-value-hint]]
336338
=== Value Hint
337339
The `name` attribute of each hint refers to the `name` of a property.
338340
In the <<configuration-metadata-format,initial example shown earlier>>, we provide five values for the `spring.jpa.hibernate.ddl-auto` property: `none`, `validate`, `update`, `create`, and `create-drop`.
@@ -378,6 +380,7 @@ If your IDE supports it, this is by far the most effective approach to auto-comp
378380

379381

380382

383+
[[configuration-metadata-providing-manual-hints-value-providers]]
381384
=== Value Providers
382385
Providers are a powerful way to attach semantics to a property.
383386
In this section, we define the official providers that you can use for your own hints.
@@ -421,6 +424,7 @@ If no provider for a given property is supported, no special content assistance
421424

422425

423426

427+
[[configuration-metadata-providing-manual-hints-any]]
424428
==== Any
425429
The special **any** provider value permits any additional values to be provided.
426430
Regular value validation based on the property type should be applied if this is supported.
@@ -453,6 +457,9 @@ The following example offers `on` and `off` as auto-completion values for `syste
453457

454458
Note that, in the preceding example, any other value is also allowed.
455459

460+
461+
462+
[[configuration-metadata-providing-manual-hints-class-reference]]
456463
==== Class Reference
457464
The **class-reference** provider auto-completes classes available in the project.
458465
This provider supports the following parameters:
@@ -496,6 +503,7 @@ The following metadata snippet corresponds to the standard `server.servlet.jsp.c
496503

497504

498505

506+
[[configuration-metadata-providing-manual-hints-handle-as]]
499507
==== Handle As
500508
The **handle-as** provider lets you substitute the type of the property to a more high-level type.
501509
This typically happens when the property has a `java.lang.String` type, because you do not want your configuration classes to rely on classes that may not be on the classpath.
@@ -545,6 +553,7 @@ It is actually used internally as a `org.springframework.core.io.Resource` but c
545553

546554

547555

556+
[[configuration-metadata-providing-manual-hints-logger-name]]
548557
==== Logger Name
549558
The **logger-name** provider auto-completes valid logger names and <<spring-boot-features.adoc#boot-features-custom-log-groups,logger groups>>.
550559
Typically, package and class names available in the current project can be auto-completed.
@@ -631,6 +640,7 @@ As Spring Boot defines a few logger groups out-of-the-box, dedicated value hints
631640

632641

633642

643+
[[configuration-metadata-providing-manual-hints-spring-bean-reference]]
634644
==== Spring Bean Reference
635645
The **spring-bean-reference** provider auto-completes the beans that are defined in the configuration of the current project.
636646
This provider supports the following parameters:
@@ -670,6 +680,7 @@ If you provide that hint, you still need to transform the bean name into an actu
670680

671681

672682

683+
[[configuration-metadata-providing-manual-hints-spring-profile-name]]
673684
==== Spring Profile Name
674685
The **spring-profile-name** provider auto-completes the Spring profiles that are defined in the configuration of the current project.
675686

@@ -863,6 +874,7 @@ In order to document default values for properties in the class above, you could
863874
NOTE: Only the `name` of the property is required to document additional metadata for existing properties.
864875

865876

877+
866878
[[configuration-metadata-annotation-processor-metadata-generation-nested]]
867879
==== Nested Properties
868880
The annotation processor automatically considers inner classes as nested properties.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-dependency-versions.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ include::attributes.adoc[]
55

66
This appendix provides details of the dependencies that are managed by Spring Boot.
77

8+
9+
810
[[dependency-versions-coordinates]]
911
== Managed Dependency Coordinates
1012

@@ -13,6 +15,8 @@ When you declare a dependency on one of these artifacts without declaring a vers
1315

1416
include::dependency-versions.adoc[]
1517

18+
19+
1620
[[dependency-versions-properties]]
1721
== Version Properties
1822

spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-test-auto-configuration.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ include::attributes.adoc[]
55

66
This appendix describes the `@…Test` auto-configuration annotations that Spring Boot provides to test slices of your application.
77

8+
9+
810
[[test-auto-configuration-slices]]
911
== Test Slices
1012

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Please refer to the plugin's documentation to learn more:
2020
* {spring-boot-maven-plugin-api}[API]
2121

2222

23+
2324
[[build-tool-plugins-gradle-plugin]]
2425
== Spring Boot Gradle Plugin
2526
The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, letting you package executable jar or war archives, run Spring Boot applications, and use the dependency management provided by `spring-boot-dependencies`.
@@ -104,7 +105,6 @@ The following nested elements can be used with the task:
104105

105106

106107

107-
108108
[[spring-boot-ant-exejar-examples]]
109109
==== Examples
110110
This section shows two examples of Ant tasks.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,19 +290,22 @@ In this document, we describe to approach using AWS Elastic Beanstalk.
290290

291291

292292

293+
[[cloud-deployment-aws-beanstalk]]
293294
==== AWS Elastic Beanstalk
294295
As described in the official https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/create_deploy_Java.html[Elastic Beanstalk Java guide], there are two main options to deploy a Java application.
295296
You can either use the "`Tomcat Platform`" or the "`Java SE platform`".
296297

297298

298299

300+
[[cloud-deployment-aws-tomcat-platform]]
299301
===== Using the Tomcat Platform
300302
This option applies to Spring Boot projects that produce a war file.
301303
No special configuration is required.
302304
You need only follow the official guide.
303305

304306

305307

308+
[[cloud-deployment-aws-java-se-platform]]
306309
===== Using the Java SE Platform
307310
This option applies to Spring Boot projects that produce a jar file and run an embedded web container.
308311
Elastic Beanstalk environments run an nginx instance on port 80 to proxy the actual application, running on port 5000.
@@ -344,6 +347,7 @@ You can also create single instance environments by using the CLI and the follow
344347

345348

346349

350+
[[cloud-deployment-aws-summary]]
347351
==== Summary
348352
This is one of the easiest ways to get to AWS, but there are more things to cover, such as how to integrate Elastic Beanstalk into any CI / CD tool, use the Elastic Beanstalk Maven plugin instead of the CLI, and others.
349353
There is a https://exampledriven.wordpress.com/2017/01/09/spring-boot-aws-elastic-beanstalk-example/[blog post] covering these topics more in detail.

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ If you are getting started with Spring Boot or 'Spring' in general, start with <
6262

6363

6464

65+
[[boot-documentation-workingwith]]
6566
== Working with Spring Boot
6667
Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot, We have you covered>>:
6768

@@ -73,6 +74,7 @@ Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot,
7374

7475

7576

77+
[[boot-documentation-learning]]
7678
== Learning about Spring Boot Features
7779
Need more details about Spring Boot's core features?
7880
<<spring-boot-features.adoc#boot-features, The following content is for you>>:
@@ -86,6 +88,7 @@ Need more details about Spring Boot's core features?
8688

8789

8890

91+
[[boot-documentation-production]]
8992
== Moving to Production
9093
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:
9194

@@ -95,6 +98,7 @@ When you are ready to push your Spring Boot application to production, we have <
9598

9699

97100

101+
[[boot-documentation-advanced]]
98102
== Advanced Topics
99103
Finally, we have a few topics for more advanced users:
100104

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -588,6 +588,7 @@ If you still choose to use `h2c`, you can check <<howto-configure-http2-h2c, the
588588
====
589589

590590

591+
591592
[[howto-configure-http2-tomcat]]
592593
==== HTTP/2 with Tomcat
593594
Spring Boot ships by default with Tomcat 9.0.x which supports HTTP/2 out of the box when using JDK 9 or later.
@@ -607,6 +608,7 @@ Starting Tomcat 9.0.x on JDK 8 without that native support logs the following er
607608
This error is not fatal, and the application still starts with HTTP/1.1 SSL support.
608609

609610

611+
610612
[[howto-configure-http2-jetty]]
611613
==== HTTP/2 with Jetty
612614
For HTTP/2 support, Jetty requires the additional `org.eclipse.jetty.http2:http2-server` dependency.
@@ -694,7 +696,6 @@ For Undertow, we need to enable the HTTP2 option:
694696

695697

696698

697-
698699
[[howto-configure-webserver]]
699700
=== Configure the Web Server
700701
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>>`").
@@ -1297,6 +1298,8 @@ The following example configures `HttpComponentsClientRequestFactory` with an `H
12971298
include::{code-examples}/web/client/RestTemplateProxyCustomizationExample.java[tag=customizer]
12981299
----
12991300

1301+
1302+
13001303
[[howto-webclient-reactor-netty-customization]]
13011304
=== Configure the TcpClient used by a Reactor Netty-based WebClient
13021305
When Reactor Netty is on the classpath a Reactor Netty-based `WebClient` is auto-configured.
@@ -1312,6 +1315,7 @@ TIP: Note the use of `ReactorResourceFactory` for the connection provider and ev
13121315
This ensures efficient sharing of resources for the server receiving requests and the client making requests.
13131316

13141317

1318+
13151319
[[howto-logging]]
13161320
== Logging
13171321
Spring Boot has no mandatory logging dependency, except for the Commons Logging API, which is typically provided by Spring Framework's `spring-jcl` module.
@@ -1873,6 +1877,7 @@ Spring Boot provides properties in the `spring.data.web` namespace for customizi
18731877
Note that if you are using Spring Data REST, you must use the properties in the `spring.data.rest` namespace instead.
18741878

18751879

1880+
18761881
[[howto-use-exposing-spring-data-repositories-rest-endpoint]]
18771882
=== Expose Spring Data Repositories as REST Endpoint
18781883
Spring Data REST can expose the `Repository` implementations as REST endpoints for you,
@@ -2289,6 +2294,7 @@ For more about Spring Security, see the {spring-security}[Spring Security projec
22892294
If you define a `@Configuration` with a `WebSecurityConfigurerAdapter` in your application, it switches off the default webapp security settings in Spring Boot.
22902295

22912296

2297+
22922298
[[howto-change-the-user-details-service-and-add-user-accounts]]
22932299
=== Change the UserDetailsService and Add User Accounts
22942300
If you provide a `@Bean` of type `AuthenticationManager`, `AuthenticationProvider`, or `UserDetailsService`, the default `@Bean` for `InMemoryUserDetailsManager` is not created.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[legal]
1+
[[legal]]
22
= Legal
33

44
Copyright &#169; 2012-2021

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,6 +659,7 @@ If no `HealthIndicator` returns a status that is known to the `StatusAggregator`
659659
TIP: The `HealthContributorRegistry` can be used to register and unregister health indicators at runtime.
660660

661661

662+
662663
[[production-ready-health-indicators]]
663664
==== Auto-configured HealthIndicators
664665
The following `HealthIndicators` are auto-configured by Spring Boot when appropriate.
@@ -753,6 +754,7 @@ Additional `HealthIndicators` are available but not enabled by default:
753754

754755

755756

757+
[[production-ready-health-indicators-writing]]
756758
==== Writing Custom HealthIndicators
757759
To provide custom health information, you can register Spring beans that implement the {spring-boot-actuator-module-code}/health/HealthIndicator.java[`HealthIndicator`] interface.
758760
You need to provide an implementation of the `health()` method and return a `Health` response.
@@ -862,6 +864,7 @@ TIP: To handle the error automatically, consider extending from `AbstractReactiv
862864

863865

864866

867+
[[reactive-health-indicators-autoconfigured]]
865868
==== Auto-configured ReactiveHealthIndicators
866869
The following `ReactiveHealthIndicators` are auto-configured by Spring Boot when appropriate:
867870

@@ -889,6 +892,7 @@ TIP: If necessary, reactive indicators replace the regular ones.
889892
Also, any `HealthIndicator` that is not handled explicitly is wrapped automatically.
890893

891894

895+
892896
[[production-ready-health-groups]]
893897
==== Health Groups
894898
It's sometimes useful to organize health indicators into groups that can be used for different purposes.
@@ -2145,7 +2149,7 @@ NOTE: By default, metrics from all `MeterBinder` beans will be automatically bou
21452149

21462150

21472151

2148-
[[production-ready-metrics-per-meter-properties]]
2152+
[[production-ready-metrics-customizing]]
21492153
=== Customizing individual metrics
21502154
If you need to apply customizations to specific `Meter` instances you can use the `io.micrometer.core.instrument.config.MeterFilter` interface.
21512155

@@ -2180,6 +2184,7 @@ As the order of common tags cannot be guaranteed using this approach, Graphite u
21802184

21812185

21822186

2187+
[[production-ready-metrics-per-meter-properties]]
21832188
==== Per-meter properties
21842189
In addition to `MeterFilter` beans, it's also possible to apply a limited set of customization on a per-meter basis using properties.
21852190
Per-meter customizations apply to any all meter IDs that start with the given name.
@@ -2354,6 +2359,7 @@ If your Cloud Foundry UAA or Cloud Controller services use self-signed certifica
23542359

23552360

23562361

2362+
[[production-ready-custom-context-path]]
23572363
=== Custom context path
23582364
If the server's context-path has been configured to anything other than `/`, the Cloud Foundry endpoints will not be available at the root of the application.
23592365
For example, if `server.servlet.context-path=/app`, Cloud Foundry endpoints will be available at `/app/cloudfoundryapplication/*`.

0 commit comments

Comments
 (0)