Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[2.13.x] DDF-4703 updated docs module to add version checking #4707

Merged
merged 1 commit into from
Apr 26, 2019
Merged

[2.13.x] DDF-4703 updated docs module to add version checking #4707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 27 additions & 7 deletions distribution/docs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/architectures.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]
2 changes: 0 additions & 2 deletions distribution/docs/src/main/resources/templates/build/integrating.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,4 @@ include::${ii.file}[]

<#include "eventing.ftl">

include::${project.build.directory}/doc-contents/content/scripts.html[]

<#include "security-services.ftl">
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/developing.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: _
Expand All @@ -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[]
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/documentation.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: _
Expand Down Expand Up @@ -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[]
3 changes: 2 additions & 1 deletion distribution/docs/src/main/resources/templates/integrating.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/managing.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/metadata.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/overview.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/quickstart.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/reference.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]
4 changes: 2 additions & 2 deletions distribution/docs/src/main/resources/templates/using.ftl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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#_
Expand All @@ -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[]