-
Notifications
You must be signed in to change notification settings - Fork 811
Workflow 16 feature docs #7156
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.
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
Merged
sofietoft
merged 30 commits into
umbraco:main
from
nathanwoulfe:workflow-16-feature-docs
Jun 11, 2025
Merged
Workflow 16 feature docs #7156
Changes from 7 commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
b0bd06c
adds alt versions doco
nathanwoulfe d65dbcc
adds release sets root
nathanwoulfe d6e1347
updates summary to add alt versions, release sets
nathanwoulfe bb6d179
adds release sets doco
nathanwoulfe 2c5dd4b
linting
nathanwoulfe 6c88281
linting
nathanwoulfe 2364502
linting III
nathanwoulfe d4ba6d9
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh 4f7c438
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh 2669842
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh 1c6e95a
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh 3ad0874
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh c5b6d49
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh b00c3ae
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh f3bca9f
Update 16/umbraco-workflow/alternate-versions/alternate-versions.md
eshanrnh e5d45a1
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh a7a43cc
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 2656069
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 102c6fc
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 08c3ebd
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 0bb6338
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 8847116
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh f923593
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 46d9bf5
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh c8c93bb
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh b7d37b1
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 28f1ebf
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 3c852b5
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 9d6d864
Update 16/umbraco-workflow/release-sets/release-sets.md
eshanrnh 0344c07
Trigger GitBook checks
sofietoft File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
16/umbraco-workflow/alternate-versions/alternate-versions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| 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) | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| {% 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 a Workpace 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. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Working with Alternate Versions | ||
|
|
||
| - Ensure the User Group permissions are set to allow appropriate access. | ||
|  | ||
| - Navigate to the Versions Workspace View on a content item | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - Clicking the `Create` button opens a workspace modal with a copy of the current draft. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - Update and save the new version | ||
| - Find the new version in the collection view | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
|
|
||
| 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 from the document variant selector, then create the new version as outlined above. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The collection in the workspace view will show only versions matching the current document variant. | ||
Binary file added
BIN
+43 KB
16/umbraco-workflow/alternate-versions/images/alternate-version-permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+66.2 KB
16/umbraco-workflow/alternate-versions/images/version-workspace-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+31.6 KB
16/umbraco-workflow/alternate-versions/images/versions-collection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+21.9 KB
16/umbraco-workflow/alternate-versions/images/versions-workspace-view.png
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.
Binary file added
BIN
+57.8 KB
16/umbraco-workflow/release-sets/images/release-set-workspace-editor.png
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| {% endhint %} | ||
|
|
||
| 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 content schedules to drive digital campaigns. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Release Sets is currently (v16.0.0) available behind a feature flag. To enable the feature, add the following to app settings: | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```json | ||
| "Umbraco": { | ||
| "Workflow": { | ||
| ... // other settings | ||
| "FeatureFlags": ["ReleaseSets"] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Working with Release Sets | ||
|
|
||
| - Ensure the User Group permissions are set to allow appropriate access. | ||
|  | ||
| - Navigate to the Release Sets dashboard in the Content section | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - Clicking the `Create` button opens a workspace modal to create a new set. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
|
|
||
| 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 finalise digital advertising. It is not a CMS activity, but it is a requirement that must be met before publishing the Release Set. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Adding documents | ||
|
|
||
| - Click the `Add document` button | ||
| - Select the document node from the picker | ||
| - In the versions editor, either add or create a new version of the selected document | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - Adding an existing version opens the version picker. Adding a new version opens the [Alternate Version](../alternate-versions/alternate-versions.md) workspace editor | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - After selecting or creating a version, it is displayed in the version editor | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - The selected version can then be scheduled | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - Multiple versions of the same document can be added and scheduled in sequence | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - 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. | ||
|  | ||
| - Selecting a day in the calendar displays the content changes scheduled for that date. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|  | ||
| - 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 use with the appropriate permission. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Publishing content within the a Release Set is managed by a recurring hosted service, similar to scheduled content publishing. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
eshanrnh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.