Updated the docs

This commit is contained in:
Marcin Grzejszczak
2016-07-13 12:19:37 +02:00
parent dd15af51d7
commit e9055ba690
9 changed files with 39 additions and 13 deletions

View File

@@ -134,6 +134,10 @@ is under constant development.
==== Videos
*Marcin Grzejszczak and Jakub Kubryński talking about Spring Cloud Contract Verifier*
video::msRFcQM07-Y[youtube]
*Olga Maciaszek-Sharma talking about Accurest (Spring Cloud Contract Verifier predecessor)*
video::daafmTYFoDU[youtube]
@@ -146,6 +150,7 @@ video::130779882[vimeo]
- http://www.slideshare.net/MarcinGrzejszczak/stick-to-the-rules-consumer-driven-contracts-201507-confitura[Slides from Marcin Grzejszczak's talk about Accurest]
- http://toomuchcoding.com/blog/categories/accurest/[Accurest related articles from Marcin Grzejszczak's blog]
- http://toomuchcoding.com/blog/categories/spring-cloud-contract/[Spring Cloud Contract related articles from Marcin Grzejszczak's blog]
=== Samples
@@ -169,13 +174,13 @@ Spring Cloud Contract Verifier stand out on the "market" of Consumer Driven Cont
Here you can find interesting links related to Spring Cloud Contract Verifier:
- https://github.com/Codearte/accurest[Spring Cloud Contract Verifier Github Repository]
- https://github.com/spring-cloud/spring-cloud-contract/[Spring Cloud Contract Verifier Github Repository]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html[Spring Cloud Contract Verifier Documentation]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/deprecated[Accurest Legacy Documentation]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#spring-cloud-contract-stub-runner[Spring Cloud Contract Stub Runner Documentation]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#stub-runner-for-messaging[Spring Cloud Contract Stub Runner Messaging Documentation]
- https://gitter.im/spring-cloud/spring-cloud-contract[Spring Cloud Contract Verifier Gitter]
- https://github.com/Codearte/accurest-maven-plugin[Spring Cloud Contract Verifier Maven Plugin]
- https://github.com/spring-cloud/spring-cloud-contract[Spring Cloud Contract Verifier Maven Plugin]
== Documentation

View File

@@ -15,7 +15,6 @@
<properties>
<docs.main>spring-cloud-contract</docs.main>
<main.basedir>${basedir}/..</main.basedir>
<mpir.skip>true</mpir.skip>
</properties>
<build>
<plugins>
@@ -53,6 +52,7 @@
<configuration>
<siteDirectory>${main.basedir}/spring-cloud-contract-verifier-maven-plugin/src/site/</siteDirectory>
<outputDirectory>${build.directory}/generated-docs/spring-cloud-contract-verifier-maven-plugin</outputDirectory>>
<stagingDirectory>${build.directory}/staging/fake/directory</stagingDirectory>
<skipDeploy>true</skipDeploy><!-- don't deploy site with maven-site-plugin -->
<!-- disable generateReports if you don't want to include the built-in reports -->
<generateReports>true</generateReports>
@@ -79,6 +79,7 @@
<phase>process-resources</phase>
<goals>
<goal>site</goal>
<goal>stage</goal>
</goals>
</execution>
</executions>

View File

@@ -117,6 +117,10 @@ is under constant development.
==== Videos
*Marcin Grzejszczak and Jakub Kubryński talking about Spring Cloud Contract Verifier*
video::msRFcQM07-Y[youtube]
*Olga Maciaszek-Sharma talking about Accurest (Spring Cloud Contract Verifier predecessor)*
video::daafmTYFoDU[youtube]
@@ -129,6 +133,7 @@ video::130779882[vimeo]
- http://www.slideshare.net/MarcinGrzejszczak/stick-to-the-rules-consumer-driven-contracts-201507-confitura[Slides from Marcin Grzejszczak's talk about Accurest]
- http://toomuchcoding.com/blog/categories/accurest/[Accurest related articles from Marcin Grzejszczak's blog]
- http://toomuchcoding.com/blog/categories/spring-cloud-contract/[Spring Cloud Contract related articles from Marcin Grzejszczak's blog]
=== Samples

