GitHub-Spring
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Use versioned links in documentation 

Update the reference documentation to use versioned links rather then
`/current/` whenever possible.

Closes gh-18000
pull/18464/head
Phillip Webb 6 years ago
parent
348d65b4fe
commit
368eb566fb
5 changed files with 121 additions and 32 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 101
      spring-boot-project/spring-boot-docs/pom.xml
  2. 4
      spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc
  3. 23
      spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc
  4. 2
      spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
  5. 23
      spring-boot-project/spring-boot-docs/src/main/xslt/versionProperties.xsl

101
spring-boot-project/spring-boot-docs/pom.xml
Unescape View File

@ -822,6 +822,11 @@ @@ -822,6 +822,11 @@
<artifactId>spring-data-cassandra</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-commons</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-couchbase</artifactId>
@ -837,6 +842,11 @@ @@ -837,6 +842,11 @@
<artifactId>spring-data-jdbc</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jdbc</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa</artifactId>
@ -1163,29 +1173,55 @@ @@ -1163,29 +1173,55 @@
<version>1.0.1</version>
<executions>
<execution>
<id>transform-effective-pom</id>
<goals>
<goal>transform</goal>
</goals>
<configuration>
<transformationSets>
<transformationSet>
<dir>${project.build.directory}/external-resources</dir>
<includes>
<include>effective-pom.xml</include>
</includes>
<stylesheet>src/main/xslt/dependencyVersions.xsl</stylesheet>
<fileMappers>
<fileMapper
implementation="org.codehaus.plexus.components.io.filemappers.FileExtensionMapper">
<targetExtension>.adoc</targetExtension>
</fileMapper>
</fileMappers>
<outputDir>${project.build.directory}/generated-resources</outputDir>
</transformationSet>
</transformationSets>
</configuration>
</execution>
<execution>
<id>transform-flattened-pom</id>
<phase>process-resources</phase>
<goals>
<goal>transform</goal>
</goals>
<configuration>
<transformationSets>
<transformationSet>
<dir>${project.basedir}</dir>
<includes>
<include>.flattened-pom.xml</include>
</includes>
<stylesheet>src/main/xslt/versionProperties.xsl</stylesheet>
<fileMappers>
<fileMapper
implementation="org.codehaus.plexus.components.io.filemappers.FileExtensionMapper">
<targetExtension>.properties</targetExtension>
</fileMapper>
</fileMappers>
<outputDir>${project.build.directory}/generated-resources</outputDir>
</transformationSet>
</transformationSets>
</configuration>
</execution>
</executions>
<configuration>
<transformationSets>
<transformationSet>
<dir>${project.build.directory}/external-resources</dir>
<includes>
<include>effective-pom.xml</include>
</includes>
<stylesheet>src/main/xslt/dependencyVersions.xsl</stylesheet>
<fileMappers>
<fileMapper
implementation="org.codehaus.plexus.components.io.filemappers.FileExtensionMapper">
<targetExtension>.adoc</targetExtension>
</fileMapper>
</fileMappers>
<outputDir>${project.build.directory}/generated-resources</outputDir>
</transformationSet>
</transformationSets>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.gmavenplus</groupId>
@ -1223,6 +1259,26 @@ @@ -1223,6 +1259,26 @@
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>properties-maven-plugin</artifactId>
<version>1.0.0</version>
<executions>
<execution>
<id>read-flattenedpom-versions</id>
<phase>prepare-package</phase>
<goals>
<goal>read-project-properties</goal>
</goals>
<inherited>false</inherited>
<configuration>
<files>
<file>${project.build.directory}/generated-resources/.flattened-pom.properties</file>
</files>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
@ -1243,6 +1299,15 @@ @@ -1243,6 +1299,15 @@
<github-tag>${github-tag}</github-tag>
<jooq-version>${jooq.version}</jooq-version>
<spring-boot-version>${revision}</spring-boot-version>
<spring-amqp-version>${spring-amqp.version}</spring-amqp-version>
<spring-data-couchbase-version>${flattenedpom.version.org.springframework.data.spring-data-couchbase}</spring-data-couchbase-version>
<spring-data-commons-version>${flattenedpom.version.org.springframework.data.spring-data-commons}</spring-data-commons-version>
<spring-data-jpa-version>${flattenedpom.version.org.springframework.data.spring-data-jpa}</spring-data-jpa-version>
<spring-data-jdbc-version>${flattenedpom.version.org.springframework.data.spring-data-jdbc}</spring-data-jdbc-version>
<spring-data-mongodb-version>${flattenedpom.version.org.springframework.data.spring-data-mongodb}</spring-data-mongodb-version>
<spring-data-neo4j-version>${flattenedpom.version.org.springframework.data.spring-data-neo4j}</spring-data-neo4j-version>
<spring-data-rest-version>${flattenedpom.version.org.springframework.data.spring-data-rest-core}</spring-data-rest-version>
<spring-data-solr-version>${flattenedpom.version.org.springframework.data.spring-data-solr}</spring-data-solr-version>
<spring-framework-version>${spring-framework.version}</spring-framework-version>
<spring-integration-version>${spring-integration.version}</spring-integration-version>
<spring-security-version>${spring-security.version}</spring-security-version>

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

