Skip to content

Commit bb6d179

Browse files
committed
adds release sets doco
1 parent d6e1347 commit bb6d179

File tree

10 files changed

+66
-0
lines changed

10 files changed

+66
-0
lines changed
23.1 KB
Loading
50.5 KB
Loading
57.8 KB
Loading
18.9 KB
Loading
12.9 KB
Loading
24.4 KB
Loading
14.5 KB
Loading
54.7 KB
Loading
10.5 KB
Loading
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
description: >-
3+
Create collections of content to publish according to multi-stage scheduling rules.
4+
---
5+
6+
# Release Sets
7+
8+
{% hint style="info" %}
9+
This feature requires a license - learn more about [Workflow's licensing model](https://umbraco.com/products/umbraco-workflow)
10+
{% endhint %}
11+
12+
Release Sets are collections of [Alternate Versions](../alternate-versions/alternate-versions.md), where each version can be scheduled independently. Release Sets provides a holisitic overview of scheduled content, and enables building and managing large or complex content schedules to drive digital campaigns or content roll-outs.
13+
14+
Release Sets is currently (v16.0.0) available behind a feature flag. To enable the feature, add the following to app settings:
15+
16+
```json
17+
"Umbraco": {
18+
"Workflow": {
19+
... // other settings
20+
"FeatureFlags": ["ReleaseSets"]
21+
}
22+
}
23+
```
24+
25+
## Working with Release Sets
26+
27+
- Ensure the User Group permissions are set to allow appropriate access.
28+
![Release Set permissions](images/release-set-permissions.png)
29+
- Navigate to the Release Sets dashboard in the Content section
30+
![Release Set dashboard view](images/release-sets-dashboard.png)
31+
- Clicking the `Create` button opens a workspace modal to create a new set.
32+
![Version workspace](images/release-set-workspace-editor.png)
33+
34+
A Release Set is comprised of document versions and (optionally) tasks. Consider tasks as a to-do list - these are items that should be tracked alongside the Release Set, but are not necessarily CMS activities.
35+
36+
For example, a task might be to finalise CPC advertising. It is not a CMS activity, but it is a requirement that must be met before publishing the Release Set.
37+
38+
### Adding documents
39+
40+
- Click the `Add document` button
41+
- Select the document node from the picker
42+
- In the versions editor, either add or create a new version of the selected document
43+
![Version editor](images/versions-editor.png)
44+
- Adding an existing version opens the version picker. Adding a new version opens the [Alternate Version](../alternate-versions/alternate-versions.md) workspace editor
45+
![Version picker](images/version-picker.png)
46+
- After selecting or creating a version, it is displayed in the version editor
47+
![Version editor](images/version-editor-2.png)
48+
- The selected version can then be scheduled
49+
![Version scheduling](images/version-scheduling.png)
50+
- Multiple versions of the same document can be added and scheduled in sequence
51+
![Multiple selected versions](images/version-editor-3.png)
52+
- After submitting the modal, the updated versions are displayed in the overlay. The documents list shows the selected documents, while the calendar shows the Release Set and its components.
53+
![Release Set overview](images/release-set-overview.png)
54+
- Selecting a day in the calendar displays the content changes scheduled for that date.
55+
![Calendar day](images/calendar-day.png)
56+
- The `Add` button in the calendar day dialog allows adding items to the Release Set, similar to the `Add document` button in the main overview.
57+
58+
### Publishing a Release Set
59+
60+
A Release Set can be published immediately or scheduled for future publication. To publish a Set, all assigned versions and tasks must be either `Ready to publish` (versions) or `Complete` (tasks). If all components in the Set are in the required status, it can be published by a use with the appropriate permission.
61+
62+
Publishing content within the a Release Set is managed by a recurring hosted service, similar to scheduled content publishing.
63+
64+
As publishing progresses, each document version will be promoted to be the current backoffice draft, then published as normal. A version of the initial backoffice draft is preserved as an Alternate Version and can be republished or edited in future.
65+
66+
When a Release Set has no further changes to publish, the status is updated to `Complete`. The Set can then be deleted, or updated and republished. Content published within the Set is preserved and can be further edited or included in a new Release Set.

0 commit comments

Comments
 (0)