Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 4.41 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 4.41 KB
Raw

Contributing to devopsdays-web

The technical details on how to set up Hugo (to see your local edits), and prepare a Pull Request for inclusion on the Devopsdays website.

Setup

If you'd like to edit a specific devopsdays event site (and/or contribute code), here's how to get started:

Quick Overview

  1. Install Hugo v0.18+.
  2. Fork this repo.

View site locally

To watch for changes and rebuild on the fly, open a new terminal, change directories to your fork of the repo, and execute the following:

hugo server -w --baseUrl="http://localhost:1313"

If you are running Windows, change the command to

hugo server -w --baseUrl="http://localhost:1313" --config config-windows.toml

Now open baseURL in a browser and navigate to the content that you're editing - voilà!

Pull requests

Process

  1. Make your own fork of the devopsdays-web repository.
  2. Create a new local branch for your changes. This helps to keep things tidy!
$ git checkout -b fix_that_thing

(Replace fix_that_thing with a quick description of your actual change.)

  1. Make your changes, test them locally (see above), then push that branch up to origin on your fork.
$ git push origin fix_that_thing
  1. Submit a Pull Request for the branch you just pushed. Please title the pull request according to the event affected, i.e., [CHI-2017] Add Bluth Company as a sponsor
  2. Take a break - you've earned it!
  3. When a commit is merged to master on GitHub (ideally via a PR reviewed by at least one other person), Netlify (a build tool) will automatically build the site and publish it to http://www.devopsdays.org.

Guidelines

  1. Code changes that affect the overall site will be reviewed only if they are in a separate pull request from any event-specific content. In short, don't add "giant template change" in the same PR as "here are some more sponsors" - if it affects anything other than your event, it should be in its own PR.
  2. We use github issues to track work, so feel free to create new issues if you like (or read/comment on existing ones).
  3. If you are proposing a change that affects the overall site, and is not tied to an existing issue, please open a new issue so that it can be discussed by the team, prior to submitting a pull request.

Advanced

If you are going to be making changes to the overall functionality of the site, please keep the following in mind:

Changes to content should be separate from overall functionality

"Content" means anything inside the /content/..., /data/..., or /static/... directories.

Changes to content should be submitted as a separate PR from changes to site functionality. It would be additionally delightful if you label PR's for site functionality (such as bug or enhancement), but that's not required.

CSS changes are done with LESS

Please do NOT make changes to any of the files in the /themes/devopsdays-responsive/static/css directory. These are files that are compiled via LESS, and while your changes in there might work, they will be blown away by the LESS compiler at some point.

If you want to make changes to CSS, you will need a LESS compiler on your system. @mattstratton uses CodeKit, but that is OS X only, and is not free. Here's a list of other possible LESS compilers (note - Matt has not tested any of these):

The only place to make changes to the LESS files is in /themes/devopsdays-responsive/static/site_variables.less and /themes/devopsdays-responsive/static/site.less. Make sure your LESS compiler is compiling the output into /themes/devopsdays-responsive/static/css/. DO NOT make any changes to any other LESS file (do not directly modify the bootstrap LESS files, for example).

Credits

Thanks to Jess Frazelle @jfrazelle for clueing us into the awesome previews with Netlify!