WIP

docs/pom.xml

@@ -35,6 +35,10 @@
 			<id>docs</id>
 			<build>
 				<plugins>
+					<plugin>
+						<groupId>pl.project13.maven</groupId>
+						<artifactId>git-commit-id-plugin</artifactId>
+					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-dependency-plugin</artifactId>

docs/src/main/asciidoc/_attributes.adoc

@@ -0,0 +1,15 @@
+:doctype: book
+:idprefix:
+:idseparator: -
+:toc: left
+:toclevels: 4
+:tabsize: 4
+:numbered:
+:sectanchors:
+:sectnums:
+:icons: font
+:hide-uri-scheme:
+:docinfo: shared,private
+
+:sc-ext: java
+:project-full-name: Spring Cloud Contract

docs/src/main/asciidoc/attributes.adoc

@@ -1,25 +0,0 @@
-:doctype: book
-:idprefix:
-:idseparator: -
-:toc: left
-:toclevels: 4
-:tabsize: 4
-:numbered:
-:sectanchors:
-:sectnums:
-:icons: font
-:hide-uri-scheme:
-:docinfo: shared,private
-
-:spring-cloud-contract-repo: snapshot
-:github-tag: master
-:spring-cloud-contract-docs-version: current
-:spring-cloud-contract-docs: https://docs.spring.io/spring-cloud-contract/docs/{spring-cloud-contract-docs-version}/reference
-:spring-cloud-contract-docs-current: https://docs.spring.io/spring-cloud-contract/docs/current/reference
-:github-repo: spring-cloud/spring-cloud-contract
-:github-raw: https://raw.github.com/{github-repo}/{github-tag}
-:github-code: https://github.com/{github-repo}/tree/{github-tag}
-:github-issues: https://github.com/{github-repo}/issues/
-:github-wiki: https://github.com/{github-repo}/wiki
-:github-master-code: https://github.com/{github-repo}/tree/master
-:sc-ext: java

docs/src/main/asciidoc/documentation-overview.adoc

@@ -1,21 +1,19 @@
-[[contract-documentation]]
+[[documentation]]
 = Spring Cloud Contract Documentation
-include::attributes.adoc[]
+include::_attributes.adoc[]
 
-This section provides a brief overview of Spring Cloud Contract reference documentation. It serves
+This section provides a brief overview of {project-full-name} reference documentation. It serves
 as a map for the rest of the document.
 
 
 
 [[contract-documentation-about]]
 == About the Documentation
-The Spring Cloud Contract reference guide is available as
+The {project-full-name} reference guide is available as
 
-* {spring-cloud-contract-docs}/html[Multi-page HTML]
-* {spring-cloud-contract-docs}/htmlsingle[Single page HTML]
-* {spring-cloud-contract-docs}/pdf/spring-cloud-contract-reference.pdf[PDF]
-
-The latest copy is available at {spring-cloud-contract-docs-current}.
+* {docs-url}/html[Multi-page HTML]
+* {docs-url}/htmlsingle[Single page HTML]
+* {docs-url}/pdf/{project-name}.pdf[PDF]
 
 Copies of this document may be made for your own use and for distribution to others,
 provided that you do not charge any fee for such copies and further provided that each
@@ -23,19 +21,19 @@ copy contains this Copyright Notice, whether distributed in print or electronica
 
 
 
-[[contract-documentation-getting-help]]
+[[documentation-getting-help]]
 == Getting Help
-If you have trouble with Spring Cloud Contract, we would like to help.
+If you have trouble with {project-full-name}, we would like to help.
 
 * Try the <<howto.adoc#howto, How-to documents>>. They provide solutions to the most
 common questions.
-* Learn the Spring Cloud Contract basics. If you are
-starting out with Spring Cloud Contract, try one of the https://spring.io/guides[guides].
+* Learn the {project-full-name} basics. If you are
+starting out with {project-full-name}, try one of the https://spring.io/guides[guides].
 * Ask a question. We monitor https://stackoverflow.com[stackoverflow.com] for questions
-tagged with https://stackoverflow.com/tags/spring-cloud-contract[`spring-cloud-contract`].
-* Report bugs with Spring Cloud Contract at https://github.com/spring-cloud/spring-cloud-contract/issues.
+tagged with https://stackoverflow.com/tags/{project-name}[`{project-name}`].
+* Report bugs with {project-full-name} at https://github.com/spring-cloud/{project-name}/issues.
 
-NOTE: All of Spring Cloud Contract is open source, including the documentation. If you find
+NOTE: All of {project-full-name} is open source, including the documentation. If you find
 problems with the docs or if you want to improve them, please {github-code}[get
 involved].
 
@@ -43,13 +41,13 @@ involved].
 
 [[contract-documentation-first-steps]]
 == First Steps
