mendicant-original / community

Mendicant University's community website
community.mendicantuniversity.org
20 stars 10 forks source link

minor clarification to setup instructions in README #63

Open ericgj opened 12 years ago

ericgj commented 12 years ago

To make it clear you run bundle exec rake setup a second time after editing your database.yml.

(Sorry for not filing a ticket before submitting this, but I thought it was pretty much a no-brainer).

jordanbyron commented 12 years ago

Do we really need this? I thought the output from rake setup was clear in stating that once the user is done editing the database.yml file, they need to run rake setup to resume. See: https://github.com/mendicant-university/community/blob/master/lib/tasks/setup.rake#L105

I bet that line gets lost because I display the full path name for the file. Maybe breaking the "Then to resume, run ..." instructions to a new line would make that clearer?

ericgj commented 12 years ago

Yeah, it's clear enough when you run it. It's just that editing of the database.yml (and any things you might need to do in postgres such as setting up an owner/password for the dbase and making sure the server is running) isn't a minor step, and when I'm looking at all the setup steps together, it's helpful to be reminded of that part of it.

practicingruby commented 12 years ago

@ericgj: Those things are true if you don't have a working postgres installation already set up, but typically postgres should start at boot and be configured in a way that doesn't require you to run any postgresql related commands to make use of a setup script like this. Linking to a general tutorial on how to setup postgresql properly for use with Rails would probably be worthwhile (especially since we want to make it as easy as possible for less experienced folks to contribute), but giving specific reminders about making sure your server is running seems redundant.

ericgj commented 12 years ago

Will look for such a tutorial to link to - I think that would be helpful to have.

I understand about not giving every last step in the README. My main point isn't so much about configuring postgres, it's that you do actually have to edit the database.yml and then re-run the rake setup, and it would be helpful to get a heads-up about that in the instructions. So even if it said

5. Run `bundle exec rake setup` to create the required config files
6. Edit `config/database.yml` 
7. Finally, run `bundle exec rake setup` again to create the database, and seed it with data

(For instructions on setting up postgresql for use with Rails, see tutorial here ... )
practicingruby commented 12 years ago

That seems reasonable. What do you think @jordanbyron?

jordanbyron commented 12 years ago

@ericgj I'd like to keep as much of the "setup" process in rake setup. How about we do something like this:

  1. Amend the following to the line: "Finally, run rake setup and follow the on screen instructions to complete the setup"
  2. Add an install overview to the setup script which gives an overview of the setup process, and requires the user to hit any key to continue.

Then we only have one place were we need to maintain the setup process. Sound good?

ericgj commented 12 years ago

@jordanbyron yes that's a great idea. Should I add to this pull request or a create new one?

jordanbyron commented 12 years ago

Go ahead and use this pull request :tophat: