Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 2.75 KB

README.md

File metadata and controls

71 lines (55 loc) · 2.75 KB
Raw

Finagle blog Build Status

This project uses Middleman to generate the blog for the Finagle project. If you'd like to contribute a guest post about how you're using Finagle, you can get in touch through our Twitter account, or you can fork this repository and submit a pull request for us to review.

Setup

Once you've forked the repository, run the following command to grab the project's dependencies:

gem install bundler
bundle install

Note that you'll need to have Ruby and RubyGems installed first.

Generating the site

Now you can run bundle exec rake dev and open a browser window to http://localhost:4567/ to see your local build of the site. Any changes you make to the sources directory will be reflected more or less immediately, and errors will be shown in the console you launched rake dev in.

Writing a post

Since the blog content is published in the master branch of this GitHub repository, the source lives in a separate branch, appropriately named source. It's a good idea to start your work on a new blog post by creating a fresh branch off of source.

Posts live in the source/blog/ directory and are written in Markdown. You should create a file with a name formatted like 2014-08-14-short-title.md, and the file should have a header like the following:

---
layout: post
title: My new Finagle blog post
published: true
post_author:
  display_name: Travis Brown
  twitter: travisbrown
tags: Finagle, Util
---

Once you've written your post, push your commits to your fork and file a pull request. We'll review your post and will get back to you as soon as we can if we have changes to suggest, etc. Please let us know if you have any questions!

Deploying the site

Once you merged you new blog post into the source branch, it's time to get that deployed on Github Pages by running bundle exec middleman deploy against the source branch.

Licensing

Unless otherwise noted, all content published on this blog is released under the Creative Commons Attribution 3.0 Unported License (CC BY). The site generation code (and any code in posts) is available under the Apache License, Version 2.0. By submitting a pull request, you affirm that the content is your original work and that you agree to have it published under these licenses.