Add FAQ and how-to sections.

pallet · Jan 22, 2012 · 499ccbd · 499ccbd
1 parent f0bb153
commit 499ccbd
Show file tree

Hide file tree

Showing 14 changed files with 258 additions and 28 deletions.
diff --git a/2012/new-site/index.html b/2012/new-site/index.html
@@ -0,0 +1,4 @@
+---
+layout: redirect
+target: /news/new-site/
+---
diff --git a/2012/pallet-training-early-bird/index.html b/2012/pallet-training-early-bird/index.html
@@ -0,0 +1,5 @@
+---
+layout: redirect
+target: /news/pallet-training-early-bird/ 
+---
+
diff --git a/2012/track-doc-changes/index.html b/2012/track-doc-changes/index.html
@@ -0,0 +1,4 @@
+---
+layout: redirect
+target: /doc/changes/track-doc-changes/
+---
diff --git a/_config.yml b/_config.yml
@@ -1,7 +1,7 @@
 # Jekyll
-permalink: /:year/:title/
+permalink: /:categories/:title/
 exclude: 
-name: Pallet, Devops for the JVM
+name: Pallet, DevOps for the JVM
 pygments: true
 domain: palletops.com
 navigation:

diff --git a/_includes/site-entry.xml b/_includes/site-entry.xml
@@ -0,0 +1,12 @@
+  {% for page in pages %}
+  <url>
+    <loc>http://{{ site.domain }}/{{ page.url }}</loc>
+    {% if page.last_updated %}
+    <lastmod>{{ page.last_updated | date: "%Y-%m-%d" }}</lastmod>
+    {% elsif page.date %}
+    <lastmod>{{ page.date | date: "%Y-%m-%d" }}</lastmod>
+    {% else %}
+    <lastmod>{{ site.time | date: "%Y-%m-%d" }}</lastmod>
+    {% endif %}
+  </url>
+  {% endfor %}
diff --git a/_layouts/redirect.html b/_layouts/redirect.html
@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<title>This page has moved! | Pallet, DevOps for the JVM</title>
+<meta http-equiv="REFRESH" content="1;url={{ page.target }}">
+<META HTTP-EQUIV="CACHE-CONTROL" CONTENT="NO-CACHE">
+</HEAD>
+<BODY>
+<p>
+This page has moved. 
+</p>
+
+<p>
+You will be redirected shortly. If you have not been redirected in a
+few seconds, click <a href="{{ page.target }}">here</a>.
+</BODY>
+</HTML>
diff --git a/doc/changes/_posts/2012-01-21-logging-setup-updated.md b/doc/changes/_posts/2012-01-21-logging-setup-updated.md
@@ -0,0 +1,16 @@
+---
+layout: news
+title: Logging section updated for SLF4J
+section: documentation
+---
+
+We have updated the
+[Logging](http://palletops.com/doc/reference/logging/) section in the
+[Reference Documentation](http://palletops.com/doc/reference/logging)
+to reflect the fact that Pallet has its logging subsystem from using
+[log4j](http://logging.apache.org/log4j/1.2/) to using
+[SLF4J](http://www.slf4j.org/). This move allows the configuration of
+many different logging subsystems. By default, the logging library
+used is now [logback](http://http://logback.qos.ch/). 
+
+[Read the full article here.](http://palletops.com/doc/reference/logging/)
diff --git a/doc/changes/_posts/2012-01-22-added-faq-and-how-to-sections.md b/doc/changes/_posts/2012-01-22-added-faq-and-how-to-sections.md
@@ -0,0 +1,13 @@
+---
+layout: news
+title: Added FAQ and How-To sections
+section: documentation
+---
+
+We have just added two more documentation sections:
+[FAQ](http://palletops.com/doc/faq) and
+[how-tos](http://palletops.com/doc/how-tos). These sections also have
+their own RSS feeds if you want to keep track of changes in these
+sections.
+
+These sections are currently empty, and content is coming soon.
diff --git a/doc/faq/atom.xml b/doc/faq/atom.xml
@@ -0,0 +1,28 @@
+---
+layout: nil
+---
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+ <title>Pallet, DevOps for the JVM -- FAQ</title>
+ <link href="http://palletops.com/doc/faq/atom.xml" rel="self"/>
+ <link href="http://palletops.com/doc/faq"/>
+ <updated>{{ site.time | date_to_xmlschema }}</updated>
+ <id>http://{{ site.domain }}/doc/faq</id>
+ <author>
+   <name>Antoni Batchelli</name>
+   <email>tbatchelli@palletops.com</email>
+ </author>
+ {% for post in site.categories.faq limit:100 %}
+ <entry>
+   <title>{{ post.title }}</title>
+   <link href="http://palletops.com/{{ post.url }}"/>
+   <updated>{{ post.date | date_to_xmlschema }}</updated>
+   <id>http://{{ site.domain }}/{{ post.url }}</id>
+   <content type="html">{{ post.content | xml_escape }}</content>
+   <author>
+     <name>{{ post.author }}</name>
+     <uri>{{ post.author_url }}</uri>
+   </author>
+ </entry>
+ {% endfor %}
+</feed>
diff --git a/doc/faq/index.html b/doc/faq/index.html
@@ -0,0 +1,45 @@
+---
+layout: nil
+title: FAQ
+section: documentation
+---
+<!doctype html>
+<html lang="en">
+  {% assign atom = true %}
+  {% include head.html %}
+  <body>
+    {% include topbar.html %}
+    <div class="post">
+      <div class="container">
+        <div class="row">
+          <div class="span11 content">
+            <div class="page-header">
+              <h1 class="title"> {{ page.title }} </h1>
+            </div>
+
+            {% for post in site.categories.faq %}
+            <ul>
+              <li><a href="#{{forloop.index}}"> {{ post.title }} </a></li>
+            </ul>
+            {% endfor %}
+
+            {% for post in site.categories.faq %}
+            <h2><a name="{{ forloop.index }}"/>
+              <a href="{{ post.url }}">
+                {{ post.title }}</a></h2>
+            {{ post.content }}
+            {% endfor %}
+
+          </div>
+          <div class="span5 sidebar">
+            <br>
+            <br>
+            <br>
+            {% include training-cw-2012-blog.html %}
+            {% include twitter-widget.html %}
+          </div>
+        </div> <!-- row -->
+      </div> <!-- container -->   
+      {% include foot.html %}
+  </body>
+</html>
diff --git a/doc/how-tos/atom.xml b/doc/how-tos/atom.xml
@@ -0,0 +1,28 @@
+---
+layout: nil
+---
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+ <title>Pallet, DevOps for the JVM -- How-tos</title>
+ <link href="http://palletops.com/doc/how-tos/atom.xml" rel="self"/>
+ <link href="http://palletops.com/doc/how-tos"/>
+ <updated>{{ site.time | date_to_xmlschema }}</updated>
+ <id>http://{{ site.domain }}/doc/how-tos</id>
+ <author>
+   <name>Antoni Batchelli</name>
+   <email>tbatchelli@palletops.com</email>
+ </author>
+ {% for post in site.categories.how-tos limit:100 %}
+ <entry>
+   <title>{{ post.title }}</title>
+   <link href="http://palletops.com/{{ post.url }}"/>
+   <updated>{{ post.date | date_to_xmlschema }}</updated>
+   <id>http://{{ site.domain }}/{{ post.url }}</id>
+   <content type="html">{{ post.content | xml_escape }}</content>
+   <author>
+     <name>{{ post.author }}</name>
+     <uri>{{ post.author_url }}</uri>
+   </author>
+ </entry>
+ {% endfor %}
+</feed>
diff --git a/doc/how-tos/index.html b/doc/how-tos/index.html
@@ -0,0 +1,52 @@
+---
+layout: nil
+title: How-tos
+section: documentation
+---
+<!doctype html>
+<html lang="en">
+  {% assign atom = true %}
+  {% include head.html %}
+  <body>
+    {% include topbar.html %}
+    <div class="post">
+      <div class="container">
+        <div class="row">
+          <div class="span11 content">
+            <div class="page-header">
+              <h1 class="title">
+                {{ page.title }}
+              </h1>
+            </div>
+
+            {% for post in site.categories.how-tos offset: 0 limit: 150 %}
+            <!-- include news_summary.html -->
+            <div class="row">
+              <div class="span11 post_content">  
+                <h2><a href="{{ post.url }}">{{ post.title }}</a></h2>
+                <p class="date"><small>{{ post.date | date: "%A, %d %B %Y"}}</small></p>
+                <p>{% if post.summary %}
+                  {{post.summary}}
+                   {% else %}
+                  {{ post.content | strip_html | truncatewords: 50 }}
+                   {% endif %}</p>
+                <p><a class="pull-right" href="{{ post.url }}">
+                    Read the full article &rarr;</a>
+                </p>
+              </div>
+            </div>
+            {% endfor %}
+
+           </div>
+          <div class="span5 sidebar">
+            <br>
+            <br>
+            <br>
+            {% include training-cw-2012-blog.html %}
+            {% include twitter-widget.html %}
+          </div>
+        </div> <!-- row -->
+      </div> <!-- container -->   
+      {% include foot.html %}
+  </body>
+</html>
diff --git a/doc/index.md b/doc/index.md
@@ -15,6 +15,22 @@ designed to make small to midsize deployments simple.
 
 ## [Latest Documentation Changes](/doc/changes) <small><a href="/doc/changes/atom.xml">RSS</a></small>
 {% for post in site.categories.changes limit:5 %}
-- [{{post.date | date_to_string }} &raquo; {{post.title}}]({{post.url}})
+- {{post.date | date_to_string }} &raquo; [{{post.title}}]({{post.url}})
 {% endfor %}
+<p><a class="pull-right" href="/doc/changes"> See all the changes &rarr;</a></p>
+<br>
+
+## [Latest How-Tos Entries](/doc/how-tos) <small><a href="/doc/how-tos/atom.xml">RSS</a></small>
+{% for post in site.categories.how-tos limit:5 %}
+- {{post.date | date_to_string }} &raquo; [{{post.title}}]({{post.url}})
+{% endfor %}
+<p><a class="pull-right" href="/doc/how-tos"> See all the how-tos &rarr;</a></p>
+<br>
+
+## [Latest FAQ Entries](/doc/faq) <small><a href="/doc/faq/atom.xml">RSS</a></small>
+{% for post in site.categories.faq limit:5 %}
+- {{post.date | date_to_string }} &raquo; [{{post.title}}]({{post.url}})
+{% endfor %}
+<p><a class="pull-right" href="/doc/faq"> See all the FAQs &rarr;</a></p>
+<br>  
 
diff --git a/sitemap.xml b/sitemap.xml
@@ -12,33 +12,23 @@ layout: nil
 		<priority>1.0</priority>
   </url>
 
-  {% for page in site.categories.blog %}
-  <url>
-    <loc>http://{{ site.domain }}/{{ page.url }}</loc>
-    {% if page.last_updated %}
-    <lastmod>{{ page.last_updated | date: "%Y-%m-%d" }}</lastmod>
-    {% elsif page.date %}
-    <lastmod>{{ page.date | date: "%Y-%m-%d" }}</lastmod>
-    {% else %}
-    <lastmod>{{ site.time | date: "%Y-%m-%d" }}</lastmod>
-    {% endif %}
-  </url>
-  {% endfor %}
+  <!-- Blog entries -->
+  {% assign pages = site.categories.blog %}
+  {% include site-entry.xml %}
+
 
   <!-- documentation -->
-  {% for page in site.categories.doc %}
-  <url>
-    <loc>http://{{ site.domain }}/{{ page.url }}</loc>
-    {% if page.last_updated %}
-    <lastmod>{{ page.last_updated | date: "%Y-%m-%d" }}</lastmod>
-    {% elsif page.date %}
-    <lastmod>{{ page.date | date: "%Y-%m-%d" }}</lastmod>
-    {% else %}
-    <lastmod>{{ site.time | date: "%Y-%m-%d" }}</lastmod>
-    {% endif %}
-  </url>
-  {% endfor %}
-
+  {% assign pages = site.categories.doc %}
+  {% include site-entry.xml %}
+
+  <!-- FAQs -->
+  {% assign pages = site.categories.faq %}
+  {% include site-entry.xml %}
+
+  <!-- how tos -->
+  {% assign pages = site.categories.how-tos %}
+  {% include site-entry.xml %}
+
   <!-- html pages -->
   {% for page in site.html_pages %}
   <url>