From c3c22c0a8a38a6f7e8eabf0b3ba480cdd03b9c29 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 13 Feb 2019 10:52:42 +0100 Subject: [PATCH] Polish "Fix broken links to appendix" Closes gh-15933 --- .../src/main/asciidoc/build-tool-plugins.adoc | 4 ++-- .../src/main/asciidoc/documentation-overview.adoc | 6 ++---- .../src/main/asciidoc/getting-started.adoc | 4 ++-- .../spring-boot-docs/src/main/asciidoc/howto.adoc | 6 +++--- .../src/main/asciidoc/spring-boot-cli.adoc | 3 ++- .../src/main/asciidoc/spring-boot-features.adoc | 13 ++++++------- 6 files changed, 17 insertions(+), 19 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc index ab669fcd6e..d6f5a3ff11 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc @@ -336,8 +336,8 @@ This section contains three examples of using `findmainclass`. If you want to use a build tool other than Maven, Gradle, or Ant, you likely need to develop your own plugin. Executable jars need to follow a specific format and certain entries need to be written in an uncompressed form (see the -"`<>`" section -in the appendix for details). +"`<>`" section in the appendix for +details). The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to actually generate jars. If you need to, you may use this library directly. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc index 43a96ce4e7..905f21bf06 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc @@ -142,9 +142,7 @@ Finally, we have a few topics for more advanced users: <> | <> * *Appendix:* -<> | -<> | +<> | +<> | <> diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc index 7dd551b9fd..ae00637f94 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -728,8 +728,8 @@ this approach is that it becomes hard to see which libraries are in your applica can also be problematic if the same filename is used (but with different content) in multiple jars. -Spring Boot takes a <> and lets you actually nest jars directly. +Spring Boot takes a <> and lets you +actually nest jars directly. **** To create an executable jar, we need to add the `spring-boot-maven-plugin` to our diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc index 616de4da56..a9422a83ad 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -2866,9 +2866,9 @@ then be depended upon by your application and other projects. If you cannot rearrange your code as recommended above, Spring Boot's Maven and Gradle plugins must be configured to produce a separate artifact that is suitable for use as a dependency. The executable archive cannot be used as a dependency as the -<> packages application classes in `BOOT-INF/classes`. This means -that they cannot be found when the executable jar is used as a dependency. +<> packages +application classes in `BOOT-INF/classes`. This means that they cannot be found when the +executable jar is used as a dependency. To produce the two artifacts, one that can be used as a dependency and one that is executable, a classifier must be specified. This classifier is applied to the name of the diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc index 0ac10eec18..ecafe73b92 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc @@ -189,7 +189,8 @@ Boot's default dependency metadata to deduce the artifact's group and version. NOTE: The default metadata is tied to the version of the CLI that you use. it changes only when you move to a new version of the CLI, putting you in control of when the versions of your dependencies may change. A table showing the dependencies and their versions that are -included in the default metadata can be found in the <>. +included in the default metadata can be found in the +<>. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 77de439a30..76a77506b1 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -1044,7 +1044,7 @@ as any other bean, as shown in the following example: TIP: Using `@ConfigurationProperties` also lets you generate metadata files that can be used by IDEs to offer auto-completion for your own keys. See the -<> appendix for details. +<> for details. @@ -8357,10 +8357,10 @@ particular, do not include your keys in the namespaces that Spring Boot uses (su these namespaces in the future in ways that break your modules. Make sure to -<> so that IDE assistance is available for your keys as well. You may -want to review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to -make sure your keys are properly documented. +<> so that IDE assistance is available for your keys as well. You may want to +review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to make +sure your keys are properly documented. @@ -8604,8 +8604,7 @@ class KotlinExampleProperties { } ---- -TIP: To generate -<> using the annotation processor, {kotlin-documentation}kapt.html[`kapt` should be configured] with the `spring-boot-configuration-processor` dependency.