Intro docs #233
Intro docs #233
Conversation
There was a problem hiding this comment.
Awesome docs @verythorough! I think it's very didactical and well written. I only made a few comments regarding the Editorial Workflow.
|
|
||
| ### Editorial Workflow | ||
|
|
||
| Netlify CMS has an optional [editorial workflow](https://github.com/netlify/netlify-cms/blob/master/docs/editorial_workflow.md) that translates common Git commands into familiar language in a simple UI: |
There was a problem hiding this comment.
In this section, this is not exactly how the Editorial Workflow currently works. Currently, it creates a branch, pushes a commit AND opens the PR all at the same time. Changing the status (draft, waiting for review, ready to publish) triggers no GIT actions.
There was a problem hiding this comment.
(I like the way you described more, though. Maybe in a future version of the CMS, hehe)
There was a problem hiding this comment.
Hm, so it does! Apparently when I was testing, I didn't look for the PR until I was expecting to find it. 😛 I'll update.
docs/intro.md
Outdated
| Mark draft as Waiting for Review | Opens a pull request | ||
| Approve and publish draft | Merges pull request and deletes branch | ||
|
|
||
| If you prefer to use Git, you can push additional commits and open and merge PRs directly, and the Netlify CMS interface will update to match. |
There was a problem hiding this comment.
The CMS interface will update if the user commits new content, but it wont update for new PRs.
What happens is: Behind the scenes, the CMS creates a metadata branch on the repository, invisible to the end-user. When the CMS creates a new PR, it also saves all data related to this PR in it's metadata branch - which means that PRs created outside the CMS will be ignored by it.
There was a problem hiding this comment.
Yeah, this only made sense when I thought draft saving didn't create a PR. Rather than get into the details, I'm now thinking I'll just remove the line.
There was a problem hiding this comment.
Updated the table and removed the line after. Now it feels kind of abrupt, but probably ok. Heading to a meeting. Will update the branch if I change my mind after. :)
- Summary
Adds Intro/Core Concepts and Quick Start documentation as discussed. Storing in
docsfor now.- Test plan
Displays as expected in GitHub :P
- Description for the changelog
Add Intro/Core Concepts and Quick Start documentation
- A picture of a cute animal (not mandatory but encouraged)