From f0b6f6a51624625a2814b531cb83bc0f0f46f8e5 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 17 Mar 2014 14:05:11 -0700 Subject: [PATCH] Remove quotes from internal documentation links Remove quote-marks from internal documentation links and instead favor italics. --- .../src/main/asciidoc/build-tool-plugins.adoc | 4 +- .../src/main/asciidoc/cloud-deployment.adoc | 6 +-- .../src/main/asciidoc/getting-started.adoc | 12 +++--- spring-boot-docs/src/main/asciidoc/howto.adoc | 38 +++++++++---------- .../asciidoc/production-ready-features.adoc | 2 +- .../src/main/asciidoc/spring-boot-cli.adoc | 4 +- .../main/asciidoc/spring-boot-features.adoc | 20 +++++----- .../src/main/asciidoc/using-spring-boot.adoc | 12 +++--- 8 files changed, 49 insertions(+), 49 deletions(-) diff --git a/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc b/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc index 6c503eba99..8a4f14aa4a 100644 --- a/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc +++ b/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc @@ -511,7 +511,7 @@ you may find that it includes unnecessary dependencies. If you want to use a build tool other than Maven or Gradle, you will 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 +'<>' section in the appendix for details). The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to @@ -577,4 +577,4 @@ technical details of the <> are covered in the appendix. If you have specific build related questions, you can check out the -``<>'' guides. +`<>' guides. diff --git a/spring-boot-docs/src/main/asciidoc/cloud-deployment.adoc b/spring-boot-docs/src/main/asciidoc/cloud-deployment.adoc index b12af54fe5..0e6ff49717 100644 --- a/spring-boot-docs/src/main/asciidoc/cloud-deployment.adoc +++ b/spring-boot-docs/src/main/asciidoc/cloud-deployment.adoc @@ -218,7 +218,7 @@ That should be it! Your application should be up and running on Heroku. [[cloud-deployment-cloudbees]] == CloudBees -CloudBees provides cloud-based ``continuous integration'' and ``continuous delevery'' +CloudBees provides cloud-based ``continuous integration'' and ``continuous delivery'' services as well as Java PaaS hosting. https://github.com/msgilligan[Sean Gilligan] has contributed an excellent https://github.com/CloudBees-community/springboot-gradle-cloudbees-sample[Spring Boot @@ -236,9 +236,9 @@ features that a PaaS can offer. These are just three of the most popular Java Pa providers, since Spring Boot is so amenable to cloud-based deployment you free to consider other providers as well. -The next section goes on to cover the <>; +The next section goes on to cover the '<>'; or you can jump ahead to read about -<>. +'<>'. diff --git a/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-docs/src/main/asciidoc/getting-started.adoc index be9d74a6cb..edec710ec0 100644 --- a/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -56,7 +56,7 @@ using the latest version of Java. === Installation instructions for the Java developer You can use Spring Boot in the same way as any standard java library. Simply include the appropriate `spring-boot-*.jar` files on your classpath. Spring Boot does not require -any special ``tools'' integration, so you can use any IDE or text editor; and there is +any special tools integration, so you can use any IDE or text editor; and there is nothing special about a Spring Boot application, so you can run and debug as you would any other Java program. @@ -720,12 +720,12 @@ As before, to gracefully exit the application hit `ctrl-c`. [[getting-started-whats-next]] == What to read next Hopefully this section has provided you with some of the Spring Boot basics, and got you -on your way to writing your own applications. If your a ``task oriented'' type of +on your way to writing your own applications. If your a task oriented type of developer you might want to jump over to http://spring.io and check out some of the http://spring.io/guides/[getting started] guides that solve specific '``How do I do that with Spring''' problems; we also have a Spring Boot specific -``<>'' reference documentation. +'<>' reference documentation. -Otherwise, the next logical step is to read the ``<>'' -section. If you're really impatient, you could also jump ahead and read about -``<>''. +Otherwise, the next logical step is to read '<>'. If +you're really impatient, you could also jump ahead and read about +'<>'. diff --git a/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-docs/src/main/asciidoc/howto.adoc index c665ca8f83..e51900abc7 100644 --- a/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -79,16 +79,16 @@ than one way to register additional ones: The `SpringApplication` sends some special `ApplicationEvents` to the listeners (even some before the context is created), and then registers the listeners for events published by the `ApplicationContext` as well. See -``<>'' in the -``<>'' section for a complete list. +'<>' in the +``Spring Boot features'' section for a complete list. [[howto-build-an-application-context-hierarchy]] === Build an ApplicationContext hierarchy (adding a parent or root context) You can use the `ApplicationBuilder` class to create parent/child `ApplicationContext` -hierarchies. See ``<>'' -in the ``<>'' section for more information. +hierarchies. See '<>' +in the ``Spring Boot features'' section for more information. @@ -132,8 +132,8 @@ not be a web application. [[howto-change-the-location-of-external-properties]] === Change the location of external properties of an application By default properties from different sources are added to the Spring `Environment` in a -defined order (see ``<>'' in -the ``<>'' section for the exact order). +defined order (see '<>' in +the ``Spring Boot features'' section for the exact order). A nice way to augment and modify this is to add `@PropertySource` annotations to your application sources. Classes passed to the `SpringApplication` static convenience @@ -212,8 +212,8 @@ The example YAML above corresponds to an `application.properties` file server.port=9000 ---- -See ``<>'' in -the ``<>'' section for more information +See '<>' in +the ``Spring Boot features'' section for more information about YAML. [[howto-set-active-spring-profiles]] @@ -239,8 +239,8 @@ A value set this way is replaced by the System property or environment variable but not by the `SpringApplicationBuilder.profiles()` method. Thus the latter Java API can be used to augment the profiles without changing the defaults. -See ``<>'' in -the ``<>'' section for more information. +See '<>' in +the ``Spring Boot features'' section for more information. @@ -335,8 +335,8 @@ environment variable). To switch off the HTTP endpoints completely, but still create a `WebApplicationContext`, use `server.port=-1` (this is sometimes useful for testing). -For more details look at ``<>'' -in the ``<>'' section, or the +For more details look at '<>' +in the ``Spring Boot features'' section, or the {sc-spring-boot-autoconfigure}/web/ServerProperties.{sc-ext}[`ServerProperties`] source code. @@ -360,7 +360,7 @@ out of the event wehen it is published. [[howto-configure-tomcat]] === Configure Tomcat Generally you can follow the advice from -``<>'' about +'<>' about `@ConfigurationProperties` (`ServerProperties` is the main one here), but also look at `EmbeddedServletContainerCustomizer` and various Tomcat specific `*Customizers` that you can add in one of those. The Tomcat APIs are quite rich so once you have access to the @@ -466,7 +466,7 @@ Example in Gradle: [[howto-configure-jetty]] === Configure Jetty Generally you can follow the advice from -``<>'' about +'<>' about `@ConfigurationProperties` (`ServerProperties` is the main one here), but also look at `EmbeddedServletContainerCustomizer`. The Jetty APIs are quite rich so once you have access to the `JettyEmbeddedServletContainerFactory` you can modify it in a number @@ -590,7 +590,7 @@ provided of type `HttpMessageConverters` (always available if you use the defaul configuration) which has some useful methods to access the default and user-enhanced message converters. -See also the ``<>'' section and the +See also the '<>' section and the {sc-spring-boot-autoconfigure}/web/WebMvcAutoConfiguration.{sc-ext}[`WebMvcAutoConfiguration`] source code for more details. @@ -788,8 +788,8 @@ action. [[howto-configure-a-datasource]] === Configure a DataSource To override the default settings just define a `@Bean` of your own of type `DataSource`. -See ``<>'' in the -``<>'' section and the +See '<>' in the +``Spring Boot features'' section and the {sc-spring-boot-autoconfigure}/jdbc/DataSourceAutoConfiguration.{sc-ext}[`DataSourceAutoConfiguration`] class for more details. @@ -992,8 +992,8 @@ also set `management.address` to a valid IP address that the server is able to b For more detail look at the {sc-spring-boot-actuator}/autoconfigure/ManagementServerProperties.{sc-ext}[`ManagementServerProperties`] source code and -``<>'' -in the ``<>'' section. +'<>' +in the ``Production-ready features'' section. diff --git a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index 89bce73904..4fc2133ff6 100644 --- a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -747,4 +747,4 @@ might want to read about graphing tools such as http://graphite.wikidot.com/[Gra Otherwise, you can continue on, to read about <> or jump ahead for some in depth information about Spring Boot's -<>. +'<>'. diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc index affd73db8e..2298fb1a6e 100644 --- a/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc +++ b/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc @@ -14,7 +14,7 @@ familiar Java-like syntax, without so much boilerplate code. == Installing the CLI The Spring Boot CLI can be installed manually; using GVM (the Groovy Environment Manually) or using Homebrew if you are an OSX user. See -``<>'' +'<>' in the ``Getting started'' section for comprehensive installation instructions. @@ -319,5 +319,5 @@ Spring Boot CLI. There is also extensive javadoc throughout the If you find that you reach the limit of the CLI tool, you will probably want to look at converting your application to full Gradle or Maven built ``groovy project''. The next section covers Spring Boot's -``<>'' that you can +'<>' that you can use with Gradle or Maven. diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 616f30ba5c..3e8e3244bb 100644 --- a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -5,8 +5,8 @@ -- This section dives into the details of Spring Boot. Here you can learn about the key features that you will want to use and customize. If you haven't already, you might want -to read the ``<>'' and -``<>'' sections so that you have a good grounding +to read the '<>' and +'<>' sections so that you have a good grounding of the basics. -- @@ -67,7 +67,7 @@ for spring beans. In most cases these will be references to `@Configuration` cla they could also be references to XML configuration or to packages that should be scanned. It is also possible to configure the `SpringApplication` using an `application.properties` -file. See ``<>'' for details. +file. See '<>' for details. For a complete list of the configuration options, see the {dc-spring-boot}/SpringApplication.{dc-ext}[`SpringApplication` Javadoc]. @@ -293,7 +293,7 @@ properties). ---- TIP: You can also use this technique to create ``short'' variants of existing Spring Boot -properties. See the ``<>'' how-to +properties. See the '<>' how-to for details. @@ -508,7 +508,7 @@ You can also add a custom Spring `Validator` by creating a bean definition calle TIP: The `spring-boot-actuator` module includes an endpoint that exposes all `@ConfigurationProperties` beans. Simply point your web browser to `/configprops` or use the equivalent JMX endpoint. See the -``<>''. +'<>'. section for details. @@ -579,7 +579,7 @@ possible to activate profiles using Spring's `ConfigurableEnvironment` interface === Profile specific configuration files Profile specific variants of both `application.properties` (or `application.yml`) and files referenced via `@ConfigurationProperties` are considered as files are loaded. -See ``<>'' for details. +See '<>' for details. @@ -712,7 +712,7 @@ use the `spring-boot-starter-web` module to get up and running quickly. If you haven't yet developed a Spring Boot web application you can follow the "Hello World!" example in the -``<>'' section. +'<>' section. @@ -990,8 +990,8 @@ Obviously, in-memory databases do not provide persistent storage; you will need populate your database when your application starts and be prepared to throw away data when your application ends. -TIP: The ``How-to'' section includes a <> +TIP: The ``How-to'' section includes a '<>' Spring Boot can auto-configure embedded http://www.h2database.com[H2], http://hsqldb.org/[HSQL] and http://db.apache.org/derby/[Derby] databases. You don't @@ -1155,7 +1155,7 @@ considered. A typical entity class would look something like this: ---- TIP: You can customize entity scanning locations using the `@EntityScan` annotation. -See the ``<>'' +See the '<>' how-to. diff --git a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc index 84842e9abf..79aad331e8 100644 --- a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc +++ b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc @@ -5,13 +5,13 @@ -- This section goes into more detail about how you should use Spring Boot. It covers topics such as build systems, auto-configuration and run/deployment options. We also cover some -Spring Boot ``best practices''. Although there is nothing particularly special about +Spring Boot best practices. Although there is nothing particularly special about Spring Boot (it is just another library that you can consume). There are a few recommendations that, when followed, will make your development process just a little easier. If you're just starting out with Spring Boot, you should probably read the -``<>'' guide before diving into +'<>' guide before diving into this section. -- @@ -175,7 +175,7 @@ It is possible to build a Spring Boot project using Apache Ant, however, no spec support or plugins are provided. Ant scripts can use the Ivy dependency system to import starter POMs. -See the ``<>'' ``How-to'' for more +See the '<>' ``How-to'' for more complete instructions. @@ -260,7 +260,7 @@ and Hibernate. |=== In addition to the application starters, the following starters can be used to -add ``<>'' features. +add '<>' features. .Spring Boot production ready starters |=== @@ -583,7 +583,7 @@ are also ideally suited for cloud-based deployment. For additional ``production ready'' features, such as health, auditing and metric REST or JMX end-points; consider adding `spring-boot-actuator`. See -``<>'' for details. +'<>' for details. @@ -591,7 +591,7 @@ or JMX end-points; consider adding `spring-boot-actuator`. See == What to read next You should now have good understanding of how you can use Spring Boot along with some best practices that you should follow. You can now go on to learn about specific -``<>'' in depth, or you +'<>' in depth, or you could skip ahead and read about the ``<>'' aspects of Spring Boot.