Update development instructions regarding figaro#60
Conversation
README.md
Outdated
| Or for more information about using figaro, see https://github.com/laserlemon/figaro | ||
| Update `config/application.yml`, setting the `github_client_id` and `github_client_secret` variables generated for your GitHub OAuth Application | ||
|
|
||
| The environment variables are managed using [figaro][]. |
There was a problem hiding this comment.
Mind using an inline link here? I find non-inline ones a pain to "track down".
README.md
Outdated
| Register a [new GitHub OAuth application](https://github.com/settings/applications/new) with the Authorization callback URL pointing to `http://localhost:3000/users/auth/github/callback`. | ||
|
|
||
| Or for more information about using figaro, see https://github.com/laserlemon/figaro | ||
| Update `config/application.yml`, setting the `github_client_id` and `github_client_secret` variables generated for your GitHub OAuth Application |
There was a problem hiding this comment.
Trailing . would be good. Also might want to be a little more forceful; this sounds like an instruction but maybe not a requirement. Would be good to have a you will need to... somewhere in the ### Environment variables section.
There was a problem hiding this comment.
Anything in the setup which isn't marked optional reads as mandatory to me. Extra words just make it harder to scan. I'll have a second go at it.
There was a problem hiding this comment.
I've taken another stab at the rewrite.
If you don't have the correct Ruby version installed, per the
.ruby-version file, then `bundle exec figaro install` will
blow up with a _version not installed_ error.
If you take off the bundle exec, then it tries to run figaro,
which you may not have at this point.
We could update the instructions to say
gem install figaro && figaro install
however that will generate a config/application.yml with
commented out environment variables in it, none of which we need.
There is a config/application.example.yml file which lists the
variables that we do need.
To bypass all the potential errors of trying to work with a gem
before running bootstrap and setup, this instructs people to
copy the example yaml and fill it out according to the tokens
generated for the oauth app.
We're telling people to create a GitHub OAuth application that points to their app, but we've not said anything about what URL to put there. I'm assuming that this URL is used for the redirect after logging in and authorizing the application, in which case the localhost:3000 is fine as a default. If we need to process web hooks, then we will have to instruct people to set up ngrok or localtunnel.
|
OK, I'm still not sure about this. I moved the "Getting Started" heading above "Environment Variables" so that it's clear that this is part of getting started. Then I tweaked the wording a little to make it a little bit more to the point and scannable. |
|
This is great thanks @kytrinyx 👏 |
2 participants
If you don't have the correct Ruby version installed, per the
.ruby-version file, then
bundle exec figaro installwillblow up with a version not installed error.
If you take off the bundle exec, then it tries to run figaro,
which you may not have at this point.
We could update the instructions to say
however that will generate a config/application.yml with
commented out environment variables in it, none of which we need.
There is a config/application.example.yml file which lists the
variables that we do need.
To bypass all the potential errors of trying to work with a gem
before running bootstrap and setup, this instructs people to
copy the example yaml and fill it out according to the tokens
generated for the oauth app.
This also is explicit about what URL to configure for OAuth.
We're telling people to create a GitHub OAuth application that points to their app, but
we've not said anything about what URL to put there.
I'm assuming that this URL is used for the redirect after logging in and authorizing the application,
in which case the localhost:3000 is fine as a default.
If we need to process web hooks, then we will have to instruct people to set up ngrok or localtunnel.
These instructions were previously updated in #24