Revisions and Updates for Readme #490
Conversation
mrfantasticwonders
requested review from
ElliottAYoung,
MKwenhua,
arelia and
toastercup
README.md
Outdated
| For a rudimentary setup, these variables should be configured: | ||
|
|
||
| * Use `$ rake secret` to generate `APP_SECRET` and `DEVISE_SECRET` | ||
| * Use `$ bundle rails secret` to generate `APP_SECRET` and `DEVISE_SECRET` |
There was a problem hiding this comment.
This should become bundle exec rails secret
README.md
Outdated
|
|
||
| * Use `$ rake secret` to generate `APP_SECRET` and `DEVISE_SECRET` | ||
| * Use `$ bundle rails secret` to generate `APP_SECRET` and `DEVISE_SECRET` | ||
| * To generate the two tokens for `APP_SECRET` and `DEVISE_SECRET`, simply run the above formula twice |
There was a problem hiding this comment.
I'd suggest merging this line with the line above - I think it could read like:
- Execute
$ bundle exec rails secrettwice to generate both anAPP_SECRETand aDEVISE_SECRET
README.md
Outdated
|
|
||
| ## Troubleshooting | ||
| * Ensure you have read / write access to your project directory during installation. | ||
| * Run `npm -v` to make sure node is properly linked. If the command is not found, chances are the correct version of node is not linked. Run `brew link node`. |
There was a problem hiding this comment.
I'd add a note that this is only relevant for OS X. Also, I'd suggest a more accurate way to check that node is linked is to run which node, and ensure its path matches Homebrew's default installation path
There was a problem hiding this comment.
Definitely will add the note about OS X. I'm thinking adding your last point as a second point (the more accurate point) and the comment about running npm -v as a third point as another trick in finding out if node is linked correctly.
Running brew link node will also alert you of any folders / files on the computer (not related to version installed by homebrew) that might be conflicting with your install.
…undle exec rails'
|
Current Tasks
|
…garding generating secret keys twice in environment section
|
@arelia to review. |
|
@mrfantasticwonders et al, mind if I take till the end of the week to try these steps on my personal computer and then give feedback? |
toastercup
dismissed
ElliottAYoung’s stale review
Change request has been addressed by David
Purpose:
Some good feedback for Cortex's
README.mdto address some recent changes to Cortex and to add advice.$ rake secretto$ bundle rails secretJIRA:
N/A
Steps to Take On Prod
N/A
Changes:
Changes to setup
Architectural changes
Migrations
Library changes
Side effects
Screenshots
N/A
N/A
QA Links:
N/A
How to Verify These Changes
Specific pages to visit
Steps to take
Responsive considerations
Relevant PRs/Dependencies:
N/A
Additional Information
N/A