-If you are getting started with Spring Cloud Contract or 'Spring' in general, start with
+If you are getting started with {project-full-name} or 'Spring' in general, start with
 <<getting-started.adoc#getting-started, the following topics>>:
 
 * *From scratch:*
-<<getting-started.adoc#getting-started-introducing-spring-cloud-contract, Overview>> |
+<<getting-started.adoc#getting-started-introducing-{project-name}, Overview>> |
 <<getting-started.adoc#getting-started-system-requirements, Requirements>> |
-<<getting-started.adoc#getting-started-installing-spring-cloud-contract, Installation>>
+<<getting-started.adoc#getting-started-installing-{project-name}, Installation>>
 * *Tutorial:*
 <<getting-started.adoc#getting-started-first-application, Part 1>> |
 <<getting-started.adoc#getting-started-first-application-code, Part 2>>
@@ -59,64 +57,64 @@ If you are getting started with Spring Cloud Contract or 'Spring' in general, st
 
 
 
-== Working with Spring Cloud Contract
-Ready to actually start using Spring Cloud Contract? <<using-spring-cloud-contract.adoc#using-boot, We have
+== Working with {project-full-name}
+Ready to actually start using {project-full-name}? <<using.adoc#using, We have
 you covered>>:
 
 * *Build systems:*
-<<using-spring-cloud-contract.adoc#using-contract-maven, Maven>> |
-<<using-spring-cloud-contract.adoc#using-contract-gradle, Gradle>> |
-<<using-spring-cloud-contract.adoc#using-contract-ant, Ant>> |
-<<using-spring-cloud-contract.adoc#using-contract-starter, Starters>>
+<<using-{project-name}.adoc#using-contract-maven, Maven>> |
+<<using-{project-name}.adoc#using-contract-gradle, Gradle>> |
+<<using-{project-name}.adoc#using-contract-ant, Ant>> |
+<<using-{project-name}.adoc#using-contract-starter, Starters>>
 * *Best practices:*
-<<using-spring-cloud-contract.adoc#using-contract-structuring-your-code, Code Structure>> |
-<<using-spring-cloud-contract.adoc#using-contract-configuration-classes, @Configuration>> |
-<<using-spring-cloud-contract.adoc#using-contract-auto-configuration, @EnableAutoConfiguration>> |
-<<using-spring-cloud-contract.adoc#using-contract-spring-beans-and-dependency-injection, Beans and
+<<using-{project-name}.adoc#using-contract-structuring-your-code, Code Structure>> |
+<<using-{project-name}.adoc#using-contract-configuration-classes, @Configuration>> |
+<<using-{project-name}.adoc#using-contract-auto-configuration, @EnableAutoConfiguration>> |
+<<using-{project-name}.adoc#using-contract-spring-beans-and-dependency-injection, Beans and
 Dependency Injection>>
 * *Running your code:*
-<<using-spring-cloud-contract.adoc#using-contract-running-from-an-ide, IDE>> |
-<<using-spring-cloud-contract.adoc#using-contract-running-as-a-packaged-application, Packaged>> |
-<<using-spring-cloud-contract.adoc#using-contract-running-with-the-maven-plugin, Maven>> |
-<<using-spring-cloud-contract.adoc#using-contract-running-with-the-gradle-plugin, Gradle>>
+<<using-{project-name}.adoc#using-contract-running-from-an-ide, IDE>> |
+<<using-{project-name}.adoc#using-contract-running-as-a-packaged-application, Packaged>> |
+<<using-{project-name}.adoc#using-contract-running-with-the-maven-plugin, Maven>> |
+<<using-{project-name}.adoc#using-contract-running-with-the-gradle-plugin, Gradle>>
 * *Packaging your app:*
-<<using-spring-cloud-contract.adoc#using-contract-packaging-for-production, Production jars>>
-* *Spring Cloud Contract CLI:*
-<<spring-cloud-contract-cli.adoc#cli, Using the CLI>>
+<<using-{project-name}.adoc#using-contract-packaging-for-production, Production jars>>
+* *{project-full-name} CLI:*
+<<{project-name}-cli.adoc#cli, Using the CLI>>
 
 
 
-== Learning about Spring Cloud Contract Features
-Need more details about Spring Cloud Contract's core features?
-<<spring-cloud-contract-features.adoc#contract-features, The following content is for you>>:
+== Learning about {project-full-name} Features
+Need more details about {project-full-name}'s core features?
+<<{project-name}-features.adoc#contract-features, The following content is for you>>:
 
 * *Core Features:*
