docs: update quickstart guide #263
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/quickstart.md
Outdated
|
|
||
| Notes: | ||
|
|
||
| - Start by copying `env.okta.example` to `env` (`cp env.okta.example env`) |
Contributor
There was a problem hiding this comment.
Having this env.okta.example file to copy seems like a good idea! Should we suggest to copy & edit this file instead of
Create a new file called 'env' with those values, like so:
on line 75? (same for the Google steps above)
(As I read it myself, I feel like some people will only see this point after already creating the file and inputting some stuff) I like the new layout here though!
Contributor
Author
There was a problem hiding this comment.
Yeah, this was a bit awkward. I've updated, lemme know what you think now!
Contributor
|
Thanks @mccutchen -- couple small comments, but this looks great! |
Codecov Report
@@ Coverage Diff @@
## master #263 +/- ##
=======================================
Coverage 62.14% 62.14%
=======================================
Files 53 53
Lines 4169 4169
=======================================
Hits 2591 2591
Misses 1391 1391
Partials 187 187 |
Jusshersmith
approved these changes
Oct 28, 2019
Contributor
Jusshersmith
left a comment
There was a problem hiding this comment.
Perfect! Thanks @mccutchen
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
In the course of working on #262, I found a couple of small issues with the quickstart guide: the quickstart-specific suggested OAuth callback URLs in the google & okta provider setup docs were incomplete.
Solution
FIrst, fix the suggested URLs. I also made a few more invasive/opinionated wording/structure changes to the quickstart guide itself, if these changes do not seem like an improvement to y'all I will revert them!