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

ricklarsen · Apr 26, 2019 · bae86ec · bae86ec
1 parent a78d3c2
commit bae86ec
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 31 deletions.
diff --git a/distribution/docs/pom.xml b/distribution/docs/pom.xml
@@ -144,7 +144,7 @@
                             <goal>copy-resources</goal>
                         </goals>
                         <configuration>
-                            <outputDirectory>${project.build.directory}/doc-contents-${project.version}
+                            <outputDirectory>${project.build.directory}/build-${project.version}/filtered-adoc
                             </outputDirectory>
                             <resources>
                                 <resource>
@@ -167,20 +167,20 @@
                         </configuration>
                     </execution>
                     <execution>
-                        <id>copy-upstream</id>
+                        <id>copy-scripts</id>
                         <phase>process-sources</phase>
                         <goals>
                             <goal>copy-resources</goal>
                         </goals>
                         <configuration>
-                            <outputDirectory>${project.build.directory}/doc-contents-${project.version}/content</outputDirectory>
-                            <resources>                                
+                            <outputDirectory>${project.build.directory}/asciidoctor-ready-${project.version}/</outputDirectory>
+                            <resources>
                                 <resource>
-                                    <directory>${project.build.directory}/upstream-adoc</directory>
+                                    <directory>src/main/resources/content</directory>
                                     <filtering>true</filtering>
                                     <includes>
-                                        <include>**/*.adoc</include>
-                                        <include>**/*.html</include>
+                                        <include>scripts.html</include>
+                                        <include>config.adoc</include>
                                     </includes>
                                 </resource>
                             </resources>
@@ -218,7 +218,7 @@
                     </execution>
                 </executions>
                 <configuration>
-                    <inputDirectory>${project.build.directory}/doc-contents-${project.version}</inputDirectory>
+                    <inputDirectory>${project.build.directory}/build-${project.version}/filtered-adoc</inputDirectory>
                     <outputDirectory>${project.build.directory}/asciidoctor-ready-${project.version}</outputDirectory>
                 </configuration>
                 <dependencies>
@@ -383,7 +383,7 @@
                         <configuration>
                             <rules>
                                 <ArtifactSizeEnforcerRule
-                                    implementation="org.codice.maven.artifactsize.ArtifactSizeEnforcerRule">
+                                        implementation="org.codice.maven.artifactsize.ArtifactSizeEnforcerRule">
                                     <maxArtifactSize>2.16_MB</maxArtifactSize>
                                 </ArtifactSizeEnforcerRule>
                             </rules>

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-${project.version}/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-${project.version}/content/conf
 
 <#include "build/developing.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]
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: Developer's Guide
-include::${project.build.directory}/doc-contents-${project.version}/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-${project.version}/content/conf
 
 <#include "build/development-guidelines.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/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-${project.version}/content/config.adoc[]
+include::config.adoc[]
 :architecture-prefix: _
 :developing-prefix: _
 :integrating-prefix: _
@@ -51,10 +51,15 @@ include::${project.build.directory}/doc-contents-${project.version}/content/conf
 == Appendices
 :sectnums:
 
+[appendix]
+== Application References
+
 <#include "build/application-reference.ftl">
 
+[appendix]
 <#include "build/reference.ftl">
 
+[appendix]
 <#include "build/metadata-reference.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/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,9 +1,9 @@
 = Integrating ${branding}
-include::${project.build.directory}/doc-contents-${project.version}/content/config.adoc[]
+include::config.adoc[]
 :title: Integrating ${branding}
 :architecture-prefix: architecture.adoc#_
 :developing-prefix: developing.adoc#_
-:integrating-prefix: integrating.adoc#_
+:integrating-prefix: _
 :introduction-prefix: introduction.adoc#_
 :managing-prefix: managing.adoc#_
 :metadata-prefix: metadata.adoc#_
@@ -13,4 +13,4 @@ include::${project.build.directory}/doc-contents-${project.version}/content/conf
 
 <#include "build/integrating.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/content/scripts.html[]
+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-${project.version}/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-${project.version}/content/conf
 
 <#include "build/managing.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/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-${project.version}/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-${project.version}/content/conf
 
 <#include "build/metadata-reference.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/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-${project.version}/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-${project.version}/content/conf
 
 <#include "build/introduction.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/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,8 +1,8 @@
 = ${branding-expanded}: Quick Start Guide
-include::${project.build.directory}/doc-contents-${project.version}/content/config.adoc[]
+include::config.adoc[]
 :title: ${branding-expanded} Quick Start Guide
 :architecture-prefix: architecture.adoc#_
-:developing-prefix: documentation.adoc#_
+:developing-prefix: developing.adoc#_
 :integrating-prefix: documentation.adoc#_
 :introduction-prefix: introduction.adoc#_
 :managing-prefix: managing.adoc#_
@@ -13,4 +13,4 @@ include::${project.build.directory}/doc-contents-${project.version}/content/conf
 
 <#include "build/quickstart.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/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-${project.version}/content/config.adoc[]
+include::config.adoc[]
 :title: Reference
 :toc: left
 :architecture-prefix: architecture.adoc#_
@@ -16,4 +16,4 @@ include::${project.build.directory}/doc-contents-${project.version}/content/conf
 
 <#include "build/reference.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/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-${project.version}/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-${project.version}/content/conf
 
 <#include "build/using.ftl">
 
-include::${project.build.directory}/doc-contents-${project.version}/content/scripts.html[]
+include::${project.build.directory}/asciidoctor-ready-${project.version}/scripts.html[]