Skip to content

Commit c3c22c0

Browse files
committed
Polish "Fix broken links to appendix"
Closes gh-15933
1 parent 3428c0e commit c3c22c0

File tree

6 files changed

+17
-19
lines changed

6 files changed

+17
-19
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,8 +336,8 @@ This section contains three examples of using `findmainclass`.
336336
If you want to use a build tool other than Maven, Gradle, or Ant, you likely need to
337337
develop your own plugin. Executable jars need to follow a specific format and certain
338338
entries need to be written in an uncompressed form (see the
339-
"`<<appendix.adoc#executable-jar, executable jar format>>`" section
340-
in the appendix for details).
339+
"`<<appendix.adoc#executable-jar, executable jar format>>`" section in the appendix for
340+
details).
341341

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

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,7 @@ Finally, we have a few topics for more advanced users:
142142
<<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven>> |
143143
<<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle>>
144144
* *Appendix:*
145-
<<appendix.adoc#common-application-properties, Application
146-
Properties>> |
147-
<<appendix.adoc#auto-configuration-classes, Auto-configuration
148-
classes>> |
145+
<<appendix.adoc#common-application-properties, Application Properties>> |
146+
<<appendix.adoc#auto-configuration-classes, Auto-configuration classes>> |
149147
<<appendix.adoc#executable-jar, Executable Jars>>
150148

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -728,8 +728,8 @@ this approach is that it becomes hard to see which libraries are in your applica
728728
can also be problematic if the same filename is used (but with different content) in
729729
multiple jars.
730730
731-
Spring Boot takes a <<appendix.adoc#executable-jar, different
732-
approach>> and lets you actually nest jars directly.
731+
Spring Boot takes a <<appendix.adoc#executable-jar, different approach>> and lets you
732+
actually nest jars directly.
733733
****
734734

735735
To create an executable jar, we need to add the `spring-boot-maven-plugin` to our

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2866,9 +2866,9 @@ then be depended upon by your application and other projects.
28662866
If you cannot rearrange your code as recommended above, Spring Boot's Maven and Gradle
28672867
plugins must be configured to produce a separate artifact that is suitable for use as a
28682868
dependency. The executable archive cannot be used as a dependency as the
2869-
<<appendix.adoc#executable-jar-jar-file-structure,executable jar
2870-
format>> packages application classes in `BOOT-INF/classes`. This means
2871-
that they cannot be found when the executable jar is used as a dependency.
2869+
<<appendix.adoc#executable-jar-jar-file-structure,executable jar format>> packages
2870+
application classes in `BOOT-INF/classes`. This means that they cannot be found when the
2871+
executable jar is used as a dependency.
28722872

28732873
To produce the two artifacts, one that can be used as a dependency and one that is
28742874
executable, a classifier must be specified. This classifier is applied to the name of the

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,8 @@ Boot's default dependency metadata to deduce the artifact's group and version.
189189
NOTE: The default metadata is tied to the version of the CLI that you use. it changes only
190190
when you move to a new version of the CLI, putting you in control of when the versions of
191191
your dependencies may change. A table showing the dependencies and their versions that are
192-
included in the default metadata can be found in the <<appendix.adoc>>.
192+
included in the default metadata can be found in the
193+
<<appendix.adoc#appendix-dependency-versions,appendix>>.
193194

194195

195196

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1044,7 +1044,7 @@ as any other bean, as shown in the following example:
10441044

10451045
TIP: Using `@ConfigurationProperties` also lets you generate metadata files that can be
10461046
used by IDEs to offer auto-completion for your own keys. See the
1047-
<<configuration-metadata>> appendix for details.
1047+
<<appendix.adoc#configuration-metadata,appendix>> for details.
10481048

10491049

10501050

@@ -8357,10 +8357,10 @@ particular, do not include your keys in the namespaces that Spring Boot uses (su
83578357
these namespaces in the future in ways that break your modules.
83588358

83598359
Make sure to
8360-
<<appendix.adoc#configuration-metadata-annotation-processor,trigger
8361-
meta-data generation>> so that IDE assistance is available for your keys as well. You may
8362-
want to review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to
8363-
make sure your keys are properly documented.
8360+
<<appendix.adoc#configuration-metadata-annotation-processor,trigger meta-data
8361+
generation>> so that IDE assistance is available for your keys as well. You may want to
8362+
review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to make
8363+
sure your keys are properly documented.
83648364

83658365

83668366

@@ -8604,8 +8604,7 @@ class KotlinExampleProperties {
86048604
}
86058605
----
86068606

8607-
TIP: To generate
8608-
<<appendix.adoc#configuration-metadata-annotation-processor,your own
8607+
TIP: To generate <<appendix.adoc#configuration-metadata-annotation-processor,your own
86098608
metadata>> using the annotation processor, {kotlin-documentation}kapt.html[`kapt` should
86108609
be configured] with the `spring-boot-configuration-processor` dependency.
86118610

0 commit comments

Comments
 (0)