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.

Sign up for GitHub

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

Add explanation for default_workflow_status #60

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add explanation for default_workflow_status #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion content/docs/editorial-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,23 @@ weight: 20
title: Editorial Workflows
---


By default, saving a post in the CMS interface pushes a commit directly to the publication branch specified in `backend`. However, you also have the option to edit the [Publish Mode](../configuration-options/#publish-mode), which adds an interface for drafting, reviewing, and approving posts. To do this, add the following line to your Decap CMS `config.yml`:

```yaml
# This line should *not* be indented
publish_mode: editorial_workflow
```

You can select the initial status <a href="https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.1.6" class="version-tag">3.1.6</a> with the following line in your config file:

```yaml
default_workflow_status: 'draft'
```

There are the 3 available options: `'draft' | 'pending_review' | 'pending_publish'`.

### Git operations under the hood

From a technical perspective, the workflow translates editor UI actions into common Git commands:

| Actions in Netlify UI | Perform these Git actions |
Expand Down