root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Polish documentation

This commit is contained in:
Phillip Webb 2019-08-30 19:13:12 -07:00
parent 7f9d143e01
commit 348d65b4fe
6 changed files with 50 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spring-boot-project/spring-boot-docs/pom.xml
View File

@ -1239,7 +1239,7 @@
<doctype>book</doctype>
<attributes>
<docinfo>true</docinfo>
<spring-boot-repo>${spring-boot-repo}</spring-boot-repo>
<spring-boot-artifactory-repo>${spring-boot-artifactory-repo}</spring-boot-artifactory-repo>
<github-tag>${github-tag}</github-tag>
<jooq-version>${jooq.version}</jooq-version>
<spring-boot-version>${revision}</spring-boot-version>
@ -1449,7 +1449,7 @@
input="${version-type}" regexp="(RC)\d+" replace="MILESTONE" />
<propertyregex property="version-type" override="true"
input="${version-type}" regexp="BUILD-(.*)" replace="SNAPSHOT" />
<stringutil string="${version-type}" property="spring-boot-repo">
<stringutil string="${version-type}" property="spring-boot-artifactory-repo">
<lowercase />
</stringutil>
<var name="github-tag" value="v${revision}" />

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

@ -148,7 +148,7 @@ The following listing shows a typical `pom.xml` file:
</plugins>
</build>
ifeval::["{spring-boot-repo}" != "release"]
ifeval::["{spring-boot-artifactory-repo}" != "release"]
<!-- Add Spring repositories -->
<!-- (you don't need this if you are using a .RELEASE version) -->
<repositories>
@ -215,8 +215,8 @@ You do not need to use the CLI to work with Spring Boot, but it is definitely th
==== Manual Installation
You can download the Spring CLI distribution from the Spring software repository:
* https://repo.spring.io/{spring-boot-repo}/org/springframework/boot/spring-boot-cli/{spring-boot-version}/spring-boot-cli-{spring-boot-version}-bin.zip[spring-boot-cli-{spring-boot-version}-bin.zip]
* https://repo.spring.io/{spring-boot-repo}/org/springframework/boot/spring-boot-cli/{spring-boot-version}/spring-boot-cli-{spring-boot-version}-bin.tar.gz[spring-boot-cli-{spring-boot-version}-bin.tar.gz]
* https://repo.spring.io/{spring-boot-artifactory-repo}/org/springframework/boot/spring-boot-cli/{spring-boot-version}/spring-boot-cli-{spring-boot-version}-bin.zip[spring-boot-cli-{spring-boot-version}-bin.zip]
* https://repo.spring.io/{spring-boot-artifactory-repo}/org/springframework/boot/spring-boot-cli/{spring-boot-version}/spring-boot-cli-{spring-boot-version}-bin.tar.gz[spring-boot-cli-{spring-boot-version}-bin.tar.gz]
Cutting edge
https://repo.spring.io/snapshot/org/springframework/boot/spring-boot-cli/[snapshot distributions] are also available.
@ -464,7 +464,7 @@ Open your favorite text editor and add the following:
<!-- Additional lines to be added here... -->
ifeval::["{spring-boot-repo}" != "release"]
ifeval::["{spring-boot-artifactory-repo}" != "release"]
<!-- (you don't need this if you are using a .RELEASE version) -->
<repositories>
<repository>

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

@ -2019,7 +2019,7 @@ NOTE: By default, batch applications require a `DataSource` to store job details
If you want to deviate from that, you need to implement `BatchConfigurer`.
See {spring-batch-api}/core/configuration/annotation/EnableBatchProcessing.html[The Javadoc of `@EnableBatchProcessing`] for more details.
For more about Spring Batch, see the https://projects.spring.io/spring-batch/[Spring Batch project page].
For more about Spring Batch, see the {spring-batch}[Spring Batch project page].

35
spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc
View File

@ -8,7 +8,7 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson;
:icons: font
:hide-uri-scheme:
:spring-boot-repo: snapshot
:spring-boot-artifactory-repo: snapshot
:github-tag: master
:spring-boot-version: current
@ -49,27 +49,44 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson;
:spring-boot-test-autoconfigure-module-api: {spring-boot-api}/org/springframework/boot/test/autoconfigure
:spring-amqp-api: https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp
:spring-batch: https://spring.io/projects/spring-batch
:spring-batch-api: https://docs.spring.io/spring-batch/apidocs/org/springframework/batch
:spring-data: https://projects.spring.io/spring-data/
:spring-data: https://spring.io/projects/spring-data
:spring-data-cassandra: https://spring.io/projects/spring-data-cassandra
:spring-data-commons-api: https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data
:spring-data-jpa: https://projects.spring.io/spring-data-jpa/
:spring-data-couchbase: https://spring.io/projects/spring-data-couchbase
:spring-data-elasticsearch: https://spring.io/projects/spring-data-elasticsearch
:spring-data-gemfire: https://spring.io/projects/spring-data-gemfire
:spring-data-geode: https://spring.io/projects/spring-data-geode
:spring-data-jpa: https://spring.io/projects/spring-data-jpa
:spring-data-jpa-api: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa
:spring-data-mongodb: https://projects.spring.io/spring-data-mongodb/
:spring-data-jdbc-docs: https://docs.spring.io/spring-data/jdbc/docs/current/reference/html/
:spring-data-ldap: https://spring.io/projects/spring-data-ldap
:spring-data-mongodb: https://spring.io/projects/spring-data-mongodb
:spring-data-mongodb-api: https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb
:spring-data-neo4j: https://spring.io/projects/spring-data-neo4j
:spring-data-neo4j-docs: https://docs.spring.io/spring-data/neo4j/docs/current/reference/html/
:spring-data-redis: https://spring.io/projects/spring-data-redis
:spring-data-rest-api: https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest
:spring-framework: https://projects.spring.io/spring-framework/
:spring-data-solr: https://spring.io/projects/spring-data-solr
:spring-data-solr-docs: https://docs.spring.io/spring-data/solr/docs/current/reference/html/
:spring-framework: https://spring.io/projects/spring-framework
:spring-framework-api: https://docs.spring.io/spring/docs/{spring-framework-version}/javadoc-api/org/springframework
:spring-framework-docs: https://docs.spring.io/spring/docs/{spring-framework-version}/spring-framework-reference/
:spring-initializr-docs: https://docs.spring.io/initializr/docs/current/reference/html
:spring-integration: https://projects.spring.io/spring-integration/
:spring-integration: https://spring.io/projects/spring-integration
:spring-integration-docs: https://docs.spring.io/spring-integration/docs/{spring-integration-version}/reference/html
:spring-restdocs: https://projects.spring.io/spring-restdocs/
:spring-security: https://projects.spring.io/spring-security/
:spring-restdocs: https://spring.io/projects/spring-restdocs
:spring-security: https://spring.io/projects/spring-security
:spring-security-docs: https://docs.spring.io/spring-security/site/docs/{spring-security-version}/reference/htmlsingle
:spring-security-oauth2: https://spring.io/projects/spring-security-oauth
:spring-security-oauth2-docs: https://projects.spring.io/spring-security-oauth/docs/oauth2.html
:spring-session: https://projects.spring.io/spring-session/
:spring-session: https://spring.io/projects/spring-session
:spring-webservices-docs: https://docs.spring.io/spring-ws/docs/{spring-webservices-version}/reference/
:ant-docs: https://ant.apache.org/manual
:dependency-management-plugin-code: https://github.com/spring-gradle-plugins/dependency-management-plugin
:gradle-docs: https://docs.gradle.org/4.2.1/userguide

2
spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View File

@ -521,7 +521,6 @@ A request predicate is automatically generated for each operation on a web-expos
[[production-ready-endpoints-custom-web-predicate-path]]
===== Path
The path of the predicate is determined by the ID of the endpoint and the base path of web-exposed endpoints.
The default base path is `/actuator`.
For example, an endpoint with the ID `sessions` will use `/actuator/sessions` as its path in the predicate.
@ -707,6 +706,7 @@ The following `HealthIndicators` are auto-configured by Spring Boot when appropr
TIP: You can disable them all by setting the `management.health.defaults.enabled` property.
==== Writing Custom HealthIndicators
To provide custom health information, you can register Spring beans that implement the {spring-boot-actuator-module-code}/health/HealthIndicator.java[`HealthIndicator`] interface.
You need to provide an implementation of the `health()` method and return a `Health` response.

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

@ -2979,7 +2979,7 @@ Alternatively, you can define your own `JwtDecoder` bean for servlet application
==== Authorization Server
Currently, Spring Security does not provide support for implementing an OAuth 2.0 Authorization Server.
However, this functionality is available from the https://projects.spring.io/spring-security-oauth/[Spring Security OAuth] project, which will eventually be superseded by Spring Security completely.
However, this functionality is available from the {spring-security-oauth2}[Spring Security OAuth] project, which will eventually be superseded by Spring Security completely.
Until then, you can use the `spring-security-oauth2-autoconfigure` module to easily set up an OAuth 2.0 authorization server; see its https://docs.spring.io/spring-security-oauth2-boot[documentation] for instructions.
@ -3255,7 +3255,7 @@ For example, a `CityRepository` interface might declare a `findAllByState(String
For more complex queries, you can annotate your method with Spring Data's {spring-data-jpa-api}/repository/Query.html[`Query`] annotation.
Spring Data repositories usually extend from the {spring-data-commons-api}/repository/Repository.html[`Repository`] or {spring-data-commons-javadoc}/repository/CrudRepository.html[`CrudRepository`] interfaces.
Spring Data repositories usually extend from the {spring-data-commons-api}/repository/Repository.html[`Repository`] or {spring-data-commons-api}/repository/CrudRepository.html[`CrudRepository`] interfaces.
If you use auto-configuration, repositories are searched from the package containing your main configuration class (the one annotated with `@EnableAutoConfiguration` or `@SpringBootApplication`) down.
The following example shows a typical Spring Data repository interface definition:
@ -3329,7 +3329,7 @@ Spring Boot will auto-configure Spring Data's JDBC repositories when the necessa
They can be added to your project with a single dependency on `spring-boot-starter-data-jdbc`.
If necessary, you can take control of Spring Data JDBC's configuration by adding the `@EnableJdbcRepositories` annotation or a `JdbcConfiguration` subclass to your application.
TIP: For complete details of Spring Data JDBC, please refer to the https://projects.spring.io/spring-data-jdbc/[reference documentation].
TIP: For complete details of Spring Data JDBC, please refer to the {spring-data-jdbc-docs}[reference documentation].
@ -3461,19 +3461,19 @@ You can also create your own `org.jooq.Configuration` `@Bean` if you want to tak
== Working with NoSQL Technologies
Spring Data provides additional projects that help you access a variety of NoSQL technologies, including:
* https://spring.io/projects/spring-data-mongodb[MongoDB]
* https://spring.io/projects/spring-data-neo4j[Neo4J]
* https://spring.io/projects/spring-data-elasticsearch[Elasticsearch]
* https://spring.io/projects/spring-data-solr[Solr]
* https://spring.io/projects/spring-data-redis[Redis]
* https://spring.io/projects/spring-data-gemfire[Gemfire] or https://spring.io/projects/spring-data-geode[Geode]
* https://spring.io/projects/spring-data-cassandra[Cassandra]
* https://spring.io/projects/spring-data-couchbase[Couchbase]
* https://spring.io/projects/spring-data-ldap[LDAP]
* {spring-data-mongodb}[MongoDB]
* {spring-data-neo4j}[Neo4J]
* {spring-data-elasticsearch}[Elasticsearch]
* {spring-data-solr}[Solr]
* {spring-data-redis}[Redis]
* {spring-data-gemfire}[Gemfire] or {spring-data-geode}[Geode]
* {spring-data-cassandra}[Cassandra]
* {spring-data-couchbase}[Couchbase]
* {spring-data-ldap}[LDAP]
Spring Boot provides auto-configuration for Redis, MongoDB, Neo4j, Elasticsearch, Solr Cassandra, Couchbase, and LDAP.
You can make use of the other projects, but you must configure them yourself.
Refer to the appropriate reference documentation at https://projects.spring.io/spring-data[projects.spring.io/spring-data].
Refer to the appropriate reference documentation at {spring-data}.
@ -3618,7 +3618,7 @@ As with `JdbcTemplate`, Spring Boot auto-configures a bean for you to inject the
}
----
See the {spring-data-mongodb-javadoc}/core/MongoOperations.html[`MongoOperations` Javadoc] for complete details.
See the {spring-data-mongodb-api}/core/MongoOperations.html[`MongoOperations` Javadoc] for complete details.
@ -3766,7 +3766,7 @@ You could take the JPA example from earlier and define `City` as Neo4j OGM `@Nod
The `spring-boot-starter-data-neo4j` "`Starter`" enables the repository support as well as transaction management.
You can customize the locations to look for repositories and entities by using `@EnableNeo4jRepositories` and `@EntityScan` respectively on a `@Configuration`-bean.
TIP: For complete details of Spring Data Neo4j, including its object mapping technologies, refer to the https://projects.spring.io/spring-data-neo4j/[reference documentation].
TIP: For complete details of Spring Data Neo4j, including its object mapping technologies, refer to the {spring-data-neo4j-docs}[reference documentation].
@ -3813,7 +3813,7 @@ As with the JPA repositories discussed earlier, the basic principle is that quer
In fact, both Spring Data JPA and Spring Data Solr share the same common infrastructure.
You could take the JPA example from earlier and, assuming that `City` is now a `@SolrDocument` class rather than a JPA `@Entity`, it works in the same way.
IP: For complete details of Spring Data Solr, refer to the https://projects.spring.io/spring-data-solr/[reference documentation].
IP: For complete details of Spring Data Solr, refer to the {spring-data-solr-docs}[reference documentation].