-
-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Update Test Drive docs with Identity #626
Conversation
Note that PR #52 in netify-cms-www will need to be merged before this PR to ensure proper image display on netlifycms.org. |
docs/test-drive.md
Outdated
|
||
## Authenticate with GitHub | ||
After clicking that button, you’ll authenticate with GitHub and choose a repository name, then Netlify will automatically clone the template and deploy it, bringing you to the site dashboard when the build is complete. Next, you’ll need to set up Netlify's [Identity](https://www.netlify.com/docs/identity) service to authorize users to log in to the CMS. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could be it be clearer that Netlify is creating a new repository (with mirrored content) belonging to the authenticated user?
I followed the test drive guide to the letter and works fine. See one small comment about use of "clone" in a890e0d. Looks good! |
@verythorough great work on this! In the future we need to delineate more clearly between backend/auth options, as it isn't clear between this section and quick start that two different backends are being used, and what the differences are. Besides @eamonnbell's comment, this looks good to me. |
Codecov Report
@@ Coverage Diff @@
## master #626 +/- ##
==========================================
+ Coverage 16.37% 20.12% +3.74%
==========================================
Files 149 152 +3
Lines 3188 3394 +206
==========================================
+ Hits 522 683 +161
- Misses 2666 2711 +45
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM once @eamonbell's comment is addressed. Ran through the test drive and everything worked as described.
@erquhart Yeah, kinda fits with the Identity/GG update plan (#600), as well as the overall docs re-org (#598). @eamonnbell Thanks for checking! I struggled with the description in that paragraph. I wanted to let the user know what's happening, but also didn't want to get too bogged down in the details on something that is supposed to be very simple and require very little of the user. Using "clone" was a cheat to save words, but it could cause more confusion than clarity. lmk what you think of the re-wording. |
I want to have a |
Yeah Jessica if you could dramatically increase our coverage as a part of this docs PR that'd be great |
Addresses part of #600
- Summary
Updates the Test Drive docs to use the updated Kaldi template with Netlify Identity and Git Gateway integrated.
- Test plan
You can check the GitHub rendering at
https://github.com/netlify/netlify-cms/blob/test-drive-identity/docs/test-drive.md
(Note that the links to Intro and Quick Start at the end of the doc will not work in this view, due to issues discussed in #511)
I've also pushed a temporary branch to netlify-cms-www to test rendering on netlifycms.org:
https://test-drive-test--netlify-cms-www.netlify.com/docs/test-drive/
- Description for the changelog
Update the Test Drive doc to use the newest Kaldi template and Netlify Identity instructions.
- A picture of a cute animal (not mandatory but encouraged)