DDF-4703 updated docs module to add version checking (#4707)

codice · Apr 26, 2019 · dd7f54c · dd7f54c
1 parent 3877235
commit dd7f54c
Show file tree

Hide file tree

Showing 12 changed files with 47 additions and 28 deletions.
diff --git a/distribution/docs/pom.xml b/distribution/docs/pom.xml
@@ -153,7 +153,7 @@
                                     <classifier>adoc-files</classifier>
                                     <version>${project.version}</version>
                                     <type>zip</type>
-                                    <outputDirectory>${project.build.directory}/upstream-adoc/ui-help</outputDirectory>
+                                    <outputDirectory>${project.build.directory}/pre-build-${project.version}/upstream-adoc-${project.version}/ui-help</outputDirectory>
                                 </artifactItem>
                                 <artifactItem>
                                     <groupId>ddf.ui.search</groupId>
@@ -179,7 +179,7 @@
                             <goal>copy-resources</goal>
                         </goals>
                         <configuration>
-                            <outputDirectory>${project.build.directory}/doc-contents
+                            <outputDirectory>${project.build.directory}/build-${project.version}/filtered-adoc
                             </outputDirectory>
                             <resources>
                                 <resource>
@@ -208,10 +208,10 @@
                             <goal>copy-resources</goal>
                         </goals>
                         <configuration>
-                            <outputDirectory>${project.build.directory}/doc-contents/content</outputDirectory>
+                            <outputDirectory>${project.build.directory}/build-${project.version}/filtered-adoc/content</outputDirectory>
                             <resources>                                
                                 <resource>
-                                    <directory>${project.build.directory}/upstream-adoc</directory>
+                                    <directory>${project.build.directory}/pre-build-${project.version}/upstream-adoc-${project.version}</directory>
                                     <filtering>true</filtering>
                                     <includes>
                                         <include>**/*.adoc</include>
@@ -221,6 +221,26 @@
                             </resources>
                         </configuration>
                     </execution>
+                    <execution>
+                        <id>copy-scripts</id>
+                        <phase>process-sources</phase>
+                        <goals>
+                            <goal>copy-resources</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>${project.build.directory}/asciidoctor-ready-${project.version}/</outputDirectory>
+                            <resources>
+                                <resource>
+                                    <directory>${project.build.directory}/build-${project.version}/filtered-adoc/content</directory>
+                                    <filtering>true</filtering>
+                                    <includes>
+                                        <include>scripts.html</include>
+                                        <include>config.adoc</include>
+                                    </includes>
+                                </resource>
+                            </resources>
+                        </configuration>
+                    </execution>
                     <execution>
                         <id>copy-images</id>
                         <phase>process-sources</phase>
@@ -260,8 +280,8 @@
                     </execution>
                 </executions>
                 <configuration>
-                    <inputDirectory>${project.build.directory}/doc-contents</inputDirectory>
-                    <outputDirectory>${project.build.directory}/asciidoctor-ready</outputDirectory>
+                    <inputDirectory>${project.build.directory}/build-${project.version}/filtered-adoc</inputDirectory>
+                    <outputDirectory>${project.build.directory}/asciidoctor-ready-${project.version}</outputDirectory>
                 </configuration>
                 <dependencies>
                     <dependency>
@@ -328,7 +348,7 @@
                     </execution>
                 </executions>
                 <configuration>
-                    <sourceDirectory>${project.build.directory}/asciidoctor-ready
+                    <sourceDirectory>${project.build.directory}/asciidoctor-ready-${project.version}
                     </sourceDirectory>
                     <gemPath>${project.build.directory}/gems-provided</gemPath>
                     <headerFooter>true</headerFooter>

diff --git a/distribution/docs/src/main/resources/templates/architectures.ftl b/distribution/docs/src/main/resources/templates/architectures.ftl
@@ -1,5 +1,5 @@
 = ${branding-expanded} Architecture
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: ${branding-expanded} Architecture
 :architecture-prefix: _
 :developing-prefix: developing.adoc#_
@@ -13,4 +13,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/developing.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/build/integrating.ftl b/distribution/docs/src/main/resources/templates/build/integrating.ftl
@@ -11,6 +11,4 @@ include::${ii.file}[]
 
 <#include "eventing.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
-
 <#include "security-services.ftl">
diff --git a/distribution/docs/src/main/resources/templates/developing.ftl b/distribution/docs/src/main/resources/templates/developing.ftl
@@ -1,5 +1,5 @@
 = Developing ${branding} Components
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: Developing ${branding} Components
 :architecture-prefix: architecture.adoc#_
 :developing-prefix: _
@@ -15,4 +15,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/development-guidelines.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/documentation.ftl b/distribution/docs/src/main/resources/templates/documentation.ftl
@@ -1,5 +1,5 @@
 = ${branding-expanded} Documentation: Complete Documentation
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :architecture-prefix: _
 :developing-prefix: _
 :integrating-prefix: _
@@ -62,4 +62,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 [appendix]
 <#include "build/metadata-reference.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/integrating.ftl b/distribution/docs/src/main/resources/templates/integrating.ftl
@@ -1,5 +1,5 @@
 = Integrating ${branding}
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: Integrating ${branding}
 :architecture-prefix: architecture.adoc#_
 :developing-prefix: developing.adoc#_
@@ -13,3 +13,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/integrating.ftl">
 
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/managing.ftl b/distribution/docs/src/main/resources/templates/managing.ftl
@@ -1,5 +1,5 @@
 = Managing
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: Managing ${branding}
 :architecture-prefix: architecture.adoc#_
 :developing-prefix: developing.adoc#_
@@ -13,4 +13,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/managing.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/metadata.ftl b/distribution/docs/src/main/resources/templates/metadata.ftl
@@ -1,5 +1,5 @@
 = ${branding} Metadata Reference Guide
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: Metadata Reference Guide
 :toc: left
 :architecture-prefix: architecture.adoc#_
@@ -14,4 +14,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/metadata-reference.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/overview.ftl b/distribution/docs/src/main/resources/templates/overview.ftl
@@ -1,5 +1,5 @@
 = ${branding-expanded} Overview
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: ${branding-expanded} Executive Summary: Core Concepts and Introduction
 :architecture-prefix: architecture.adoc#_
 :developing-prefix: developing.adoc#_
@@ -13,4 +13,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/introduction.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/quickstart.ftl b/distribution/docs/src/main/resources/templates/quickstart.ftl
@@ -1,5 +1,5 @@
 = ${branding-expanded}: Quick Start Guide
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: ${branding-expanded} Quick Start Guide
 :architecture-prefix: architecture.adoc#_
 :developing-prefix: developing.adoc#_
@@ -13,4 +13,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/quickstart.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/reference.ftl b/distribution/docs/src/main/resources/templates/reference.ftl
@@ -1,5 +1,5 @@
 = ${branding} Reference Guide
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: Reference
 :toc: left
 :architecture-prefix: architecture.adoc#_
@@ -16,4 +16,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/reference.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
diff --git a/distribution/docs/src/main/resources/templates/using.ftl b/distribution/docs/src/main/resources/templates/using.ftl
@@ -1,5 +1,5 @@
 = ${branding} User's Guide
-include::${project.build.directory}/doc-contents/content/config.adoc[]
+include::config.adoc[]
 :title: Using ${branding-expanded}
 :architecture-prefix: architecture.adoc#_
 :developing-prefix: developing.adoc#_
@@ -15,4 +15,4 @@ include::${project.build.directory}/doc-contents/content/config.adoc[]
 
 <#include "build/using.ftl">
 
-include::${project.build.directory}/doc-contents/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]