-<<spring-cloud-contract-features.adoc#contract-features-spring-application, SpringApplication>> |
-<<spring-cloud-contract-features.adoc#contract-features-external-config, External Configuration>> |
-<<spring-cloud-contract-features.adoc#contract-features-profiles, Profiles>> |
-<<spring-cloud-contract-features.adoc#contract-features-logging, Logging>>
+<<{project-name}-features.adoc#contract-features-spring-application, SpringApplication>> |
+<<{project-name}-features.adoc#contract-features-external-config, External Configuration>> |
+<<{project-name}-features.adoc#contract-features-profiles, Profiles>> |
+<<{project-name}-features.adoc#contract-features-logging, Logging>>
 * *Web Applications:*
-<<spring-cloud-contract-features.adoc#contract-features-spring-mvc, MVC>> |
-<<spring-cloud-contract-features.adoc#contract-features-embedded-container, Embedded Containers>>
+<<{project-name}-features.adoc#contract-features-spring-mvc, MVC>> |
+<<{project-name}-features.adoc#contract-features-embedded-container, Embedded Containers>>
 * *Working with data:*
-<<spring-cloud-contract-features.adoc#contract-features-sql, SQL>> |
-<<spring-cloud-contract-features.adoc#contract-features-nosql, NO-SQL>>
+<<{project-name}-features.adoc#contract-features-sql, SQL>> |
+<<{project-name}-features.adoc#contract-features-nosql, NO-SQL>>
 * *Messaging:*
-<<spring-cloud-contract-features.adoc#contract-features-messaging, Overview>> |
-<<spring-cloud-contract-features.adoc#contract-features-jms, JMS>>
+<<{project-name}-features.adoc#contract-features-messaging, Overview>> |
+<<{project-name}-features.adoc#contract-features-jms, JMS>>
 * *Testing:*
-<<spring-cloud-contract-features.adoc#contract-features-testing, Overview>> |
-<<spring-cloud-contract-features.adoc#contract-features-testing-spring-cloud-contract-applications, Boot
+<<{project-name}-features.adoc#contract-features-testing, Overview>> |
+<<{project-name}-features.adoc#contract-features-testing-{project-name}-applications, Boot
 Applications>> |
-<<spring-cloud-contract-features.adoc#contract-features-test-utilities, Utils>>
+<<{project-name}-features.adoc#contract-features-test-utilities, Utils>>
 * *Extending:*
-<<spring-cloud-contract-features.adoc#contract-features-developing-auto-configuration, Auto-configuration>> |
-<<spring-cloud-contract-features.adoc#contract-features-condition-annotations, @Conditions>>
+<<{project-name}-features.adoc#contract-features-developing-auto-configuration, Auto-configuration>> |
+<<{project-name}-features.adoc#contract-features-condition-annotations, @Conditions>>
 
 
 
 == Moving to Production
-When you are ready to push your Spring Cloud Contract application to production, we have
+When you are ready to push your {project-full-name} application to production, we have
 <<production-ready-features.adoc#production-ready, some tricks>> that you might like:
 
 * *Management endpoints:*
@@ -136,7 +134,7 @@ When you are ready to push your Spring Cloud Contract application to production,
 == Advanced Topics
 Finally, we have a few topics for more advanced users:
 
-* *Spring Cloud Contract Applications Deployment:*
+* *{project-full-name} Applications Deployment:*
 <<deployment.adoc#cloud-deployment, Cloud Deployment>> |
 <<deployment.adoc#deployment-service, OS Service>>
 * *Build tool plugins:*

docs/src/main/asciidoc/getting-started.adoc

@@ -1,6 +1,6 @@
 [[getting-started]]
 = Getting Started
-include::attributes.adoc[]
+include::_attributes.adoc[]
 
 If you are getting started with Spring Boot, or "`Spring`" in general, start by reading
 this section. It answers the basic "`what?`", "`how?`" and "`why?`" questions. It

docs/src/main/asciidoc/index.htmlpdfadoc

@@ -2,7 +2,7 @@
 = Spring Cloud Contract Reference Documentation
 Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant
 :docinfo: shared
-include::attributes.adoc[]
+include::_attributes.adoc[]
 
 include::legal.adoc[leveloffset=+1]
 include::documentation-overview.adoc[leveloffset=+1]

docs/src/main/asciidoc/index.htmlsingleadoc

@@ -2,7 +2,7 @@
 = Spring Cloud Contract Reference Documentation
 Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant
 :docinfo: shared
-include::attributes.adoc[]
+include::_attributes.adoc[]
 
 include::legal.adoc[leveloffset=+1]
 include::documentation-overview.adoc[leveloffset=+1]

docs/src/main/asciidoc/legal.adoc

@@ -1,7 +1,7 @@
 [legal]
 = Legal
 
-{spring-cloud-contract-version}
+{project-version}
 
 Copyright © 2012-2019