Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor clarification to setup instructions in README #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ericgj
Copy link
Contributor

@ericgj ericgj commented Feb 15, 2012

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
Copy link
Contributor

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
Copy link
Contributor Author

ericgj commented Feb 15, 2012

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
Copy link
Contributor

@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
Copy link
Contributor Author

ericgj commented Feb 16, 2012

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
Copy link
Contributor

That seems reasonable. What do you think @jordanbyron?

@jordanbyron
Copy link
Contributor

@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
Copy link
Contributor Author

ericgj commented Feb 16, 2012

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

@jordanbyron
Copy link
Contributor

Go ahead and use this pull request 🎩

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants