Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lot of Website improvements #49

Merged
merged 10 commits into from
May 6, 2016
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ _site
.DS_Store
_eh3
documentation/3.0
.idea
2 changes: 2 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ <h3><i class="fa fa-chain-broken"></i> <i class="fa fa-frown-o"></i> Sorry!</
<ul>
<li><a href="/downloads">Downloads</a></li>
<li><a href="/documentation">Documentation</a></li>
<li><a href="/resources">Resources</a></li>
<li><a href="/blog">Ehcache Blog</a></li>
<li><a href="/about">About</a></li>
<li><a href="/events">News and Events</a></li>
</ul>
Expand Down
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,37 @@ ehcache.org is served/hosted by github. The webserver does NOT serve the conte
* Commit your changes and make a pull request to get the content of that branch into the master branch of the ehcache.github.io repository (which will then make it "live").


### Contributing a blog post

1. Ensure you first edit `_data/authors.yml` to add you information

2. Create a new ASCII Doc file under `_posts/blog`. The file should be named with the following format: `yyyy-MM-DD-title-in-lowercase.adoc`

3. Add a header in your file. Modify the fields according to your post, especially for the title, headline, tags, authors and date

```
layout: post
title: "Your blog post title"
headline: "Your blo post headline"
categories: blog
hidden: false
author: your_author_key
tags: [ehcache, website]
date: 2016-05-04T18:00:00-05:00
modified:
```

4. Send your pull request :+1:

### Contributing an external resource

Same rules apply as above, except that you have to put your file into `_posts/resources` and add a header like this one:

