Browse Source

Migrated to docs.spring.io & updated sc-build

pull/773/head
Marcin Grzejszczak 5 years ago
parent
commit
5e9f6c2925
  1. 3
      README.adoc
  2. 16
      docs/pom.xml
  3. 2
      docs/src/main/asciidoc/_configprops.adoc
  4. 2
      pom.xml

3
README.adoc

@ -4,6 +4,7 @@ Manual changes to this file will be lost when it is generated again. @@ -4,6 +4,7 @@ Manual changes to this file will be lost when it is generated again.
Edit the files in the src/main/asciidoc/ directory instead.
////
image::https://circleci.com/gh/spring-cloud/spring-cloud-commons.svg?style=svg[Build Status, link=https://circleci.com/gh/spring-cloud/spring-cloud-commons]
@ -300,4 +301,4 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t @@ -300,4 +301,4 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t
- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`.
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.

16
docs/pom.xml

@ -16,8 +16,8 @@ @@ -16,8 +16,8 @@
<properties>
<docs.main>spring-cloud-commons</docs.main>
<main.basedir>${basedir}/..</main.basedir>
<docs.whitelisted.branches>2.1.x,2.2.x</docs.whitelisted.branches>
<configprops.inclusionPattern>spring.cloud.*</configprops.inclusionPattern>
<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
</properties>
<dependencies>
<dependency>
@ -29,17 +29,6 @@ @@ -29,17 +29,6 @@
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<!--skip deploy (this is just a test module) -->
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>docs</id>
@ -69,6 +58,9 @@ @@ -69,6 +58,9 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
</plugin>
</plugins>
</build>
</profile>

2
docs/src/main/asciidoc/_configprops.adoc

@ -46,4 +46,4 @@ @@ -46,4 +46,4 @@
|spring.cloud.service-registry.auto-registration.register-management | true | Whether to register the management as a service. Defaults to true.
|spring.cloud.util.enabled | true | Enables creation of Spring Cloud utility beans.
|===
|===

2
pom.xml

@ -13,7 +13,7 @@ @@ -13,7 +13,7 @@
<parent>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId>
<version>2.3.0.RELEASE</version>
<version>2.3.1.BUILD-SNAPSHOT</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<scm>

Loading…
Cancel
Save