Re-write Quick Start with Identity/Git Gateway #639

verythorough · 2017-09-29T17:49:58Z

Addresses part of #600

- Summary
Updates the Quick Start doc to use Netlify Identity and Git Gateway.

- Test plan
You can check the GitHub rendering at
https://github.com/netlify/netlify-cms/blob/quick-start-identity/docs/quick-start.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'm also pushing a temporary branch to netlify-cms-www to test rendering on netlifycms.org:
https://quick-start-test--netlify-cms-www.netlify.com/docs/quick-start/

- Description for the changelog

Update the Quick Start doc to use Netlify Identity and Git Gateway.

- A picture of a cute animal (not mandatory but encouraged)

OK, maybe not cute, but kind of funny? 😜

erquhart

Sorry for the delay, did this review a while ago and forgot to submit.

erquhart · 2017-09-29T19:34:46Z

docs/quick-start.md

@@ -38,9 +14,9 @@ Hexo, Middleman | `/source`
 Spike | `/views`

 Notes:
- Gatsby treats the `static` folder more strictly and will not render the admin page as the other generators. You will have to make a [page component](https://www.gatsbyjs.org/docs/building-with-components/) containing the necessary scripts of the Netlify CMS app in the admin page. However, the `config.yml` is to be placed in the `static` folder in the same way.
+*Gatsby treats the `static` folder more strictly and will not render the admin page as the other generators. You will have to make a [page component](https://www.gatsbyjs.org/docs/building-with-components/) containing the necessary scripts of the Netlify CMS app in the admin page. However, the `config.yml` file (described below) can be placed in the `static` folder as with other generators.


Asterisk should be removed (unless you meant to put asterisks on both side for emphasis).

This asterisk is supposed to refer to the asterisk next to Gatsby in the table above. However, the whole paragraph is going to end up conflicting with @tech4him1's recent edit.

erquhart · 2017-09-29T19:35:38Z

docs/quick-start.md

@@ -60,14 +36,17 @@ The first file, `admin/index.html`, is the entry point for the Netlify CMS admin
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Content Manager</title>

-  <link rel="stylesheet" href="https://unpkg.com/netlify-cms@~0.4/dist/cms.css" />
+  <!-- Include the styles for the Netlify CMS UI, after your own styles -->
+  <link rel="stylesheet" href="https://unpkg.com/netlify-cms@>0.5.0-beta.1/dist/cms.css" />


Both url's should be beta.10. Very soon to be plain 0.5.0, though!

The link as written will pick up the latest beta, so it's getting beta.10 right now.

erquhart · 2017-10-05T20:11:56Z

docs/quick-start.md

 </body>
 </html>
 ```
+*\*Note: The CMS links above pull from [unpkg](https://unpkg.com/#/), a service that serves [npm](https://www.npmjs.com/) packages over a CDN, with versioning built into the URL. In this example, we're pulling a beta version of the CMS (`@>0.5.0-beta.1`), in order to support Netlify Identity and Git Gateway. You will probably want to update these URLs after [version 0.5.0](https://github.com/netlify/netlify-cms/releases) is released.*


The first * triggers the italics, and the second is escaped so it actually displays. I suppose it might be a little clearer if I use _ for the italics.
(And, come to think of it, the visible asterisk isn't really appropriate here, because there's no referring asterisk. OK! I'll remove! :P )

erquhart · 2017-10-05T20:13:01Z

docs/quick-start.md

-`image` | file picker widget with drag-and-drop | file path saved as string, image uploaded to media folder
-`number` | text input with `+` and `-` buttons | number
-`markdown` | rich text editor with raw option | markdown-formatted string
+As described above, the `widget` property specifies a built-in or custom UI widget for a given field. When a content editor enters a value into a widget, that value will be saved in the document front matter as the value for the `name` specified for that field. A full listing of available widgets can be found in the [Widgets doc](/docs/widgets).

 Based on this example, you can go through the post types in your site and add the appropriate settings to your `config.yml` file. Each post type should be listed as a separate node under the `collections` field.

 ### Filter


I don't know how this made it back in, would you mind removing? Filtering shouldn't be in the quick start guide.

I don't think it ever left. And yeah, totally agree it doesn't belong here, but it's not documented anywhere else. I don't see a better place for it in the existing docs, so I suggest we leave it here for the next short while until we have a dedicated config doc.

erquhart · 2017-10-05T20:16:06Z

docs/quick-start.md

+  }
+</script>
+```
+*Note this script require ES6 and will not work on IE11. For legacy browser support, you'll need to use a transpiler like [Babel](https://babeljs.io/).


"...For legacy browser support, use function expressions (function () {}) in place of the arrow functions (() => {}), or use a transpiler like...".

Also remove prepended asterisk.

What if I just convert the code to use function expressions instead? Or do you think it's better to use the arrow functions and include the note?

I'd say use arrows and include a note; I think we should default to ES6/ES2015/whatever-you-call-it-now in docs, since that's what we use in the code. Do you think it would be a good idea to include a link to another version of it in ES5, or is that not worth the risk of them not getting updated simultaneously in the future?

verythorough · 2017-10-10T22:18:14Z

Removed the note about using a beta version, and made a few edits in response to feedback.

tech4him1 · 2017-10-10T22:42:22Z

docs/quick-start.md

+  }
+</script>
+```
+Note: This script requires modern JavaScript and will not work on IE11. For legacy browser support, use function expressions (`function () {}`) in place of the arrow functions (`() => {}`), or use a transpiler like [Babel](https://babeljs.io/).


I would change "This script" to "This example script" so that people realize that they can do it however they want, this is just an example that uses modern JS.

tech4him1 · 2017-10-10T22:42:56Z

docs/quick-start.md

+<script src="https://identity.netlify.com/v1/netlify-identity-widget.js"></script>
+```
+
+You'll need to add this to the `<head>` of your CMS index page at `/admin/index.html`, as well as the `<head>` of your site's main index page. Depending on how your site generator is set up, this may mean you need to add it to the default template, or to a "partial" ir "include" template. If you can find where the site stylesheet is linked, that's probably the right place. Alternatively, you can include the script in your site using Netlify's [Script Injection](https://www.netlify.com/docs/inject-analytics-snippets/) feature.


"partial" ir "include" template -- ir should be or

verythorough · 2017-10-10T23:18:31Z

Updated.

@tech4him1 thanks for the catch!

erquhart suggested changes Oct 5, 2017

View reviewed changes

tech4him1 reviewed Oct 10, 2017

View reviewed changes

erquhart approved these changes Oct 11, 2017

View reviewed changes

Re-write Quick Start with Identity/Git Gateway

097ffc5

erquhart force-pushed the quick-start-identity branch from 27d00be to 097ffc5 Compare October 11, 2017 14:37

erquhart merged commit c6aab17 into master Oct 11, 2017

erquhart deleted the quick-start-identity branch October 11, 2017 14:55

snyk-bot mentioned this pull request Jul 10, 2020

[Snyk] Fix for 1 vulnerabilities mdno/netlify-cms#20

Open

snyk-bot mentioned this pull request Aug 17, 2020

[Snyk] Fix for 1 vulnerabilities mdno/netlify-cms#25

Open

snyk-bot mentioned this pull request Aug 28, 2020

[Snyk] Fix for 1 vulnerabilities mdno/netlify-cms#27

Open

mdno mentioned this pull request Feb 23, 2021

[Snyk] Fix for 2 vulnerabilities mdno/netlify-cms#41

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Re-write Quick Start with Identity/Git Gateway #639

Re-write Quick Start with Identity/Git Gateway #639

verythorough commented Sep 29, 2017 •

edited

erquhart left a comment •

edited

erquhart Sep 29, 2017

verythorough Oct 5, 2017 •

edited

erquhart Sep 29, 2017

verythorough Oct 5, 2017

erquhart Oct 5, 2017

verythorough Oct 5, 2017

erquhart Oct 5, 2017

verythorough Oct 5, 2017

erquhart Oct 5, 2017

verythorough Oct 5, 2017

Benaiah Oct 5, 2017 •

edited

verythorough commented Oct 10, 2017

tech4him1 Oct 10, 2017

tech4him1 Oct 10, 2017

verythorough commented Oct 10, 2017

Re-write Quick Start with Identity/Git Gateway #639

Re-write Quick Start with Identity/Git Gateway #639

Conversation

verythorough commented Sep 29, 2017 • edited

erquhart left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

verythorough Oct 5, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Benaiah Oct 5, 2017 • edited

Choose a reason for hiding this comment

verythorough commented Oct 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

verythorough commented Oct 10, 2017

verythorough commented Sep 29, 2017 •

edited

erquhart left a comment •

edited

verythorough Oct 5, 2017 •

edited

Benaiah Oct 5, 2017 •

edited