```
title: "Ehcache 3: JSR-107 on steroids"
headline: "Ehcache 3: JSR-107 on steroids at Devoxx Morocco by Louis Jacomet"
categories: resources
date: 2015-11-18T00:00:00-00:00
``

__IMPORTANT:__ Yout content MUST be short! Links, headline, title, that's all.
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ twitter_username: ehcache
github_username: ehcache
linkedin_username: terracotta
facebook_username: Terracotta
disqus_shortname: ehcache

eh3_source_dir: /_eh3

Expand All @@ -17,8 +18,7 @@ markdown: kramdown

gems:
- jekyll-asciidoc


- jekyll-sitemap


asciidoctor:
Expand Down
8 changes: 8 additions & 0 deletions _data/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Authors

mathieu_carbou:
name: Mathieu Carbou
web: https://www.linkedin.com/in/mathieucarbou
avatar: https://www.gravatar.com/avatar/9db6fc82f800e193111dd725dd3a7b52
twitter: mathieucarbou
position: Software Engineer at Terracotta
4 changes: 4 additions & 0 deletions _includes/banner.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ <h1>JAVA’S MOST WIDELY-USED CACHE</h1>
<span>&nbsp;&nbsp;</span>
<a href="/documentation/"><button type="button" class="btn btn-lg btn-primary"><i class="fa fa-book"></i> Documentation</button></a>
<span>&nbsp;&nbsp;</span>
<a href="/resources/"><button type="button" class="btn btn-lg btn-primary"><i class="fa fa-external-link-square"></i> Resources</button></a>
<span>&nbsp;&nbsp;</span>
<a href="/resources/"><button type="button" class="btn btn-lg btn-primary"><i class="fa fa-rss-square"></i> Ehcache Blog</button></a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there are too many top-level menu items now.

What about putting resources under "docs" and having a "blogs" with "ehcache blog" and "terracotta blog" under it?

Copy link
Member Author

@mathieucarbou mathieucarbou May 6, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I agree with you but I don't know the answer because when discussing with @ljacomet we decided to put resources there. I sincerely don't know now if it is better to move it or change the CSS to improve the font / space or anything else.

The issue currently is that the top bar is too long and on smaller resolution, the right side comes below the left side and it's ugly.

I'll change so that we can test!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the sizing issue. I would indeed put the two blog sections under a single menu item.
For the rest, I believe having doc as a direct link remains interesting.
Could we group resources and downloads under a single menu item?

<span>&nbsp;&nbsp;</span>
<a href="https://github.com/ehcache"><button type="button" class="btn btn-lg btn-default"><i class="fa fa-github"></i> GitHub Project</button></a>
</div>

Expand Down
22 changes: 22 additions & 0 deletions _includes/disqus_comments.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{% if site.disqus_shortname %}
<script type="text/javascript">
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
var disqus_shortname = '{{ site.disqus_shortname }}'; // required: replace example with your forum shortname
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be edited before enabling disqus?

Copy link
Member Author

@mathieucarbou mathieucarbou May 6, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created a Disqus channel named ehcache but it is on my account.
I would prefer to delete it so that we create the room from another much more official user. do we have one ? Or we use @jhouserizer or @ljacomet account ?

UPDATE: the idea would be to have one terracotta account, and then we can add seevral moderators (users) or admins.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can create a tc account


/* * * DON'T EDIT BELOW THIS LINE * * */
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = 'https://' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();

/* * * DON'T EDIT BELOW THIS LINE * * */
(function () {
var s = document.createElement('script'); s.async = true;
s.type = 'text/javascript';
s.src = 'https://' + disqus_shortname + '.disqus.com/count.js';
(document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
}());
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
{% endif %}
10 changes: 10 additions & 0 deletions _includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@
</a>
</li>
{% endif %}

<li>
<a href="/feed.xml" title="Atom/RSS feed">
<i class="fa fa-rss-square"></i> Ehcache Blog Feed
</a>
</li>
</ul>
</div>

Expand All @@ -58,6 +64,10 @@
<br/>
<a href="/documentation/"><i class="fa fa-book"></i> Documentation</a>
<br/>
<a href="/resources/"><i class="fa fa-external-link-square"></i> Resources</a>
<br/>
<a href="/blog/"><i class="fa fa-rss-square"></i> Ehcache Blog</a>
<br/>
<a href="/community/"><i class="fa fa-users"></i> Join the Community</a>
</div>

Expand Down
5 changes: 2 additions & 3 deletions _includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@

<title>{% if page.title %}{{ page.title | replace: '!DOC_VERSION!', page.ehc_version }}{% else %}{{ site.title }}{% endif %}</title>

<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
<meta name="description" content="{% if page.headline %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">

<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" />

<link href="/feed.xml" type="application/atom+xml" rel="alternate" title="{{ site.title }} Feed">


<!-- Fonts -->
Expand Down
14 changes: 8 additions & 6 deletions _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,32 @@
<ul class="nav navbar-nav">
<li id="ehc_mnu_about"><a href="/about/"><i class="fa fa-info-circle"></i> About</a></li>
<li id="ehc_mnu_docs"><a href="/documentation/"><i class="fa fa-book"></i> Docs</a></li>
<li id="ehc_mnu_resources"><a href="/resources/"><i class="fa fa-external-link-square"></i> Resources</a></li>
<li id="ehc_mnu_download"><a href="/downloads/"><i class="fa fa-download"></i> Download</a></li>
<li id="ehc_mnu_community" class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><i class="fa fa-users"></i> Community <span class="caret"></span></a>
<ul class="dropdown-menu">
<li class="dropdown-header">We Love Contributors</li>
<li><a href="/community/"><i class="fa fa-code"></i> Contributing</a></li>
<li><a href="/community/contribute.html"><i class="fa fa-code"></i> Contributing</a></li>
<li role="separator" class="divider"></li>
<li class="dropdown-header">Forums</li>
<li><a href="https://groups.google.com/forum/#!forum/ehcache-users" target="_blank"><i class="fa fa-commenting"></i> Users' Forum</a></li>
<li><a href="https://groups.google.com/forum/#!forum/ehcache-dev" target="_blank"><i class="fa fa-commenting"></i> Developers' Forum</a></li>
<li role="separator" class="divider"></li>
<li class="dropdown-header">Source Code</li>
<li><a href="https://github.com/ehcache/ehcache3"><i class="fa fa-github"></i> GitHub (Ehcache 3)</a></li>
<li><a href="http://svn.terracotta.org/svn/ehcache/trunk"><i class="fa fa-code-fork"></i> SVN (Ehcache 2)</a></li>
<li><a href="https://github.com/ehcache/ehcache3" target="_blank"><i class="fa fa-github"></i> GitHub (Ehcache 3)</a></li>
<li><a href="http://svn.terracotta.org/svn/ehcache/trunk" target="_blank"><i class="fa fa-code-fork"></i> SVN (Ehcache 2)</a></li>
<li role="separator" class="divider"></li>
<li class="dropdown-header">Bug Tracking</li>
<li><a href="https://github.com/ehcache/ehcache3/issues"><i class="fa fa-bug"></i> GitHub (Ehcache 3)</a></li>
<li><a href="https://jira.terracotta.org/jira/browse/EHC"><i class="fa fa-bug"></i> Jira (Ehcache 2)</a></li>
<li><a href="https://github.com/ehcache/ehcache3/issues" target="_blank"><i class="fa fa-bug"></i> GitHub (Ehcache 3)</a></li>
<li><a href="https://jira.terracotta.org/jira/browse/EHC" target="_blank"><i class="fa fa-bug"></i> Jira (Ehcache 2)</a></li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li id="ehc_mnu_events"><a href="/events"><i class="fa fa-calendar"></i> News & Events</a></li>
<li><a href="http://blog.terracotta.org"><i class="fa fa-rss-square"></i> Blog</a></li>
<li><a href="/blog"><i class="fa fa-rss-square"></i> Ehcache Blog</a></li>
<li><a href="http://blog.terracotta.org" target="_blank"><i class="fa fa-rss-square"></i> Terracotta Blog</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
Expand Down
9 changes: 9 additions & 0 deletions _includes/social-share.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div class="social-share twitter">
<a href="https://twitter.com/intent/tweet?hashtags={{ page.tags | join: ',' | remove: ' ' }}&amp;text={{ page.title | escape | replace:' ','%20' }}&amp;url={{ site.url }}{{ page.url }}{% if author.twitter %}&amp;via={{ author.twitter }}{% endif %}" title="Share on Twitter" itemprop="Twitter"><i class="fa fa-twitter-square"></i> Tweet</a>
</div>
<div class="social-share facebook">
<a href="https://www.facebook.com/sharer/sharer.php?u={{ site.url }}{{ page.url }}" title="Share on Facebook" itemprop="Facebook"><i class="fa fa-facebook-square"></i> Like</a>
</div>
<div class="social-share googleplus">
<a href="https://plus.google.com/share?url={{ site.url }}{{ page.url }}" title="Share on Google Plus" itemprop="GooglePlus"><i class="fa fa-google-plus-square"></i> +1</a>
</div>
81 changes: 73 additions & 8 deletions _layouts/post.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,80 @@
---
layout: default
---
<div class="post">

<header class="post-header">
<h1 class="post-title">{{ page.title }}</h1>
<p class="post-meta">{{ page.date | date: "%b %-d, %Y" }}{% if page.author %} • {{ page.author }}{% endif %}{% if page.meta %} • {{ page.meta }}{% endif %}</p>
</header>
<br/>

<article class="post-content">
{{ content }}
</article>
{% if page.author %}
{% assign author = site.data.authors[page.author] %}
{% endif %}

<div class="container-fluid">

<div class="row row-offcanvas row-offcanvas-left">

<!-- sidebar -->
<div class="col-sm-3 sidebar-offcanvas" id="sidebar" role="navigation">
{% if author.avatar %}
<div>
<img src="{{ author.avatar }}" class="bio-photo" alt="{{ author.name }} bio photo"></a>
</div>
{% endif %}

{%if author.web %}
<div class="section">By <span class="fn"><a target="_blank" href="{{ author.web }}">{{ author.name }}</a></span></div>
{% else %}
<div class="section">By <span class="fn">{{ author.name }}</span></div>
{% endif %}

<div class="section">
{{ author.position }}
</div>

<div class="section entry-date date published"><time datetime="{{ page.date | date_to_xmlschema }}"><i class="fa fa-calendar-o"></i> {{ page.date | date: "%B %d, %Y" }}</time></div>

{% if page.modified %}<div class="section entry-date date modified"><time datetime="{{ page.modified }}"><i class="fa fa-pencil"></i> {{ page.modified | date: "%B %d, %Y" }}</time></div>{% endif %}

{% if site.disqus_shortname %}<div class="section entry-comments"><i class="fa fa-comment-o"></i> <a href="#disqus_thread">Leave a comment</a></div>{% endif %}

{%if author.twitter %}
<div class="section">Follow <span class="fn"><a target="_blank" href="{{ author.twitter }}">@{{ author.twitter }}</a></span></div>
{% endif %}

<div class="section">{% include social-share.html %}</div>

<div class="section">Tags: {% for tag in page.tags %}<a href="/tags/#{{ tag }}" title="Pages tagged {{ tag }}">{{ tag }}</a>{% unless forloop.last %}&nbsp;&bull;&nbsp;{% endunless %}{% endfor %}</div>

</div>

<!-- main area -->
<div class="col-xs-12 col-sm-9">

<header class="post-header">
<h1 class="post-title">{{ page.title }}</h1>
</header>

<article class="post-content">

<div class="entry-wrapper">
<header class="entry-header">
<h2 class="entry-title">{% if page.headline %}{{ page.headline }}{% else %}{{ page.title }}{% endif %}</h2>
</header>

<div class="entry-content">
{{ content }}

{% if site.disqus_shortname %}
<div id="disqus_thread"></div>
{% endif %}
</div>
</div>

</article>

</div>

</div>

</div>

{% include disqus_comments.html %}
26 changes: 0 additions & 26 deletions _posts/2015-08-20-welcome-to-jekyll.markdown

This file was deleted.

22 changes: 22 additions & 0 deletions _posts/blog/2016-05-04-new-website.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: post
title: "New Website"
headline: "The new Ehcache website is LIVE! Checkout its first post..."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't actually want to commit this file, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just for tests - What I would suggest is to set hidden: true. It won't appear in the website and not in the RSS feed, and it would still be there as an example.

categories: blog
hidden: false
author: mathieu_carbou
tags: [ehcache, website]
comments: true
date: 2016-05-04T18:00:00-05:00
modified: 2016-05-05T18:00:00-05:00
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent et purus at quam ullamcorper volutpat. Nullam ut nunc at sem tincidunt elementum vel et sem. Nam a nisl nec nisi tincidunt interdum in vel nulla. Maecenas ac elit vel felis pellentesque feugiat ut in quam. Quisque in dapibus enim, dapibus ultricies erat. Vivamus tristique varius magna at tincidunt. Ut venenatis dolor neque. Morbi pretium diam sed nulla consectetur maximus. Etiam sem turpis, ullamcorper sed arcu et, consectetur euismod est. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Mauris pharetra lorem ante, at suscipit urna bibendum ut. In a condimentum turpis. Pellentesque fermentum ex eget venenatis imperdiet. Donec vehicula vel purus et malesuada. Proin nunc quam, dictum ut elit ac, porttitor pretium elit.

Donec sit amet ultricies risus, eget molestie enim. Sed sodales purus at enim imperdiet porta. Aliquam efficitur nunc ut elit auctor tincidunt in quis urna. Nullam pretium eget quam et mollis. Integer posuere est non nulla tempor, in tristique nisi tempus. Duis sagittis metus quis nibh posuere convallis. Nunc eu dolor quis tortor pulvinar volutpat ac in felis. Nulla interdum est dolor, et imperdiet massa viverra ac. Nam eu luctus augue. Proin facilisis ornare mi vitae pulvinar. Ut rhoncus vitae sapien sed consectetur.

Curabitur eget purus molestie est fringilla imperdiet. Etiam id velit vel leo porttitor rhoncus. Nullam tempus placerat metus quis rutrum. Mauris efficitur nisi eleifend elit mollis tristique. Curabitur condimentum turpis id fermentum semper. Mauris vitae neque at erat dictum ultricies. Nam posuere ante sed nisi suscipit, vel euismod est dictum. Nullam ornare felis vitae arcu porta, ut egestas ipsum suscipit. Donec maximus urna auctor, vehicula lacus id, faucibus neque. Proin rhoncus vel mauris eget commodo. Mauris suscipit, magna at porttitor efficitur, leo justo porttitor neque, sed venenatis lacus urna sed felis.

Cras feugiat odio elit, et mollis lorem dignissim at. Nulla pretium sollicitudin blandit. Nullam ut dolor id tellus aliquet tincidunt a ac ante. Praesent ornare consectetur ipsum, quis imperdiet nisl fringilla facilisis. Nullam vel laoreet urna. Maecenas laoreet interdum leo, sed placerat nisl ornare id. Morbi pharetra urna pretium, dapibus metus at, auctor felis. Phasellus quis lacinia tortor.

Cras feugiat magna urna, nec tempor magna luctus vel. Suspendisse quis rutrum diam. Phasellus lacinia quam ut gravida volutpat. Aliquam erat volutpat. Interdum et malesuada fames ac ante ipsum primis in faucibus. Nullam id sem ac metus sagittis vulputate non at quam. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut lobortis nibh vel eros bibendum tristique interdum nec nulla.
20 changes: 20 additions & 0 deletions _posts/blog/2016-05-05-second-post.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: post
title: "Second blog post"
headline: "Checkout this super blog post also..."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't commit this, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just for tests - What I would suggest is to set hidden: true. It won't appear in the website and not in the RSS feed, and it would still be there as an example.

categories: blog
hidden: false
author: mathieu_carbou
tags: [ehcache, website]
comments: true
date: 2016-05-05T00:00:00-`05:00
modified:
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent et purus at quam ullamcorper volutpat. Nullam ut nunc at sem tincidunt elementum vel et sem. Nam a nisl nec nisi tincidunt interdum in vel nulla. Maecenas ac elit vel felis pellentesque feugiat ut in quam. Quisque in dapibus enim, dapibus ultricies erat. Vivamus tristique varius magna at tincidunt. Ut venenatis dolor neque. Morbi pretium diam sed nulla consectetur maximus. Etiam sem turpis, ullamcorper sed arcu et, consectetur euismod est. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Mauris pharetra lorem ante, at suscipit urna bibendum ut. In a condimentum turpis. Pellentesque fermentum ex eget venenatis imperdiet. Donec vehicula vel purus et malesuada. Proin nunc quam, dictum ut elit ac, porttitor pretium elit.

