From 8215171d54a447078641dea513bb012bdd4906d5 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Thu, 7 Mar 2019 15:30:41 +0100 Subject: [PATCH] Updated readme --- README.adoc | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.adoc b/README.adoc index eeda37f4..332d0f49 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,8 @@ -// Do not edit this file (e.g. go instead to src/main/asciidoc) +//// +DO NOT EDIT THIS FILE. IT WAS GENERATED. +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-build.svg?style=svg[link="https://travis-ci.org/spring-cloud/spring-cloud-build"] @@ -239,22 +243,26 @@ approach of generating documentation just add these plugins to your `docs` modul org.apache.maven.plugins maven-dependency-plugin <1> + + org.apache.maven.plugins + maven-resources-plugin <2> + org.asciidoctor - asciidoctor-maven-plugin <2> + asciidoctor-maven-plugin <3> org.apache.maven.plugins - maven-antrun-plugin <3> - false + maven-antrun-plugin <4> ---- -<1> This plugin downloads and unpacks the resources of the `spring-cloud-build-docs` module -<2> This plugin is required to parse the Asciidoctor documentation -<3> This plugin is required to copy resources into proper final destinations and to generate main README.adoc +<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 IMPORTANT: The order of plugin declaration is important! \ No newline at end of file