You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2018/01/03 14:52:10 UTC
[isis] 01/06: ISIS-1465: refactors doc site to support multiple
versions
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit b29d650062b6b715c8403ec4b86ad60b41edd509
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Jan 3 12:37:05 2018 +0000
ISIS-1465: refactors doc site to support multiple versions
---
adocs/documentation/pom.xml | 105 +++++++++--------------
adocs/documentation/src/main/asciidoc/index.html | 61 +++++++------
adocs/template/document.html.erb | 25 ++++--
3 files changed, 90 insertions(+), 101 deletions(-)
diff --git a/adocs/documentation/pom.xml b/adocs/documentation/pom.xml
index 7314db3..1c36526 100644
--- a/adocs/documentation/pom.xml
+++ b/adocs/documentation/pom.xml
@@ -52,6 +52,7 @@
<build.dir>${project.basedir}/target/site</build.dir>
+ <isis-site-latest.dir>../../../isis-site/latest</isis-site-latest.dir>
<isis-site-content.dir>../../../isis-site/content</isis-site-content.dir>
<isis-site-search.dir>../../../isis-site/search</isis-site-search.dir>
<message>updating content (built from adocs/documentation in isis.git repo)</message>
@@ -215,10 +216,17 @@
<target>
<echo message=""/>
<echo message=""/>
- <echo message="deleting everything in ${isis-site-content.dir}"/>
+ <echo message="deleting everything in ${isis-site-latest.dir}"/>
<echo message=""/>
<delete includeemptydirs="true">
- <fileset dir="${isis-site-content.dir}" includes="**/*"/>
+ <fileset dir="${isis-site-latest.dir}" includes="**/*"/>
+ </delete>
+ <echo message=""/>
+ <echo message=""/>
+ <echo message="deleting everything in ${isis-site-content.dir} (excluding 'versions' subdir)"/>
+ <echo message=""/>
+ <delete includeemptydirs="true">
+ <fileset dir="${isis-site-content.dir}" includes="**/*" excludes="versions/**"/>
</delete>
</target>
</configuration>
@@ -255,9 +263,9 @@
<echo message=""/>
<echo message=""/>
- <echo message="copying from ${build.dir} to ${isis-site-content.dir}"/>
+ <echo message="copying from ${build.dir} to ${isis-site-latest.dir}"/>
<echo message=""/>
- <copy todir="${isis-site-content.dir}" overwrite="true" force="true">
+ <copy todir="${isis-site-latest.dir}" overwrite="true" force="true">
<fileset dir="${build.dir}"/>
</copy>
@@ -267,82 +275,81 @@
<exec executable="node" dir="${isis-site-search.dir}">
<arg value="--max_old_space_size=2048"/>
<arg value="_scripts/index.js"/>
- <arg value="../content/"/>
+ <arg value="../latest/"/>
<arg value="-o"/>
- <arg value="../content/elasticlunr/index.json"/>
+ <arg value="../latest/elasticlunr/index.json"/>
<arg value="-V"/>
</exec>
<echo message=""/>
<echo message=""/>
- <echo message="converting CRLF to LF for all text files under ${isis-site-content.dir}"/>
+ <echo message="converting CRLF to LF for all text files under ${isis-site-latest.dir}"/>
<echo message="... .html files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.html"
eol="lf"
eof="remove"
fixlast="true"/>
<echo message="... .xml files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.xml"
eol="lf"
eof="remove"
fixlast="false"/>
-
<echo message="... .xsd files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.xsd"
eol="lf"
eof="remove"
fixlast="false"/>
<echo message="... .css files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.css"
eol="lf"
eof="remove"
fixlast="false"/>
<echo message="... .svg files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.svg"
eol="lf"
eof="remove"
fixlast="false"/>
<echo message="... .less files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.less"
eol="lf"
eof="remove"
fixlast="false"/>
<echo message="... .scss files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.scss"
eol="lf"
eof="remove"
fixlast="false"/>
<echo message="... .js files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.js"
eol="lf"
eof="remove"
fixlast="false"/>
<echo message="... .sh files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.sh"
eol="lf"
eof="remove"
fixlast="false"/>
<echo message="... .rdf files"/>
- <fixcrlf srcdir="${isis-site-content.dir}"
+ <fixcrlf srcdir="${isis-site-latest.dir}"
includes="**/*.rdf"
eol="lf"
eof="remove"
@@ -352,12 +359,20 @@
apply fixcrlf, so just copy over again... -->
<echo message=""/>
<echo message=""/>
- <echo message="copying over slick CSS and SCSS from ${build.dir} to ${isis-site-content.dir}"/>
+ <echo message="copying over slick CSS and SCSS from ${build.dir} to ${isis-site-latest.dir}"/>
<echo message=""/>
- <copy todir="${isis-site-content.dir}" overwrite="true" force="true">
+ <copy todir="${isis-site-latest.dir}" overwrite="true" force="true">
<fileset dir="${build.dir}" includes="**/css/slick/**/*"/>
</copy>
+ <echo message=""/>
+ <echo message=""/>
+ <echo message="copying from ${isis-site-latest.dir} to ${isis-site-content.dir}"/>
+ <echo message=""/>
+ <copy todir="${isis-site-content.dir}" overwrite="true" force="true">
+ <fileset dir="isis-site-latest.dir"/>
+ </copy>
+
</target>
</configuration>
<goals>
@@ -420,46 +435,7 @@
</activation>
<build>
<plugins>
- <plugin>
- <groupId>org.codehaus.gmaven</groupId>
- <artifactId>groovy-maven-plugin</artifactId>
- <version>2.0</version>
- <executions>
- <execution>
- <id>install</id>
- <phase>install</phase>
- <goals>
- <goal>execute</goal>
- </goals>
- <configuration>
- <source>
- def siteDir = new File("${isis-site-content.dir}", "..")
-
- "git add content --all".execute(null, siteDir).in.text
- "git reset content/guides".execute(null, siteDir).in.text
-
- def gitStatusOutput = "git status --porcelain".execute(null, siteDir).in.text
-
- def lines = gitStatusOutput.readLines()
- lines.each{ line ->
- def file=line.drop(3)
- if(file.endsWith(".html")) {
- def pdfFile = file.replaceAll(".html",".pdf")
- "git add $file".execute(null, siteDir).in.text
- "git add $pdfFile".execute(null, siteDir).in.text
- }
- }
-
- // the commit doesn't seem to do anything; so instead using antrun plugin below to complete.
- // "git commit --message '${message}'".execute(null, siteDir).text
- // "git reset --hard".execute(null, siteDir).in.text
-
- return null
- </source>
- </configuration>
- </execution>
- </executions>
- </plugin>
+<!--
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.8</version>
@@ -473,7 +449,7 @@
<echo message=""/>
<echo message="git commit -m '${message}' "/>
<echo message=""/>
- <exec executable="git" dir="${isis-site-content.dir}">
+ <exec executable="git" dir="${isis-site-latest.dir}">
<arg value="commit"/>
<arg value="-m"/>
<arg value="${message}"/>
@@ -481,11 +457,11 @@
<echo message=""/>
<echo message=""/>
- <echo message="git reset --hard"/>
+ <echo message="git reset --hard"/>
<echo message=""/>
- <exec executable="git" dir="${isis-site-content.dir}">
+ <exec executable="git" dir="${isis-site-latest.dir}">
<arg value="reset"/>
- <arg value="--hard"/>
+ <arg value="--hard"/>
</exec>
<echo message=""/>
</target>
@@ -496,6 +472,7 @@
</execution>
</executions>
</plugin>
+ -->
</plugins>
</build>
</profile>
diff --git a/adocs/documentation/src/main/asciidoc/index.html b/adocs/documentation/src/main/asciidoc/index.html
index 6ae48fd..a529107 100644
--- a/adocs/documentation/src/main/asciidoc/index.html
+++ b/adocs/documentation/src/main/asciidoc/index.html
@@ -178,49 +178,54 @@ table.CodeRay td.code>pre{padding:0}
<ul class="nav navbar-nav">
<li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Documentation<span class="caret"></span></a>
<ul class="dropdown-menu">
- <li><a href="./documentation.html">Table of Contents</a></li>
+ <li><a href="versions/SNAPSHOT/documentation.html">1.16.0-SNAPSHOT</a></li>
<li role="separator" class="divider"></li>
- <li class="dropdown-header">User Guides</li>
- <li><a href="guides/ugfun/ugfun.html">Fundamentals</a></li>
- <li><a href="guides/ugvw/ugvw.html">Wicket Viewer</a></li>
- <li><a href="guides/ugvro/ugvro.html">Restful Objects Viewer</a></li>
- <li><a href="guides/ugodn/ugodn.html">DataNucleus Object Store</a></li>
- <li><a href="guides/ugsec/ugsec.html">Security</a></li>
- <li><a href="guides/ugtst/ugtst.html">Testing</a></li>
- <li><a href="guides/ugbtb/ugbtb.html">Beyond the Basics</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Reference Guides</li>
- <li><a href="guides/rgant/rgant.html">Annotations</a></li>
- <li><a href="guides/rgsvc/rgsvc.html">Domain Services</a></li>
- <li><a href="guides/rgcfg/rgcfg.html">Core Config' Properties</a></li>
- <li><a href="guides/rgcms/rgcms.html">Classes, Methods and Schema</a></li>
- <li><a href="guides/rgmvn/rgmvn.html">Maven plugin</a></li>
- <li><a href="guides/rgfis/rgfis.html">Framework Internal Services</a></li>
- <li role="separator" class="divider"></li>
- <li class="dropdown-header">Javadoc</li>
- <li><a href="http://javadoc.io/doc/org.apache.isis.core/isis-core-applib">Applib</a></li>
+ <li><a href="documentation.html">current</a></li>
+ <li><a href="versions/1.15.1/documentation.html">1.15.1</a></li>
+ <li><a href="versions/1.15.0/documentation.html">1.15.0</a></li>
+ <li><a href="versions/1.14.0/documentation.html">1.14.0</a></li>
+ <li><a href="versions/1.13.2.1/documentation.html">1.13.2.1</a></li>
+ <li><a href="versions/1.13.2/documentation.html">1.13.2</a></li>
+ <li><a href="versions/1.13.1/documentation.html">1.13.1</a></li>
+ <li><a href="versions/1.13.0/documentation.html">1.13.0</a></li>
+ <li><a href="versions/1.12.2/documentation.html">1.12.2</a></li>
+ <li><a href="versions/1.12.1/documentation.html">1.12.1</a></li>
+ <li><a href="versions/1.12.0/documentation.html">1.12.0</a></li>
+ <li><a href="versions/1.11.1/documentation.html">1.11.1</a></li>
+ <li><a href="versions/1.11.0/documentation.html">1.11.0</a></li>
+ <li><a href="versions/1.10.0/documentation.html">1.10.0</a></li>
+ <li><a href="versions/1.9.0/documentation.html">1.9.0</a></li>
+ <li><a href="versions/1.8.0/documentation.html">1.8.0</a></li>
</ul> </li>
<li class="dropdown hidden-sm hidden-md"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Downloads<span class="caret"></span></a>
<ul class="dropdown-menu">
- <li><a href="downloads.html">Downloads</a></li>
- <li><a href="release-notes/release-notes.html">Release Notes</a></li>
- <li><a href="migration-notes/migration-notes.html">Migration Notes</a></li>
- <li role="separator" class="divider"></li>
<li class="dropdown-header">Maven archetypes</li>
<li><a href="guides/ugfun/ugfun.html#_ugfun_getting-started_helloworld-archetype">helloworld</a></li>
<li><a href="guides/ugfun/ugfun.html#_ugfun_getting-started_simpleapp-archetype">simpleapp</a></li>
<li role="separator" class="divider"></li>
- <li><a href="https://issues.apache.org/jira/browse/ISIS">ASF JIRA</a></li>
+ <li><a href="downloads.html">Downloads</a></li>
+ <li><a href="release-notes/release-notes.html">Release Notes</a></li>
+ <li><a href="migration-notes/migration-notes.html">Migration Notes</a></li>
+ <li role="separator" class="divider"></li>
<li><a href="https://github.com/apache/isis">Github mirror</a></li>
</ul> </li>
<li class="dropdown hidden-sm"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Support<span class="caret"></span></a>
<ul class="dropdown-menu">
- <li><a href="support.html">Mailing lists</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="dropdown-header">Guides</li>
+ <li><a href="guides/dg/dg.html">Developers' Guide</a></li>
+ <li><a href="guides/cgcom/cgcom.html">Committers' Guide</a></li>
+ <li><a href="guides/htg.html">Hints-n-Tips Guide</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="dropdown-header">Mailing Lists</li>
+ <li><a href="support.html">How to subscribe</a></li>
<li><a href="https://lists.apache.org/list.html?users@isis.apache.org">Archives (ASF Pony mail)</a></li>
<li><a href="http://isis.markmail.org/search/?q=">Archives (Markmail)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="dropdown-header">Other Resources</li>
+ <li><a href="https://issues.apache.org/jira/browse/ISIS">ASF JIRA</a></li>
<li><a href="http://stackoverflow.com/questions/tagged/isis">Stack Overflow</a></li>
- <li><a href="guides/dg/dg.html">How to contribute</a></li>
- <li><a href="help.html">Other resources</a></li>
+ <li><a href="help.html">Wiki, Fisheye etc</a></li>
</ul> </li>
<li class="dropdown hidden-sm hidden-md"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">@ASF<span class="caret"></span></a>
<ul class="dropdown-menu">
diff --git a/adocs/template/document.html.erb b/adocs/template/document.html.erb
index 1399b84..43a9c61 100644
--- a/adocs/template/document.html.erb
+++ b/adocs/template/document.html.erb
@@ -143,17 +143,16 @@
<li class="dropdown hidden-sm hidden-md">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Downloads<span class="caret"></span></a>
<ul class="dropdown-menu">
- <li><a href="<%= (attr :_basedir) %>downloads.html">Downloads</a></li>
- <li><a href="<%= (attr :_basedir) %>release-notes/release-notes.html">Release Notes</a></li>
- <li><a href="<%= (attr :_basedir) %>migration-notes/migration-notes.html">Migration Notes</a></li>
-
- <li role="separator" class="divider"></li>
<li class="dropdown-header">Maven archetypes</li>
<li><a href="<%= (attr :_basedir) %>guides/ugfun/ugfun.html#_ugfun_getting-started_helloworld-archetype">helloworld</a></li>
<li><a href="<%= (attr :_basedir) %>guides/ugfun/ugfun.html#_ugfun_getting-started_simpleapp-archetype">simpleapp</a></li>
<li role="separator" class="divider"></li>
- <li><a href="https://issues.apache.org/jira/browse/ISIS">ASF JIRA</a></li>
+ <li><a href="<%= (attr :_basedir) %>downloads.html">Downloads</a></li>
+ <li><a href="<%= (attr :_basedir) %>release-notes/release-notes.html">Release Notes</a></li>
+ <li><a href="<%= (attr :_basedir) %>migration-notes/migration-notes.html">Migration Notes</a></li>
+
+ <li role="separator" class="divider"></li>
<li><a href="https://github.com/apache/isis">Github mirror</a></li>
</ul>
</li>
@@ -161,12 +160,20 @@
<li class="dropdown hidden-sm">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Support<span class="caret"></span></a>
<ul class="dropdown-menu">
- <li><a href="<%= (attr :_basedir) %>support.html">Mailing lists</a></li>
+ <li class="dropdown-header">Guides</li>
+ <li><a href="<%= (attr :_basedir) %>guides/dg/dg.html">Developers' Guide</a></li>
+ <li><a href="<%= (attr :_basedir) %>guides/cgcom/cgcom.html">Committers' Guide</a></li>
+ <li><a href="<%= (attr :_basedir) %>guides/htg.html">Hints-n-Tips Guide</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="dropdown-header">Mailing Lists</li>
+ <li><a href="<%= (attr :_basedir) %>support.html">How to subscribe</a></li>
<li><a href="https://lists.apache.org/list.html?users@isis.apache.org">Archives (ASF Pony mail)</a></li>
<li><a href="http://isis.markmail.org/search/?q=">Archives (Markmail)</a></li>
+ <li role="separator" class="divider"></li>
+ <li class="dropdown-header">Other Resources</li>
+ <li><a href="https://issues.apache.org/jira/browse/ISIS">ASF JIRA</a></li>
<li><a href="http://stackoverflow.com/questions/tagged/isis">Stack Overflow</a></li>
- <li><a href="<%= (attr :_basedir) %>guides/dg/dg.html">How to contribute</a></li>
- <li><a href="<%= (attr :_basedir) %>help.html">Other resources</a></li>
+ <li><a href="<%= (attr :_basedir) %>help.html">Wiki, Fisheye etc.</a></li>
</ul>
</li>
--
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.