Skip to content

Latest commit

 

History

History
63 lines (36 loc) · 2.49 KB

README.md

File metadata and controls

63 lines (36 loc) · 2.49 KB

Unruly Tech

Build Status

Unruly's Tech site.

This project has been archived. We've moved over to Medium.

Contributing

Adding and Changing Existing Content

Blog Posts

You can add and edit blog posts by going to the blog folder and editing the markdown files there. This can all be done via GitHub's interface so you don't need to have a complete local environment set up.

Frontmatter

All posts have frontmatter which declare variables like the title, tags and author of the post. For now you can see existing posts to figure out what's available.

Featured Sections and other text

Most text can be found either in the data folder or if it's dynamic, in the Javascript data folder. This can all be done via GitHub's interface so you don't need to have a complete local environment set up. You can make changes via GitHub's interface so you don't need to have a complete local environment set up.

Installation

The website is built using Middleman which is written in Ruby so it's suggested you read up on both before making changes beyond that of adding and editing content.

Install dependencies:

gem install bundler
bundle install

Pulling Changes

As multiple contributors may be making changes to files at the same time, it's suggested you merge using git pull rather than rebase and resolve any conflicts before pushing changes. This is so that your local commits don't overwrite any pushed changes.

If you do rebase then always go through your local commits and changes before you push them as they may overwrite pushed changes.

Using Middleman

See Middleman's Docs

bundle exec middleman         # Runs a local server for testing with livereload
bundle exec middleman build   # Builds the static website

Deploying

Travis is already set up to deploy pushes automatically on successful builds so ideally you should not need to deploy manually from a local machine. If you need to deploy a previous build, Travis lets you. Just pick a build in Travis' web interface and re-run it.

If you really need to deploy from a local machine, you can run:

bundle exec rake test deploy

License

Copyright (c) 2015 Unruly