📝 ehcache#72 Support for Ehcache 3.0 and 3.1 documentation in parallel

.gitignore

@@ -1,7 +1,7 @@
 _site
 .sass-cache
 .DS_Store
-_eh3
-documentation/3.0
+/_eh3*
+/documentation/3*
 .idea
 Gemfile.lock

README.md

@@ -13,8 +13,11 @@ This is the source code/files for the ehcache.org website.  The files in this re
 * Clone this repository to your local system (if you're going to contribute content, fork it first, and clone that)
   * Create a branch to contribute content
 * To generate the *full* site including Ehcache 3 docs, you need to do the following:
-  * the contents of ehcache3 repository needs to be linked/or copied as `_eh3`
-  * the contents of ehcache3 repository's docs/src/docs/asciidoc/user folder needs to be linked/or copied as `documentation/3.0`
+  * the contents of ehcache3 release/3.0 branch or a 3.0 tag needs to be linked/or copied as `_eh3`
+  * the contents of ehcache3 release/3.0 branch or a 3.0 tag's docs/src/docs/asciidoc/user folder needs to be linked/or copied as `documentation/3.0`
+  * the same must be done with all other releases, using the major and minor versions as folder names.
+    * So with 3.1, it means linking to `_eh31` and `documentation/3.1`
+    * This can be achieved easily with [`git worktree`](https://git-scm.com/docs/git-worktree)
 * To generate and view (locally serve) the site `jekyll serve` then point your browser at `http://localhost:4000`
 * To simply generate the site `jekyll build`
 

_config.yml

@@ -12,8 +12,6 @@ disqus_shortname: ehcache
 
 exclude: [default.gems, README.md]
 
-eh3_source_dir: /_eh3
-
 # Build settings
 markdown: kramdown
 
@@ -31,15 +29,16 @@ asciidoctor:
     - pygments-css=style
     - icons=font
     - sourcedir=/_eh3
+    - sourcedir31=/_eh31
     - imagesdir=images
     - sectanchors
     - idprefix
     - idseparator=-
 
 documentation:
     ehcache:
-      current: "3.0"
-      future: "3.1"
+      current: "3.1"
+      future: "3.2"
 
 defaults:
   -
@@ -97,3 +96,11 @@ defaults:
       layout: "docs3x_page"
       ehc_version: "3.0"
       ehc_javadoc_version: "3.0.2"
+  -
+    scope:
+      path: "documentation/3.1"
+      type: "pages"
+    values:
+      layout: "docs3x_page"
+      ehc_version: "3.1"
+      ehc_javadoc_version: "3.1.0"

_includes/ehc3_quickstart.html

@@ -16,7 +16,7 @@ <h3><a name="jars"></a>Downloading the jars</h3>
       <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml">    &lt;dependency&gt;
       &lt;groupId&gt;org.ehcache&lt;/groupId&gt;
       &lt;artifactId&gt;ehcache&lt;/artifactId&gt;
-      &lt;version&gt;3.0.2&lt;/version&gt;
+      &lt;version&gt;3.1.0&lt;/version&gt;
     &lt;/dependency&gt;      </code></pre>
 
       <h3>Coding to the Ehcache 3 API</h3>

_layouts/docs3x_page.html

@@ -27,6 +27,9 @@
           <li class="submenu"><a href="107.html">javax.cache aka JSR-107</a></li>
           <li class="submenu"><a href="examples.html">Java Examples</a></li>
           <li class="submenu"><a href="xsds.html">Configuration XSD</a></li>
+          {% if page.ehc_version != '3.0' %}
+          <li class="submenu"><a href="clustered-cache.html">Clustering with Terracotta</a></li>
+          {% endif %}
         </ul>
 
         General topics:

documentation/index.md

@@ -12,11 +12,11 @@ permalink: /documentation/
 
 | | |
 |:----|:--|
-|[Ehcache 3.0 User Guide](/documentation/3.0/) |[JavaDoc](/apidocs/3.0.2/index.html){:target="_blank"} |
+|[Ehcache 3.1 User Guide](/documentation/3.1/) |[JavaDoc](/apidocs/3.1.0/index.html){:target="_blank"} |
 |[Ehcache 2.10.x User Guide](/generated/2.10.2/html/ehc-all)   also available as [PDF](/documentation/2.10.2/pdf/index.html)|[JavaDoc](/apidocs/2.10.2/index.html){:target="_blank"} |
 |---|   |
 |[Platform and Release Compatibility Tables](http://www.terracotta.org/confluence/display/release/Home){: target="_blank"}||
-|[License](/about/license.html) (Apache 2.0),  [3rd Party Licenses](/files/legal/TOE_3.0.pdf) (Apache 2.0), [Legal Notices](http://documentation.softwareag.com/legal/){: target="_blank"}||
+|[License](/about/license.html) (Apache 2.0),  [3rd Party Licenses](https://confluence.terracotta.org/display/release/Third+Party+Licenses){: target="_blank"} (Apache 2.0), [Legal Notices](http://documentation.softwareag.com/legal/){: target="_blank"}||
 
 In addition to the documentation, there are a number of resources available online - see the [Resources page](/resources/) for links to some of them.
 
@@ -36,6 +36,7 @@ If you don’t find what you’re looking for in the docs, post a question to th
 
 | | |
 |:----|:--|
+|[Ehcache 3.0 User Guide](/documentation/3.0/) |[JavaDoc](/apidocs/3.0.2/index.html){:target="_blank"} |
 |[Ehcache 2.9.x User Guide](/documentation/2.9/)|[JavaDoc](/apidocs/2.9/index.html){:target="_blank"}|
 |[Ehcache 2.8.x User Guide](/documentation/2.8/)|[JavaDoc](/apidocs/2.8.5/index.html){:target="_blank"}|
 |Ehcache 2.7.x |[JavaDoc](/apidocs/2.7.6/index.html){:target="_blank"}|

downloads/index.md

@@ -11,11 +11,11 @@ active_menu_id: ehc_mnu_download
 
 #### Ehcache 3
 
-> [Ehcache 3.0 latest](https://github.com/ehcache/ehcache3/releases/download/v3.0.2/ehcache-3.0.2.jar) .jar
+> [Ehcache 3.1 latest](https://github.com/ehcache/ehcache3/releases/download/v3.1.0/ehcache-3.1.0.jar) .jar
 
 More files related to releases of Ehcache 3 are available on the project's [GitHub release page](https://github.com/ehcache/ehcache3/releases).
 
-[License](/about/license.html) (Apache 2.0),  [3rd Party Licenses](/files/legal/TOE_3.0.pdf) (Apache 2.0),  [Legal Notices](http://documentation.softwareag.com/legal/){: target="_blank"}
+[License](/about/license.html) (Apache 2.0),  [3rd Party Licenses](https://confluence.terracotta.org/display/release/Third+Party+Licenses){: target="_blank"} (Apache 2.0),  [Legal Notices](http://documentation.softwareag.com/legal/){: target="_blank"}
 
 ---
 
@@ -44,7 +44,7 @@ To include Ehcache 3.x in your project, use:
 <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml">    &lt;dependency&gt;
       &lt;groupId&gt;org.ehcache&lt;/groupId&gt;
       &lt;artifactId&gt;ehcache&lt;/artifactId&gt;
-      &lt;version&gt;3.0.2&lt;/version&gt;
+      &lt;version&gt;3.1.0&lt;/version&gt;
     &lt;/dependency&gt;
 </code></pre>