Skip to content

Commit

Permalink
📝 ehcache#72 Updates for Ehcache 3.1 documentation
Browse files Browse the repository at this point in the history
* Includes support for 3.0 and 3.1 docsets in parallel
* Includes version updates to relevant pages
* Includes 3.1 XSD set
  • Loading branch information
ljacomet committed Jun 30, 2016
1 parent 9d64aeb commit 8bdcd93
Show file tree
Hide file tree
Showing 16 changed files with 936 additions and 18 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
_site
.sass-cache
.DS_Store
_eh3
documentation/3.0
/_eh3*
/documentation/3*
.idea
Gemfile.lock
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
15 changes: 11 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ disqus_shortname: ehcache

exclude: [default.gems, README.md]

eh3_source_dir: /_eh3

# Build settings
markdown: kramdown

Expand All @@ -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:
-
Expand Down Expand Up @@ -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"
2 changes: 1 addition & 1 deletion _includes/ehc3_quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
14 changes: 10 additions & 4 deletions _includes/home_announcement.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
<h2>Ehcache 3 has been officially released!</h2>
This new major version of Ehcache offers the following
<h2>Ehcache 3.1 is now available!</h2>
<p>
This version of Ehcache adds distribtued caching capabilities via a new generation of <a href="http://terracotta.org">Terracotta server</a>.
</p>
<p>
Watch for continued rapid improvements to features, stability and performance of the 3.1 line throughout the coming weeks!
</p>
As a reminder, Ehcache 3.0 introduced the following:
<ul>
<li>Revamped API that leverages Java generics and simplifies Cache interactions,</li>
<li>Full compatibility with javax.cache API (JSR-107),</li>
<li>Offheap storage capabilities, including offheap only caches,</li>
<li>Improved performance over Ehcache 2.x,</li>
<li>Out of the box Spring Caching integration thanks to the javax.cache support,</li>
<li>Out of the box Spring Caching and Hibernate integration thanks to the javax.cache support,</li>
<li>And many more ...</li>
</ul>
"Official" builds of 3.0 are available on the project's GitHub <a href="https://github.com/ehcache/ehcache3/releases/tag/v3.0.0">release page</a> or from Maven Central - see below.
"Official" builds are available on the project's GitHub <a href="https://github.com/ehcache/ehcache3/releases" target="_blank">release page</a> or from Maven Central - see below.
3 changes: 3 additions & 0 deletions _layouts/docs3x_page.html
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 3 additions & 2 deletions documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"} |
|---| &nbsp; |
|[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.

Expand All @@ -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"}|
Expand Down
6 changes: 3 additions & 3 deletions downloads/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"}

---

Expand Down Expand Up @@ -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>

Expand Down
58 changes: 58 additions & 0 deletions schema/ehcache-107-ext-3.1.xsd
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?xml version="1.0"?>
<!--
~ Copyright Terracotta, Inc.
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->

<xs:schema version="1.0"
xmlns:jsr107="http://www.ehcache.org/v3/jsr107"
xmlns:eh="http://www.ehcache.org/v3"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" targetNamespace="http://www.ehcache.org/v3/jsr107">
<xs:import namespace="http://www.ehcache.org/v3"/>

<xs:element name="mbeans" type="jsr107:mbeans-type" substitutionGroup="eh:service-configuration"/>

<xs:element name="defaults" type="jsr107:defaults-type" substitutionGroup="eh:service-creation-configuration">
<xs:key name="default-template-ref">
<xs:selector xpath="cache-template"/>
<xs:field xpath="@name"/>
</xs:key>
</xs:element>

<xs:complexType name="defaults-type">
<xs:sequence>
<xs:element name="cache" type="jsr107:cache-type" minOccurs="0" maxOccurs="unbounded">
<xs:key name="template-ref">
<xs:selector xpath="cache-template"/>
<xs:field xpath="@name"/>
</xs:key>
</xs:element>
</xs:sequence>
<xs:attribute name="default-template" type="xs:IDREF" use="optional"/>
<xs:attribute name="jsr-107-compliant-atomics" type="xs:boolean" use="optional"/>
<xs:attribute name="enable-management" type="xs:boolean" use="optional"/>
<xs:attribute name="enable-statistics" type="xs:boolean" use="optional"/>
</xs:complexType>

<xs:complexType name="cache-type">
<xs:attribute name="name" type="xs:ID" use="required" />
<xs:attribute name="template" type="xs:IDREF" use="required" />
</xs:complexType>

<xs:complexType name="mbeans-type">
<xs:attribute name="enable-management" type="xs:boolean" use="optional"/>
<xs:attribute name="enable-statistics" type="xs:boolean" use="optional"/>
</xs:complexType>
</xs:schema>
Loading

0 comments on commit 8bdcd93

Please sign in to comment.