Skip to content

Commit 7276575

Browse files
authored
Merge branch 'master' into docs/beta-features/custom-formatters
2 parents bc1e8e6 + f26ae53 commit 7276575

File tree

4 files changed

+49
-48
lines changed

4 files changed

+49
-48
lines changed

website/content/docs/add-to-your-site.md

-11
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,6 @@ backend:
102102
103103
The configuration above specifies your backend protocol and your publication branch. Git Gateway is an open source API that acts as a proxy between authenticated users of your site and your site repo. (We'll get to the details of that in the [Authentication section](#authentication) below.) If you leave out the `branch` declaration, it defaults to `master`.
104104

105-
### Editorial Workflow
106-
107-
**Note:** Editorial workflow works with GitHub repositories. Support for GitLab and Bitbucket is [in beta](/docs/beta-features/#gitlab-and-bitbucket-editorial-workflow-support).
108-
109-
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 enable the [Editorial Workflow](../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`:
110-
111-
```yaml
112-
# This line should *not* be indented
113-
publish_mode: editorial_workflow
114-
```
115-
116105
### Media and Public Folders
117106

118107
Decap CMS allows users to upload images directly within the editor. For this to work, the CMS needs to know where to save them. If you already have an `images` folder in your project, you could use its path, possibly creating an `uploads` sub-folder, for example:

website/content/docs/beta-features.md

-23
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,6 @@ We run new functionality in an open beta format from time to time. That means th
88
**Use these features at your own risk.**
99

1010

11-
## GitLab and BitBucket Editorial Workflow Support
12-
13-
14-
15-
You can enable the Editorial Workflow with the following line in your Decap CMS `config.yml` file:
16-
17-
```yaml
18-
publish_mode: editorial_workflow
19-
```
20-
21-
In order to track unpublished entries statuses the GitLab implementation uses merge requests labels and the BitBucket implementation uses pull requests comments.
2211

2312

2413

@@ -112,18 +101,6 @@ You can now provide your own element for Decap CMS to mount in by setting the ta
112101

113102

114103

115-
## Squash merge GitHub pull requests
116-
117-
When using the [Editorial Workflow](../configuration-options/#publish-mode) with the `github` or GitHub-connected `git-gateway` backends, Decap CMS creates a pull request for each unpublished entry. Every time the unpublished entry is changed and saved, a new commit is added to the pull request. When the entry is published, the pull request is merged, and all of those commits are added to your project commit history in a merge commit.
118-
119-
The squash merge option causes all commits to be "squashed" into a single commit when the pull request is merged, and the resulting commit is rebased onto the target branch, avoiding the merge commit altogether.
120-
121-
To enable this feature, you can set the following option in your Decap CMS `config.yml`:
122-
123-
```yaml
124-
backend:
125-
squash_merges: true
126-
```
127104

128105

129106
## Image widget file size limit

website/content/docs/configuration-options.md

+1-14
Original file line numberDiff line numberDiff line change
@@ -68,26 +68,13 @@ Template tags produce the following output:
6868

6969
## Publish Mode
7070

71-
By default, all entries created or edited in the Decap CMS are committed directly into the main repository branch.
72-
73-
The `publish_mode` option allows you to enable "Editorial Workflow" mode for more control over the content publishing phases. All unpublished entries will be arranged in a board according to their status, and they can be further reviewed and edited before going live.
74-
75-
**Note:** Editorial workflow works with GitHub repositories, and support for GitLab and Bitbucket is [in beta](/docs/beta-features/#gitlab-and-bitbucket-editorial-workflow-support).
76-
77-
You can enable the Editorial Workflow with the following line in your Decap CMS `config.yml` file:
71+
By default, all entries created or edited in the Decap CMS are committed directly into the main repository branch. The `publish_mode` option allows you to enable [Editorial Workflow](/docs/editorial-workflows/) mode for more control over the content publishing phases. You can enable the Editorial Workflow with the following line in your Decap CMS `config.yml` file:
7872

7973
```yaml
8074
# /admin/config.yml
8175
publish_mode: editorial_workflow
8276
```
8377

84-
From a technical perspective, the workflow translates editor UI actions into common Git commands:
85-
86-
| Actions in Netlify UI | Perform these Git actions |
87-
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
88-
| Save draft | Commits to a new branch (named according to the pattern `cms/collectionName/entrySlug`), and opens a pull request |
89-
| Edit draft | Pushes another commit to the draft branch/pull request |
90-
| Approve and publish draft | Merges pull request and deletes branch |
9178

9279
## Media and Public Folders
9380

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
group: Workflow
3+
weight: 20
4+
title: Editorial Workflows
5+
---
6+
7+
8+
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`:
9+
10+
```yaml
11+
# This line should *not* be indented
12+
publish_mode: editorial_workflow
13+
```
14+
15+
From a technical perspective, the workflow translates editor UI actions into common Git commands:
16+
17+
| Actions in Netlify UI | Perform these Git actions |
18+
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
19+
| Save draft | Commits to a new branch (named according to the pattern `cms/collectionName/entrySlug`), and opens a pull request |
20+
| Edit draft | Pushes another commit to the draft branch/pull request |
21+
| Approve and publish draft | Merges pull request and deletes branch |
22+
23+
**Note:** Editorial workflow works with GitHub repositories, and support for [GitLab](/docs/gitlab-backend/) and [Bitbucket](/docs/bitbucket-backend/).
24+
25+
26+
### Bitbucket Support
27+
28+
In order to track unpublished entries statuses the Bitbucket implementation uses
29+
[pull requests comments](https://confluence.atlassian.com/bitbucketserver/commenting-on-a-pull-request-1027119882.html).
30+
31+
### GitLab Support
32+
33+
In order to track unpublished entries statuses the GitLab implementation uses
34+
[merge requests labels](https://docs.gitlab.com/ee/user/project/labels.html).
35+
36+
37+
## Squash merge GitHub pull requests
38+
39+
When using the **Editorial Workflow** with the `github` or GitHub-connected `git-gateway` backends, Decap CMS creates a pull request for each unpublished entry. Every time the unpublished entry is changed and saved, a new commit is added to the pull request. When the entry is published, the pull request is merged, and all of those commits are added to your project commit history in a merge commit.
40+
41+
The squash merge option causes all commits to be "squashed" into a single commit when the pull request is merged, and the resulting commit is rebased onto the target branch, avoiding the merge commit altogether.
42+
43+
To enable this feature, you can set the following option in your Decap CMS `config.yml`:
44+
45+
```yaml
46+
backend:
47+
squash_merges: true
48+
```

0 commit comments

Comments
 (0)