ARTEMIS-3804: make the version number available to reference in the user manual, add it to the intro page

Updates release instructions to note using the filtered scratch area from artemis-website for other builds

RELEASING.md

@@ -321,11 +321,11 @@ Once the mirrors are up-to-date then update the following:
 4. Copy `src/components/artemis/documentation/latest` to `src/components/artemis/documentation/<old-version>`.
 5. Create `src/components/artemis/documentation/latest` and copy these files into it:
     1. the contents of user-manual from `apache-artemis-<new-version>/web/user-manual`
-    2. book.pdf version of user-manual (generated from the new version sources with the command `gitbook pdf`)
+    2. book.pdf version of user-manual (generated from the new-version sources at `artemis-website/target/scratch/user-manual/` with the command `gitbook pdf`)
-    3. book.epub version of user-manual (generated from the new version sources with the command `gitbook epub`)
+    3. book.epub version of user-manual (generated from the new-version sources at `artemis-website/target/scratch/user-manual/` with the command `gitbook epub`)
-    4. book.mobi version of user-manual (generated from the new version sources with the command `gitbook mobi`)
+    4. book.mobi version of user-manual (generated from the new-version sources at `artemis-website/target/scratch/user-manual/` with the command `gitbook mobi`)
 6. Create `src/components/artemis/documentation/hacking-guide` and copy these files into it: 
-    1. the contents of user-manual from `apache-artemis-<new-version>/web/hacking-guide`
+    1. the contents of hacking-guide from `apache-artemis-<new-version>/web/hacking-guide`
     2. book.pdf version of hacking-guide (generated with `gitbook pdf`)
 7. Copy `src/components/artemis/documentation/javadocs/javadoc-latest` to `src/components/artemis/documentation/javadocs/javadoc-<old-version>`.
 8. Create `src/components/artemis/documentation/javadocs/javadoc-latest` and copy the contents of `apache-artemis-<new-version>/web/api` into it.

artemis-website/pom.xml

@@ -82,6 +82,8 @@
    <properties>
       <activemq.basedir>${project.basedir}/..</activemq.basedir>
       <webapp-dir>${project.artifactId}-${project.version}</webapp-dir>
+      <src-dir-user-manual>${basedir}/../docs/user-manual/en</src-dir-user-manual>
+      <scratch-dir-user-manual>${basedir}/target/scratch/user-manual</scratch-dir-user-manual>
       <webapp-outdir-user-manual>${basedir}/target/classes/user-manual</webapp-outdir-user-manual>
       <webapp-outdir-hacking-guide>${basedir}/target/classes/hacking-guide</webapp-outdir-hacking-guide>
       <webapp-outdir-migration-guide>${basedir}/target/classes/migration-guide</webapp-outdir-migration-guide>
@@ -179,6 +181,17 @@
                         <configuration>
                            <skip>${skipWebsiteDocGeneration}</skip>
                            <target>
+                              <!-- Make scratch copy of user manual, filter the version config -->
+                              <copy todir="${scratch-dir-user-manual}">
+                                 <fileset dir="${src-dir-user-manual}"/>
+                              </copy>
+                              <copy todir="${scratch-dir-user-manual}" overwrite="true">
+                                 <fileset file="${src-dir-user-manual}/book.json"/>
+                                 <filterset>
+                                    <filter token="PROJECT_VERSION_FILTER_TOKEN" value="${project.version}"/>
+                                 </filterset>
+                              </copy>
+
                               <condition property="honkit.cmd" value="${basedir}/node_modules/.bin/honkit.cmd" else="${basedir}/node_modules/.bin/honkit">
                                  <os family="windows" />
                               </condition>
@@ -188,7 +201,7 @@
                               <exec executable="${honkit.cmd}" failonerror="true">
                                  <env key="PATH" path="${basedir}/node" />
                                  <arg value="build" />
-                                 <arg value="${basedir}/../docs/user-manual/en" />
+                                 <arg value="${scratch-dir-user-manual}" />
                                  <arg value="${webapp-outdir-user-manual}" />
                               </exec>
                               <mkdir dir="${webapp-outdir-hacking-guide}" />

docs/user-manual/en/README.md

@@ -1,5 +1,5 @@
 <!-- using HTML directly here since this formatting isn't available in Markdown -->
 <img style="margin: auto; display: block" src="images/activemq-logo.png"></img>
-<H1 style="text-align: center">Apache ActiveMQ Artemis User Manual</H1>
+<H1 style="text-align: center">Apache ActiveMQ Artemis {{ config.version }} User Manual</H1>
 <div style="text-align: center">An in-depth manual on all aspects of Apache ActiveMQ Artemis</div>
 

docs/user-manual/en/book.json

@@ -8,5 +8,6 @@
         "home": "http://activemq.apache.org/artemis",
         "issues": "https://issues.apache.org/jira/browse/ARTEMIS",
         "contribute": "http://activemq.apache.org/contributing.html"
-    }
+    },
+    "version": "@PROJECT_VERSION_FILTER_TOKEN@"
 }