Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
b0bd06c
adds alt versions doco
nathanwoulfe Jun 11, 2025
d65dbcc
adds release sets root
nathanwoulfe Jun 11, 2025
d6e1347
updates summary to add alt versions, release sets
nathanwoulfe Jun 11, 2025
bb6d179
adds release sets doco
nathanwoulfe Jun 11, 2025
2c5dd4b
linting
nathanwoulfe Jun 11, 2025
6c88281
linting
nathanwoulfe Jun 11, 2025
2364502
linting III
nathanwoulfe Jun 11, 2025
d4ba6d9
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh Jun 11, 2025
4f7c438
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh Jun 11, 2025
2669842
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh Jun 11, 2025
1c6e95a
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh Jun 11, 2025
3ad0874
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
c5b6d49
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh Jun 11, 2025
b00c3ae
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh Jun 11, 2025
f3bca9f
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh Jun 11, 2025
e5d45a1
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
a7a43cc
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
2656069
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
102c6fc
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
08c3ebd
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
0bb6338
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
8847116
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
f923593
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
46d9bf5
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
c8c93bb
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
b7d37b1
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
28f1ebf
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
3c852b5
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
9d6d864
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh Jun 11, 2025
0344c07
Trigger GitBook checks
sofietoft Jun 11, 2025
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
8 changes: 8 additions & 0 deletions 16/umbraco-workflow/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@

* [Advanced Search dashboard](advanced-search/advanced-search-dashboard.md)

## Alternate Versions

* [Alternate Versions](alternate-versions/alternate-versions.md)

## Release Sets

* [Release Sets](release-sets/release-sets.md)

## Data Generator

* [Data Generator](data-generator/data-generator.md)
46 changes: 46 additions & 0 deletions 16/umbraco-workflow/alternate-versions/alternate-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
description: >-
Create additional draft versions of documents without impacting the 'main' draft version.
---

# Alternate Versions

{% hint style="info" %}
This feature requires a license. Learn more about [Workflow's licensing model](https://umbraco.com/products/umbraco-workflow).
{% endhint %}

Alternate Versions enables the creation of additional draft versions of documents. These can be created and updated without impacting the editing or publishing of the 'main' draft version.

Versions are managed from the **Versions** workspace view on a document and inherit workflow permissions from the host document. Permissions to create, update, promote, and delete versions can be set per User Group.

## Working with Alternate Versions

- Ensure the User Group permissions are set to allow appropriate access.
![Alternate Version permissions](images/alternate-version-permissions.png)
- Navigate to the **Versions** Workspace View on a content item.
![Versions Workspace View](images/versions-workspace-view.png)
- Click the `Create` button to open a workspace modal containing a copy of the current draft.
![Version workspace](images/version-workspace-editor.png)
- Update and save the new version.
- The new version appears in the collection view.
![Versions collection](images/versions-collection.png)

Editors can create multiple versions of a document and update these independently.

An alternate version is not published directly. Instead, it is set as the current draft version.

If the host document has an approval workflow configured, versions must be approved via the same workflow before being set to current.

If the host has no workflow configured, versions can be set to current by any user with the `Promote` permission.

When a version is promoted to be the current draft, it can be further edited before being published. Publishing can be via workflow approval or directly, depending on configuration and permissions.

## Variant versions

Alternate versions can vary by culture or segment.

To create a variant version:
- Select the desired variant using the document variant selector.
- Create a new version as outlined above.

The collection in the workspace view will show only versions matching the current document variant.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions 16/umbraco-workflow/release-sets/release-sets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
description: >-
Create collections of content to publish according to multi-stage scheduling rules.
---

# Release Sets

{% hint style="info" %}
This feature requires a license. Learn more about [Workflow's licensing model](https://umbraco.com/products/umbraco-workflow).
{% endhint %}

Release Sets are collections of [Alternate Versions](../alternate-versions/alternate-versions.md), where each version can be scheduled independently. Release Sets provides a holistic overview of scheduled content and enables building and managing content schedules to drive digital campaigns.

Release Sets is currently (v16.0.0) available behind a feature flag. To enable the feature, add the following to the `appsettings.json` file:

```json
"Umbraco": {
"Workflow": {
... // other settings
"FeatureFlags": ["ReleaseSets"]
}
}
```

## Working with Release Sets

- Ensure the User Group permissions are set to allow appropriate access.
![Release Set permissions](images/release-set-permissions.png)
- Navigate to the **Release Sets** dashboard in the **Content** section.
![Release Set dashboard view](images/release-sets-dashboard.png)
- Click the `Create` button to open a workspace modal to create a new set.
![Version workspace](images/release-set-workspace-editor.png)

A Release Set is comprised of document versions and (optionally) tasks. Tasks are like to-dos that should be tracked alongside the Release Set, but are not necessarily CMS activities.

For example, a task might be to finalize digital advertising. It is not a CMS activity, but it is a requirement that must be met before publishing the Release Set.

### Adding documents

- Click the **Add document** button.
- Select the document node from the picker.
- Add or create a new version of the selected document in the versions editor.
![Version editor](images/versions-editor.png)
- Adding an existing version opens the version picker. Creating a new version opens the [Alternate Version](../alternate-versions/alternate-versions.md) workspace editor.
![Version picker](images/version-picker.png)
- After selecting or creating a version, it is displayed in the version editor.
![Version editor](images/version-editor-2.png)
- The selected version can then be scheduled.
![Version scheduling](images/version-scheduling.png)
- Multiple versions of the same document can be added and scheduled in sequence.
![Multiple selected versions](images/version-editor-3.png)
- 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.
![Release Set overview](images/release-set-overview.png)
- Selecting a day in the calendar displays the scheduled content changes for that date.
![Calendar day](images/calendar-day.png)
- 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.

### Publishing a Release Set

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 user with the appropriate permission.

Publishing content within the Release Set is managed by a recurring hosted service, similar to scheduled content publishing.

As publishing progresses, each document version is promoted to be the current backoffice draft, and then published as normal. A version of the original backoffice draft is preserved as an Alternate Version and can be republished or edited in the future.

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.