From 2a25b01f99e4dcb5d988c4855acb82954245e837 Mon Sep 17 00:00:00 2001
From: Marcin Grzejszczak <marcin@grzejszczak.pl>
Date: Mon, 22 Jul 2019 15:11:36 +0200
Subject: [PATCH] Added readme

---
 README.adoc | 28 ++++++++++++++++++----------
 1 file changed, 18 insertions(+), 10 deletions(-)

diff --git a/README.adoc b/README.adoc
index 070625ee..287c11b1 100644
--- a/README.adoc
+++ b/README.adoc
@@ -179,6 +179,7 @@ $ touch .springformat
 ==== Intellij IDEA
 
 In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
+The following files can be found in the https://github.com/spring-cloud/spring-cloud-build/tree/master/spring-cloud-build-tools[Spring Cloud Build] project.
 
 .spring-cloud-build-tools/
 ----
@@ -240,30 +241,35 @@ approach of generating documentation just add these plugins to your `docs` modul
 			<build>
 				<plugins>
 					<plugin>
-						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-dependency-plugin</artifactId> <1>
+						<groupId>pl.project13.maven</groupId>
+						<artifactId>git-commit-id-plugin</artifactId> <1>
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-resources-plugin</artifactId> <2>
+						<artifactId>maven-dependency-plugin</artifactId> <2>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-resources-plugin</artifactId> <3>
 					</plugin>
 					<plugin>
 						<groupId>org.asciidoctor</groupId>
-						<artifactId>asciidoctor-maven-plugin</artifactId> <3>
+						<artifactId>asciidoctor-maven-plugin</artifactId> <4>
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-antrun-plugin</artifactId> <4>
+						<artifactId>maven-antrun-plugin</artifactId> <5>
 					</plugin>
 				</plugins>
 			</build>
 		</profile>
 	</profiles>
 ----
-<1> This plugin downloads the resources of the `spring-cloud-build-docs` module
-<2> This plugin unpacks the resources of the `spring-cloud-build-docs` module
-<3> This plugin is required to parse the Asciidoctor documentation
-<4> This plugin is required to copy resources into proper final destinations and to generate main README.adoc and to assert that no files use unresolved links
+<2> This plugin downloads sets up all the git information of the project
+<2> This plugin downloads the resources of the `spring-cloud-build-docs` module
+<3> This plugin unpacks the resources of the `spring-cloud-build-docs` module
+<4> This plugin is required to parse the Asciidoctor documentation
+<5> This plugin is required to copy resources into proper final destinations and to generate main README.adoc and to assert that no files use unresolved links
 
 IMPORTANT: The order of plugin declaration is important!
 
@@ -294,4 +300,6 @@ $ ./mvnw clean deploy -Pguides
 
 what will happen is that for GA project versions, we will clone `gs-guide1`, `gs-guide2` and `gs-guide3` and update their contents with the ones being under your `guides` project.
 
-You can skip this by either not adding the `guides` profile, or passing the `-DskipGuides` system property when the profile is turned on.
\ No newline at end of file
+You can skip this by either not adding the `guides` profile, or passing the `-DskipGuides` system property when the profile is turned on.
+
+You can configure the project version passed to guides via the `guides-project.version` (defaults to `${project.version}`). The phase at which guides get updated can be configured by `guides-update.phase` (defaults to `deploy`).
\ No newline at end of file