Skip to content

Commit

Permalink
Remove editorial workflow doc
Browse files Browse the repository at this point in the history
Contents moved to config options and architecture docs
  • Loading branch information
verythorough committed Dec 7, 2017
1 parent 92acef5 commit e9dc39c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 46 deletions.
15 changes: 14 additions & 1 deletion website/site/content/docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,17 @@ The control component receives three (3) callbacks as props: `onChange`, `onAddA

Both control and preview widgets receive a `getAsset` selector via props. Displaying the media (or its URI) for the user should always be done via `getAsset`, as it returns an AssetProxy that can return the correct value for both medias already persisted on the server and cached media not yet uploaded.

The actual persistence of the content and medias inserted into the control component is delegated to the backend implementation. The backend will be called with the updated values and a list of assetProxy objects for each field of the entry, and should return a promise that can resolve into the persisted entry object and the list of the persisted media URIs.
The actual persistence of the content and medias inserted into the control component is delegated to the backend implementation. The backend will be called with the updated values and a list of assetProxy objects for each field of the entry, and should return a promise that can resolve into the persisted entry object and the list of the persisted media URIs.


## Editorial Workflow implementation

Instead of adding logic to `CollectionPage` and `EntryPage`, the Editorial Workflow is implemented as Higher Order Components, adding UI and dispatching additional actions.

Furthermore, all editorial workflow state is managed in Redux - there's an `actions/editorialWorkflow.js` file and a `reducers/editorialWorkflow.js` file.

### About metadata

Netlify CMS embraces the idea of Git-as-backend for storing metadata. The first time it runs with the editorial_workflow setup, it creates a new ref called `meta/_netlify_cms`, pointing to an empty, orphan tree.

Actual data are stored in individual `json` files committed to this tree.
44 changes: 0 additions & 44 deletions website/site/content/docs/editorial-workflow.md

This file was deleted.

3 changes: 2 additions & 1 deletion website/site/static/_redirects
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/docs/custom-authentication /docs/authentication-backends 301
/docs/extending /docs/custom-widgets 301
/docs/validation /docs/custom-widgets/#advanced-field-validation 301
/docs/validation /docs/custom-widgets/#advanced-field-validation 301
/docs/editorial-workflow /docs/configuration/#publish-mode 301

0 comments on commit e9dc39c

Please sign in to comment.