Donec sit amet ultricies risus, eget molestie enim. Sed sodales purus at enim imperdiet porta. Aliquam efficitur nunc ut elit auctor tincidunt in quis urna. Nullam pretium eget quam et mollis. Integer posuere est non nulla tempor, in tristique nisi tempus. Duis sagittis metus quis nibh posuere convallis. Nunc eu dolor quis tortor pulvinar volutpat ac in felis. Nulla interdum est dolor, et imperdiet massa viverra ac. Nam eu luctus augue. Proin facilisis ornare mi vitae pulvinar. Ut rhoncus vitae sapien sed consectetur.

Curabitur eget purus molestie est fringilla imperdiet. Etiam id velit vel leo porttitor rhoncus. Nullam tempus placerat metus quis rutrum. Mauris efficitur nisi eleifend elit mollis tristique. Curabitur condimentum turpis id fermentum semper. Mauris vitae neque at erat dictum ultricies. Nam posuere ante sed nisi suscipit, vel euismod est dictum. Nullam ornare felis vitae arcu porta, ut egestas ipsum suscipit. Donec maximus urna auctor, vehicula lacus id, faucibus neque. Proin rhoncus vel mauris eget commodo. Mauris suscipit, magna at porttitor efficitur, leo justo porttitor neque, sed venenatis lacus urna sed felis.

Cras feugiat odio elit, et mollis lorem dignissim at. Nulla pretium sollicitudin blandit. Nullam ut dolor id tellus aliquet tincidunt a ac ante. Praesent ornare consectetur ipsum, quis imperdiet nisl fringilla facilisis. Nullam vel laoreet urna. Maecenas laoreet interdum leo, sed placerat nisl ornare id. Morbi pharetra urna pretium, dapibus metus at, auctor felis. Phasellus quis lacinia tortor.
Loading