Skip to content
This repository has been archived by the owner on Dec 14, 2023. It is now read-only.

Update README.md install instructions, add Docker support. #183

Merged
merged 2 commits into from
Aug 2, 2017

Conversation

toolness
Copy link
Contributor

This updates the README.md with the following info for normal development flows:

  • Ruby 2.4 doesn't work with this project; apparently one of our dependencies uses a version of the json gem that isn't compatible with 2.4 (see Please release a gem new version for Ruby 2.4 compatibility ruby/json#286 for more details). We could probably fix our Gemfile to make it work with 2.4 somehow, but for now I figured I'd just write a disclaimer to use Ruby 2.3.
  • Node is actually required for jekyll_pages_api_search to work. Fortunately, the site somewhat gracefully degrades to not support search if Node can't be found, rather than crashing.

This PR also adds a Docker setup so that folks who don't want to deal with installing the right version of Ruby and Node can just docker-compose up and go.

@toolness toolness requested a review from tadhg-ohiggins July 14, 2017 22:03
Copy link
Contributor

@tadhg-ohiggins tadhg-ohiggins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for adding this! (Also, sorry for the review delay.)

@tadhg-ohiggins tadhg-ohiggins merged commit 34fa602 into 18f-pages Aug 2, 2017
@nicoleslaw nicoleslaw deleted the docker branch August 15, 2017 18:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants