Creating posts on openseattle.org

The Open Seattle website is hosted on GitHub pages and uses Jekyll, a static site generator.

You can create a post on openseattle.org in two ways:

  • through GitHub.com
  • on your computer using git

To get started, you’ll need to fork the website repository on GitHub.

Forking openseattle.github.io

Go to github.com/openseattle/openseattle.github.io and click the “Fork” button.

Making changes on GitHub.com

Now that you’ve forked the repository, you can make the necessary changes in your fork. After you’ve made the changes you will submit those changes as a pull request to the original repository.

Make changes to the files

You can add/edit/rename/move/delete files all through the github web interface.

For detailed guides to manipulating files through GitHub.com, go here: help.github.com/categories/manipulating-files

To create a post you will navigate to the _posts folder and click the plus symbol + above the list of files.

The post must be named using a pattern like this:

2014-11-24-title-of-post.md

The date and title must be all lowercase and separated with dashes.

Post metadata

Next, because we’re using Jekyll, you’ll place YAML frontmatter in the first lines of the post.

This is a good template for the YAML frontmatter:

---
title: "Art + Civics + Code roundup"
description: "All the things related to Art + Civics + Code"
published: false
layout: page
---

Make sure to set published to true when you’re ready to make the post go live.

Take a look at this post as an example.

Markdown

Posts are written using markdown. For a nice guide to markdown formatting take a look at this: help.github.com/articles/markdown-basics

Commit your changes

After you’ve made all the necessary changes, go to the bottom of the page, add a commit message that describe your changes, then save your changes by clicking the “Commit new file” button (or the “Commit changes” button if your editing an existing file).

Submit a pull request

After committing your changes, click the Pull Requests tab on the right side of the page.

On some pages it’s collapsed, so all you’ll see is the little icon.

Click ‘New Pull Request’

Make sure to create a pull request to submit the changes in your repository to the openseattle/openseattle.github.io repository.


Making changes on your computer using git

These steps are very similar to the steps above. The only difference is that you’ll be creating/editing files on your computer, committing the changes and pushing your work to your fork of the repository. Then you’ll submit a pull request like described above.