Split "setting up development" into a separate guide #3293
Conversation
In order to support making it easier to reference this block of instructions and to make it easier for them to follow (part of #3251)
- Move the vagrant section to the top, as it's an alternative to installing a bunch of dependencies. - Move github OAuth into a configuration section further on, because you don't need it to run the app. - Make the `bin/setup` script its own section, because it's an important step to get the app running.
For now, link to it above the section about git workflow, since the TOC just shows the current structure of CONTRIBUTING.md.
|
|
||
| - Node.js | ||
|
|
||
| To install Ruby, check out [RVM](https://rvm.io), [rbenv](https://github.com/sstephenson/rbenv) or [ruby-install](https://github.com/postmodern/ruby-install). |
There was a problem hiding this comment.
Perhaps you could link directly to the installation documentation pages? For example, for RVM you could refer to https://rvm.io/rvm/install.
|
|
||
| To install Ruby, check out [RVM](https://rvm.io), [rbenv](https://github.com/sstephenson/rbenv) or [ruby-install](https://github.com/postmodern/ruby-install). | ||
|
|
||
| PostgreSQL can be installed with [Homebrew](http://brew.sh) on Mac OS X: `brew install postgresql` |
There was a problem hiding this comment.
Two small things:
- Perhaps you could make it a bulleted list, with an entry for each platform.
- I'd like to see a link to a Windows installation too.
| * Fetch the seed data: `rake db:seeds:fetch` | ||
| * Seed the database: `rake db:seed` | ||
|
|
||
| If you are having 'PG::Connection ...' or 'Peer authentication failed for user ...' issues you can follow these steps (this is assuming that you modified the database.yml file and your changes are not being accessed properly. Anywhere that it is stated "PGUSER=postgres" replace "postgres" with your specified username that you use for your postgresql databases): |
There was a problem hiding this comment.
I would put the error messages in backticks, to make them standout.
|
I'm stoked to see this change—the Contributing Guide has been an overwhelming wall of text and this definitely helps. |
- Use backticks for commands - Split into subsections
|
Thanks for the review @ErikSchierboom. I've added a few more commits implementing your suggestions. I've linked to https://www.postgresql.org/download/windows/ which has installers for windows (I haven't tried these myself but it seems like the obvious way to do it). For everything else we're already linking out to instructions that cover multiple platforms so I don't think I can improve on that. I also split up the troubleshooting section a bit more. I think it's still a bit confusing which |
|
Great, LGTM! |
|
Thank you, @MatMoore! |
Move this from
CONTRIBUTING.mdtodocs/setting-up-development.md, so that it'seasier to understand and link to.
I've also reordered some of the sections in it to make it easier to get to the point where you have the app running.
See issue #3251