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

Provide instructions in application.yml that are consistent with readme #126

Closed
anselmbradford opened this issue Feb 17, 2014 · 2 comments
Closed

Comments

@anselmbradford
Copy link
Member

After running script/bootstrap and going to config/application.yml, the file contains the following:

# Add application configuration variables here, as shown below.
#
# PUSHER_APP_ID: "..."
# PUSHER_KEY: ...
# PUSHER_SECRET: ...
# STRIPE_API_KEY: ...
# STRIPE_PUBLIC_KEY: ...

Which appears to indication that the shown environmental variables are used in the project. Instead, perhaps provide language like what is shown in the readme. Something like:

# Set the ADMIN_APP_TOKEN environment variable so that the tests can pass,  
# and so you can run the Ohana API Admin app locally.
#
# ADMIN_APP_TOKEN: your_token
@monfresh
Copy link
Member

application.yml is generated by the figaro gem, and can be used for any environment variable you want to store, not just the default ones used by Ohana. The instructions in application.yml should be kept generic. I'll add a link to figaro in the README and explain what application.yml is for.

@monfresh
Copy link
Member

monfresh commented Jun 5, 2014

We are no longer automatically generating application.yml via the figaro gem. We now have application.example.yml which is better-documented and explained in the installation instructions.

@monfresh monfresh closed this as completed Jun 5, 2014
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

No branches or pull requests

2 participants