ehcache / ehcache.org-site Goto Github PK

https://www.ehcache.org/documentation/3.8/getting-started.html#configuring-with-xml

<heap unit="entries">20</heap> 3
is incorrectly explained as : foo is declared to hold up to 2,000 entries on heap…​

<offheap unit="MB">10</offheap> 4
is incorrectly explained as : …​as well as up to 500 MB of off-heap memory before it starts evicting

Under "Not quite ready yet?" - it links directly to ehcache 3.0 docs. Probably at this point it should link to 3.1.x docs. Maybe for long-term "fool-proofness" it should just link to the root docs page.

Currently the 2.7 documentation is disabled because it contains a lot of invalid links.

From a quick look, we have links of the following style:

• http://ehcache.org/xref/net/sf/ehcache/search/aggregator/package-frame.html

They most likely need to be replaced by proper javadoc links, according to the new structure of the site.

Looks like some syncing needs to happen between the asciidoc generated table and the one existing on the website. I am guessing we have duplication here ... not sure if that can be removed ... but at least needs to be in sync.

See http://www.ehcache.org/documentation/3.0/

The About page contains the following paragraph:

Checkout recently released Ehcache 3. It natively complies with JSR107 (JCache spec), supports offheap storage, and has many other additions and improvements.

This doesn't look great now that version 3 was released 7 years ago.

The first sentence should be removed and the second merged into the first paragraph.

• File available from documentation page near the existing Legal Notice link
• File available from downloads page under the Ehcache 3 section, above the maven one

See http://www.ehcache.org/documentation/3.0/xml.html

• Link http://www.ehcache.org/documentation/3.0/xsds.html#_core should be http://www.ehcache.org/documentation/3.0/xsds.html#core
• Link http://www.ehcache.org/documentation/3.0/107.html#_supplement_jsr_107_s_configurations should be http://www.ehcache.org/documentation/3.0/107.html#supplement-jsr-107-s-configurations
• Link http://www.ehcache.org/documentation/3.0/xml.html#__code_cache_template_code_elements should be http://www.ehcache.org/documentation/3.0/xml.html#code-cache-template-code-elements

So we have a leading _ for anchors and again _ instead of - inside the anchor.
Also the layout of the page will hide part of the content when linking to an anchor.

While Ehcache 3.0.0 has been released, with all its documentation under documentation/3.0, the upcoming 3.1.0 release will have a different documentation as clustered is added to it.
I believe the idea is to have that documentation under documentation/3.1.

Whenever we reach that point, it would be great to have a visual way on every page documentation to indicate which version is current and which is for a previous version.

And by the way, if we were to do that, it would be pretty easy to extend the visual clue so that we could publish documentation for a future version without risk of confusing users.

Opinions and suggestions welcome!

The page http://www.ehcache.org/documentation/3.0/ is composed on one side of an asciidoc file from the ehcache codebase that contains a toc. At the same time, the template used to render these pages on the website includes docs3x_page.html which duplicates the toc.

Would be good to find a way to get rid of the duplication.

There is a typo in ehcache 2.8 docs, with an unfortunate, superfluous "NOT", in a sentence that reads "Ehcache is not for both general-purpose caching...".

This occurs in file:

ehcache.org-site/documentation/2.8/get-started/introduction.md

The corrected wording, which is in other versions of doc is:

"Ehcache is not just for general-purpose caching, however, but also for caching Hibernate (second-level cache), data access objects, security credentials, web pages."

From Yi:

At http://www.ehcache.org/ main page

Typo in: "Ehcache is an open source, standards-based cache that boosts performance, offloads your database, and simplifyies"

The 4th bullet point for milestone3 features with just ellipses doesn't really serve much purpose. Perhaps it can link to the list of issues? e.g. https://github.com/ehcache/ehcache3/issues?q=milestone%3A%22Milestone+3%22

In the quick start, the 'new' is superfluous. There's also a typo in 'development'
"While new Ehcache 3.0 is still in developement"

The link to "user documentation" at the bottom going to http://www.ehcache.org/docs/user/3.0 gives a 404
There's a http://www.ehcache.org/documentation/3.0/, not sure if that's the same/intended target

This issue is to support sharing across social media properly by using twitter cards, facebook cards, G+ cards, etc.

Goal is to add some metadata entries in the header that contain the content title, caption, image, etc so that twitter and facebook can read them to generate a sharing card.

Also, links should include UTM tracking attributes.

Here are some details:

• https://moz.com/blog/meta-data-templates-123
• https://dev.twitter.com/cards/overview

• Documentation landing page
• Downloads page
• maybe more ...

The target URL contains an extra "jira" element:

https://jira.terracotta.org/jira/browse/EHC

The link target should be:

https://jira.terracotta.org/jbrowse/EHC

Placeholder issue to keep track of all changes necessary for the Ehcache 3.0.1 release.

• Add new doc section on Expiry in TOC
• Javadoc for 3.0.1
• Update references in files from 3.0.0 to 3.0.1

... looks like this isn't there...

• Documentation for 3.1 under its own folder, keeping the 3.0 documentation available
  • Includes ToC updates for clustering section
• If possible, include fix for #45 even if we work on improving visuals later
• Legal doc updates
  • Link to https://confluence.terracotta.org/display/release/Third+Party+Licenses and remove files/legal
• Update announcement area of home page
• Update documentation root page to have links to both 3.0 and 3.1 items

For example the following needs to be updated to better indicate the solution is deprecated and should no longer have any download link - which are dead anyway.

See http://asciidoctor.org/docs/user-manual/#anchors

The page https://www.ehcache.org/downloads/ mentions 3.8.1 as latest version.
Shouldn't it point to the latest version of the 3.9.* branch ?

Otherwise, if there is some policy about even/odd minor versions, it could be documented here.

See for example http://www.ehcache.org/documentation/2.7/configuration/cache-size.html

In the documentation section, we could add a "Talk" section with the following links:

Bringing javax.cache'ing to your application

• Video: https://spring.io/blog/2015/10/19/springone2gx-2015-replay-bringing-javax-cache-ing-to-your-application
  • Slides: http://www.slideshare.net/SpringCentral/bringing-javaxcacheing-to-your-app

Terracotta's OffHeap Explained

• Video: https://www.youtube.com/watch?v=xCojSZMp_Zw&index=1&list=FLIxdXH5lS08edKfvRIBe-ZQ
• Slides: http://www.slideshare.net/ChrisDennis7/terracottas-offheap-explained-55214150

Ehcache 3: JSR-107 on steroids

• Slides: http://www.slideshare.net/LouisJacomet/ehcache-3-jsr107-on-steroids-at-devoxx-morocco

There are the ones I know but I guess there are plenty other ones :-)

This should no longer be documented : https://www.ehcache.org/documentation/2.7/modules/cache-server.html#downloading

Issue to keep track of all changes necessary for the Ehcache 3.0.2 release.

• Javadoc for 3.0.2
• Update references in files from 3.0.1 to 3.0.2

We should have some kind of traffic monitoring so that we know how well blog articles do, how much documentation gets consulted and so forth.

The following is a nice intro into enabling Google Analytics in a Jekyll site: https://michaelsoolee.com/google-analytics-jekyll/

See for example http://www.ehcache.org/documentation/3.0/xml.html#code-cache-code-elements

There is no way to download the Ehcache Remote Debugger on the site which is mentioned in documentations:

https://www.ehcache.org/generated/2.9.0/html/ehc-all/index.html#page/Ehcache_Documentation_Set/co-rmi_about_the_remote_debugger.html

The docs says: Detailed instructions on how to configure and start a Terracotta server array can be found elsewhere., but a link to that elsewhere (or a WIP mention) would probably be great!

http://www.ehcache.org/blog/2016/05/17/ehcache3_jsr107_spring.html

Hard to read when lines are long.

the javadoc for ehcache3 needs to point at the m3 docs.