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

Update Test Drive docs with Identity #626

Merged
merged 3 commits into from Oct 2, 2017

Conversation

Projects
None yet
5 participants
@verythorough
Copy link
Contributor

commented Sep 22, 2017

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)
tumblr_n5w3t9msxv1tcrdtfo3_r1_1280

@verythorough

This comment has been minimized.

Copy link
Contributor Author

commented Sep 22, 2017

Note that PR #52 in netify-cms-www will need to be merged before this PR to ensure proper image display on netlifycms.org.


## 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.

This comment has been minimized.

Copy link
@eamonnbell

eamonnbell Sep 28, 2017

Contributor

Could be it be clearer that Netlify is creating a new repository (with mirrored content) belonging to the authenticated user?

@eamonnbell

This comment has been minimized.

Copy link
Contributor

commented Sep 28, 2017

I followed the test drive guide to the letter and works fine. See one small comment about use of "clone" in a890e0d. Looks good!

@erquhart

This comment has been minimized.

Copy link
Member

commented Sep 29, 2017

@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-io

This comment has been minimized.

Copy link

commented Sep 29, 2017

Codecov Report

Merging #626 into master will increase coverage by 3.74%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
src/actions/entries.js 30% <0%> (-0.34%) ⬇️
src/actions/editorialWorkflow.js 17.02% <0%> (-0.19%) ⬇️
...ets/Markdown/MarkdownControl/VisualEditor/index.js 0% <0%> (ø) ⬆️
...rkdown/serializers/remarkEscapeMarkdownEntities.js 100% <0%> (ø) ⬆️
...arkdown/MarkdownControl/VisualEditor/components.js 0% <0%> (ø) ⬆️
...Widgets/Markdown/serializers/remarkImagesToText.js 100% <0%> (ø) ⬆️
src/components/Widgets/ObjectControl.js 0% <0%> (ø) ⬆️
...s/Markdown/MarkdownControl/VisualEditor/plugins.js 0% <0%> (ø) ⬆️
...idgets/Markdown/MarkdownControl/RawEditor/index.js 0% <0%> (ø) ⬆️
src/lib/regexHelper.js 78.57% <0%> (ø)
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1f06885...e7a934d. Read the comment docs.

@Benaiah
Copy link
Contributor

left a comment

LGTM once @eamonbell's comment is addressed. Ran through the test drive and everything worked as described.

@verythorough

This comment has been minimized.

Copy link
Contributor Author

commented Sep 29, 2017

@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.

@verythorough

This comment has been minimized.

Copy link
Contributor Author

commented Sep 29, 2017

I want to have a whoa! emoji reaction option for that Codecov comment. 😆

@erquhart

This comment has been minimized.

Copy link
Member

commented Oct 2, 2017

Yeah Jessica if you could dramatically increase our coverage as a part of this docs PR that'd be great

@erquhart erquhart merged commit 7608a6d into master Oct 2, 2017

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details

@erquhart erquhart deleted the test-drive-identity branch Oct 2, 2017

@erquhart erquhart removed this from Ready for Review in Sprint Planning | Sprint 6 (11/23 - 12/6) Oct 2, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.