View File

@@ -2,10 +2,10 @@
Here you can find interesting links related to Spring Cloud Contract Verifier:
- https://github.com/Codearte/accurest[Spring Cloud Contract Verifier Github Repository]
- https://github.com/spring-cloud/spring-cloud-contract/[Spring Cloud Contract Verifier Github Repository]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html[Spring Cloud Contract Verifier Documentation]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/deprecated[Accurest Legacy Documentation]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#spring-cloud-contract-stub-runner[Spring Cloud Contract Stub Runner Documentation]
- https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html/#stub-runner-for-messaging[Spring Cloud Contract Stub Runner Messaging Documentation]
- https://gitter.im/spring-cloud/spring-cloud-contract[Spring Cloud Contract Verifier Gitter]
- https://github.com/Codearte/accurest-maven-plugin[Spring Cloud Contract Verifier Maven Plugin]
- https://github.com/spring-cloud/spring-cloud-contract[Spring Cloud Contract Verifier Maven Plugin]

View File

@@ -147,4 +147,4 @@ include::{core_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resou
==== Maven Setup
Example of Maven can be found in the https://github.com/Codearte/accurest-maven-plugin/=publishing-wiremock-stubs-projectf-stubsjar[Spring Cloud Contract Verifier Maven Plugin README]
Example of Maven can be found in the https://github.com/spring-cloud/spring-cloud-contract/[Spring Cloud Contract Verifier README]

View File

@@ -66,7 +66,7 @@ repositories {
----
Read more: http://codearte.github.io/accurest-maven-plugin/[spring-cloud-contract-verifier-maven-plugin]
Read more: https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-verifier-maven-plugin/[spring-cloud-contract-verifier-maven-plugin]
===== Add stubs
@@ -243,7 +243,7 @@ Underneath LoanApplication makes a call to FraudDetection service. This request
</plugin>
----
Read more: http://codearte.github.io/accurest-maven-plugin/[spring-cloud-contract-verifier-maven-plugin]
Read more: https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-verifier-maven-plugin/[spring-cloud-contract-verifier-maven-plugin]
==== Add stubs
@@ -300,7 +300,7 @@ To change default configuration just add `configuration` section to plugin defin
- **contractsDir** - directory containing contracts written using the GroovyDSL. By default `/src/test/resources/contracts`.
- **testFramework** - the target test framework to be used; currently Spock and JUnit are supported with Spock being the default framework
For complete information take a look at http://codearte.github.io/accurest-maven-plugin/plugin-info.html[Plugin Documentation]
For complete information take a look at https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-verifier-maven-plugin/plugin-info.html[Plugin Documentation]
===== Base class for tests

View File

@@ -37,7 +37,7 @@ include::{core_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resou
==== Maven
Example of Maven can be found in the https://github.com/Codearte/accurest-maven-plugin/=publishing-wiremock-stubs-projectf-stubsjar[Spring Cloud Contract Verifier Maven Plugin README]
Example of Maven can be found in the https://github.com/spring-cloud/spring-cloud-contract/[Spring Cloud Contract Verifier README]
=== Modules

View File

@@ -24,8 +24,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<!--<dependency.locations.enabled>false</dependency.locations.enabled>-->
<mpir.skip>true</mpir.skip>
<dependency.locations.enabled>false</dependency.locations.enabled>
<spring.cloud.contract.verifier.version>1.0.0.BUILD-SNAPSHOT</spring.cloud.contract.verifier.version>
<aether.version>1.1.0</aether.version>
@@ -206,6 +205,22 @@
</dependency>
</dependencies>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
<configuration>
<content>${project.reporting.outputDirectory}</content>
</configuration>
<executions>
<execution>
<id>scm-publish</id>
<phase>site-deploy</phase>
<goals>
<goal>publish-scm</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

View File

@@ -1,2 +1,2 @@
#!/bin/sh
mvn clean site site:stage scm-publish:publish-scm -DskipTests -pl spring-cloud-contract-verifier-maven-plugin
mvn clean site site:stage scm-publish:publish-scm -DskipTests