Switch branches/tags
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
bin
data
lib
scripts
source
.gitignore
.ruby-gemset
.ruby-version
Gemfile
Gemfile.lock
Makefile
README.md
config.rb
config.ru

README.md

WWW

Static site content for www.habitat.sh

Setup

  1. Install Ruby 2.3.1 or greater

  2. Install Bundler

    $ gem install bundler
    

How To: Add a Blog Post

  • Create your new blog post in source/blog

    $ touch source/blog/YYYY-MM-DD-your-blog-post-title.html.md
    
  • Open up your blog post

    $ vim source/blog/YYYY-MM-DD-your-blog-post-title.html.md
    
  • And add these headers

    ---
    title: You Blog Post Title
    date: YYYY-MM-DD (make sure this matches the date in the file name!)
    author: FirstName LastName
    tags: related_tags (see other posts for examples)
    category: category of post (see other posts for examples)
    classes: body-article
    ---
    
  • Then add your content below that.

  • After adding your content, save and close the file, then open this file

    $ vim www/data/author_bios.yml
    
  • If your bio is not already there, add it in this format, then save and close the file. Specifically, make the yaml key for your name a lowercased version of your name with all spaces removed.

    nellshamrell-harrington:
      name: "Nell Shamrell-Harrington"
      email: "nshamrell@habitat.sh"
      twitter: "@nellshamrell"
      bio: "Nell Shamrell-Harrington is a Software Development Engineer at Chef and core maintainer of the Habitat and Supermarket open source projects. She also sits on the advisory board for the University of Washington Certificates in Ruby Programming and DevOps. She specializes in Chef, Ruby, Rails, Rust Regular Expressions, and Test Driven Development and has traveled the world speaking on these topics. Prior to entering the world of software development, she studied and worked in the field of theatre."
    
  • Now check out your new post locally by running:

    $ make run
    
  • If all looks good, open up a pull request!

How-To: Serve Docs Locally

  1. Execute the run task to build and start the docs server on your local machine

    make run

  2. The task will contain server output indicating what URL you should load in your browser to preview it

    == View your site at "http://mylaptop.example.com:4567", "http://192.168.1.101:4567"

  3. You can continue to make changes to the documentation files and Middleman will reload them live

  4. Press Ctrl-C to terminate the server when you are finished

How-To: Deploy

  1. Setup your workstation
  2. Configure your environment
  • AWS_BUCKET - for production deploys, this should be habitat-www, for acceptance deploys habitat-www-acceptance
  • AWS_DEFAULT_REGION - this should be us-west-2
  • AWS_ACCESS_KEY_ID - your personal AWS account identifier
  • AWS_SECRET_ACCESS_KEY - your AWS account's personal access key
  • FASTLY_API_KEY - your Fastly account's personal access key
  • FASTLY_SERVICE_KEY - service identifier for www.habitat.sh
$ export AWS_ACCESS_KEY_ID=AKIBJTPWS4EK8L2RXUBZ

Note: values for each of these can be found by logging into your AWS and Fastly control panels. Note: make sure that the AWS credentials you use are for the Habitat AWS account and not the regular Chef AWS account.

  1. Change to the www directory

    $ cd www
    
  2. Run the deploy make task

    $ make deploy