18F / development-guide

A set of guidelines and best practices for an awesome software engineering team
https://engineering.18f.gov
Other
1.25k stars 122 forks source link

point to example for Jekyll configuration #224

Closed afeld closed 3 years ago

tbaxter-18f commented 3 years ago

I never thought of using Docker to avoid seemingly inevitable Ruby env issues. Nice addition!

afeld commented 3 years ago

Oh, yeah, it's a game changer.

ryanhofdotgov commented 3 years ago

I think I understand what @tbaxter-18f was getting at by suggesting that the 2nd link be removed, and what @afeld was trying to do by having it duplicated.

A case can also be made that Docker also helps projects be well-documented too, e.g., by documenting via code what ruby version is in use, etc, so it hits all 3 principles we list on the dev env page.

I'd like to merge in this PR and but follow it up immediately with a PR that makes the Docker suggestion more prominent and tightens up the text on this page: https://github.com/18F/development-guide/pull/226