Skip to content

Home

Jump to bottom
Aaron Morton edited this page Feb 9, 2016 · 5 revisions

The Last Pickle Website Wiki

The public web site is a jekyll blog stored in the thelastpickle.github.io git hub project.

Information about creating content is provided below, check the tlpway for publishing workflow, writing guides etc.

Getting Help

The jekyll website has great documentation.

Creating Content

Blog Drafts

Create drafts in the _/drafts folder using the name format the-post-title.md when using markdown.

Drafts are not included when the site is built, to include them run jekyll serve --drafts or jekyll build --drafts.

See Working With Drafts for more information.

Blog Posts

Blog posts are created in the _/posts folder using the name form YEAR-MONTH-DAY-title.md when using markdown. For example 2011-12-31-new-years-eve-is-awesome.md. Note: The format of the name is important as jekyll extracts the post date from the name.

Front Matter

All files that have YAML Front Matter will be parsed by the engine. Typically we want to include the following variables at a minimum:

---
layout: post
title: "Deletes and Tombstones"
category: Cassandra
tags: list, of, tags
---

Where:

  • layout tells jekyll which template in the _layouts folder to use.
  • title is the title of the page and made available as the page.title variable in the tempalte.
  • category tells the site where the page should exist, see below.
  • tags is a list of tags, we don't use them for much yet but please tag Cassandra centric tags with "cassandra".

See Writing Posts for more information.

Categories

We use categories to drive the site layout:

  • blog category pages are placed in /blog/ in the site.
  • speaking category pages are placed in /speaking/ in the site and included in the Speaking index.

All posts in _posts\ in the repo are included in the blog index.

Static Pages

Place a markdown file in the root directory, or any top level directory that does not start with _. It will be processed by the jekyll engine if the file contains the YAML Front Matter. We will normally want to use a different layout for static pages.

Alternatively a static HTML file may be placed in the same locations.

Work Flow

We have two workflows.

Collaborative Workflow

Use the Collaborative Workflow when you have a post that is being worked on for a long time potentially by more than one person.

  1. Create the post in _drafts/ (above) and merge into the master branch, you can do this without getting someone else to complete the pull request.
  2. Let others know.
  3. Accept pull requests into the draft post.
  4. Move the post into _posts/ and set the date in the file name (above)

The collaborative workflow can be used to stub out ideas for a post.

Quick Workflow

Use the quick workflow when you have written a complete post and are just looking for edits.

  1. Create the posts in the _posts/ folder in your own fork / branch.
  2. Submit a pull request to the master branch.
  3. Make edits as post of the merge process.
  4. Merge the pull request in the master branch, but sure to check the date in the file name.

Clone this wiki locally