SpringCloud/spring-cloud-build
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
buildmaster
2019-09-06 11:16:42 +00:00
parent ee47aaa658
commit 3fa8fb8c1f
3 changed files with 63 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
reference/html/spring-cloud-build.html
View File

@@ -505,13 +505,17 @@ approach of generating documentation just add these plugins to your <code>docs</
&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
&lt;artifactId&gt;maven-resources-plugin&lt;/artifactId&gt; <i class="conum" data-value="3"></i><b>(3)</b>
&lt;/plugin&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.codehaus.mojo&lt;/groupId&gt;
&lt;artifactId&gt;exec-maven-plugin&lt;/artifactId&gt; <i class="conum" data-value="4"></i><b>(4)</b>
&lt;/plugin&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.asciidoctor&lt;/groupId&gt;
&lt;artifactId&gt;asciidoctor-maven-plugin&lt;/artifactId&gt; <i class="conum" data-value="4"></i><b>(4)</b>
&lt;artifactId&gt;asciidoctor-maven-plugin&lt;/artifactId&gt; <i class="conum" data-value="5"></i><b>(5)</b>
&lt;/plugin&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
&lt;artifactId&gt;maven-antrun-plugin&lt;/artifactId&gt; <i class="conum" data-value="5"></i><b>(5)</b>
&lt;artifactId&gt;maven-antrun-plugin&lt;/artifactId&gt; <i class="conum" data-value="6"></i><b>(6)</b>
&lt;/plugin&gt;
&lt;/plugins&gt;
&lt;/build&gt;
@@ -535,10 +539,14 @@ approach of generating documentation just add these plugins to your <code>docs</
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
<td>This plugin is required to parse the Asciidoctor documentation</td>
<td>This plugin generates an <code>adoc</code> file with all the configuration properties from the classpath</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
<td>This plugin is required to parse the Asciidoctor documentation</td>
</tr>
<tr>
<td><i class="conum" data-value="6"></i><b>6</b></td>
<td>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</td>
</tr>
</table>
@@ -556,6 +564,9 @@ The order of plugin declaration is important!
</table>
</div>
<div class="paragraph">
<p>In order for the build to generate the <code>adoc</code> file with all your configuration properties, your <code>docs</code> module should contain all the dependencies on the classpath, that you would want to scan for configuration properties. The file will be output to <code>${docsModule}/src/main/asciidoc/configprops.adoc</code> file.</p>
</div>
<div class="paragraph">
<p>Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse.</p>
</div>
<div class="listingblock">
@@ -575,11 +586,15 @@ The order of plugin declaration is important!
&lt;project-root&gt;${maven.multiModuleProjectDirectory}&lt;/project-root&gt;
&lt;!-- It's mandatory for you to pass the docs.main property --&gt;
&lt;github-repo&gt;${docs.main}&lt;/github-repo&gt;
&lt;github-raw&gt;https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}&lt;/github-raw&gt;
&lt;github-code&gt;https://github.com/spring-cloud/${docs.main}/tree/${github-tag}&lt;/github-code&gt;
&lt;github-raw&gt;
https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}
&lt;/github-raw&gt;
&lt;github-code&gt;https://github.com/spring-cloud/${docs.main}/tree/${github-tag}
&lt;/github-code&gt;
&lt;github-issues&gt;https://github.com/spring-cloud/${docs.main}/issues/&lt;/github-issues&gt;
&lt;github-wiki&gt;https://github.com/spring-cloud/${docs.main}/wiki&lt;/github-wiki&gt;
&lt;github-master-code&gt;https://github.com/spring-cloud/${docs.main}/tree/master&lt;/github-master-code&gt;
&lt;github-master-code&gt;https://github.com/spring-cloud/${docs.main}/tree/master
&lt;/github-master-code&gt;
&lt;index-link&gt;${index-link}&lt;/index-link&gt;
&lt;!-- Spring Cloud specific --&gt;