@ -1187,7 +1187,7 @@ For example, the test in the snippet below will run with an authenticated user t @@ -1187,7 +1187,7 @@ For example, the test in the snippet below will run with an authenticated user t
Spring Security provides comprehensive integration with Spring MVC Test and this can also be used when testing controllers using the `@WebMvcTest` slice and `MockMvc`.
For additional details on Spring Security's testing support, refer to Spring Security's https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#test[reference documentation]).
For additional details on Spring Security's testing support, refer to Spring Security's {spring-security-docs}#test[reference documentation]).
@ -2105,7 +2105,7 @@ If you define a `@Configuration` with a `WebSecurityConfigurerAdapter` in your a @@ -2105,7 +2105,7 @@ If you define a `@Configuration` with a `WebSecurityConfigurerAdapter` in your a
[[howto-change-the-user-details-service-and-add-user-accounts]]
=== Change the UserDetailsService and Add User Accounts
If you provide a `@Bean` of type `AuthenticationManager`, `AuthenticationProvider`, or `UserDetailsService`, the default `@Bean` for `InMemoryUserDetailsManager` is not created.
This means you have the full feature set of Spring Security available (such as https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#jc-authentication[various authentication options]).
This means you have the full feature set of Spring Security available (such as {spring-security-docs}#jc-authentication[various authentication options]).
The easiest way to add user accounts is to provide your own `UserDetailsService` bean.

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

@ -48,37 +48,38 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson; @@ -48,37 +48,38 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson;
:spring-boot-test-autoconfigure-module-code: {spring-boot-code}/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure
: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-amqp-api: https://docs.spring.io/spring-amqp/docs/{spring-amqp-version}/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://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-commons-api: https://docs.spring.io/spring-data/commons/docs/{spring-data-commons-version}/api/org/springframework/data
:spring-data-couchbase: https://spring.io/projects/spring-data-couchbase
:spring-data-couchbase-docs: https://docs.spring.io/spring-data/couchbase/docs/{spring-data-couchbase-version}/reference/html/
: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-jdbc-docs: https://docs.spring.io/spring-data/jdbc/docs/current/reference/html/
:spring-data-jpa-api: https://docs.spring.io/spring-data/jpa/docs/{spring-data-jpa-version}/api/org/springframework/data/jpa
:spring-data-jdbc-docs: https://docs.spring.io/spring-data/jdbc/docs/{spring-data-jdbc-version}/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-mongodb-api: https://docs.spring.io/spring-data/mongodb/docs/{spring-data-mongodb-version}/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-neo4j-docs: https://docs.spring.io/spring-data/neo4j/docs/{spring-data-neo4j-version}/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-data-rest-api: https://docs.spring.io/spring-data/rest/docs/{spring-data-rest-version}/api/org/springframework/data/rest
: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-data-solr-docs: https://docs.spring.io/spring-data/solr/docs/{spring-data-solr-version}/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-initializr-docs: https://docs.spring.io/initializr/docs/current/reference/html/
:spring-integration: https://spring.io/projects/spring-integration
:spring-integration-docs: https://docs.spring.io/spring-integration/docs/{spring-integration-version}/reference/html
:spring-integration-docs: https://docs.spring.io/spring-integration/docs/{spring-integration-version}/reference/html/
: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-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://spring.io/projects/spring-session

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

@ -3282,7 +3282,7 @@ When using deferred or lazy bootstrapping, the auto-configured `EntityManagerFac @@ -3282,7 +3282,7 @@ When using deferred or lazy bootstrapping, the auto-configured `EntityManagerFac
If more than one exists, the one named `applicationTaskExecutor` will be used.
TIP: We have barely scratched the surface of Spring Data JPA.
For complete details, see the https://docs.spring.io/spring-data/jpa/docs/current/reference/html/[Spring Data JPA reference documentation].
For complete details, see the {spring-data-jdbc-docs}[Spring Data JPA reference documentation].

23
spring-boot-project/spring-boot-docs/src/main/xslt/versionProperties.xsl
Unescape View File

@ -0,0 +1,23 @@ @@ -0,0 +1,23 @@
<?xml version="1.0"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:mvn="http://maven.apache.org/POM/4.0.0"
version="1.0">
<xsl:output method="text" encoding="UTF-8" indent="no"/>
<xsl:key name="by-full-name" match="//mvn:dependency" use="concat(mvn:groupId, '.', mvn:artifactId)"/>
<xsl:template match="/">
<xsl:for-each select="//mvn:dependency[generate-id() = generate-id(key('by-full-name',
concat(mvn:groupId, '.', mvn:artifactId))[1])]">
<xsl:sort select="mvn:groupId"/>
<xsl:sort select="mvn:artifactId"/>
<xsl:text>flattenedpom.version.</xsl:text>
<xsl:copy-of select="mvn:groupId"/>
<xsl:text>.</xsl:text>
<xsl:copy-of select="mvn:artifactId"/>
<xsl:text>=</xsl:text>
<xsl:copy-of select="mvn:version"/>
<xsl:text>&#xa;</xsl:text>
</xsl:for-each>
</xsl:template>
</xsl:stylesheet>
Write Preview
Loading…
Cancel
Save