Revisions let you track and manage different versions of your projects, content tools, or participation tools.
This feature helps you to:
- maintain a clear history of changes
- revert to previous versions
- manage drafts before publication.
View revisions
To view revisions for a project:
- Navigate to the Dashboard.
- In the left-hand menu, click Projects. This will display a list of all the projects you have access to.
- Click on a project to open the project Dashboard.
- To view project revisions, click on the ellipsis menu icon in the top right of the screen and select Revisions.
- This will display a list of all revisions associated with that project. The details for each revision includes ID, message, author, and the date of the revision. It also includes the workflow status of the revision, and whether or not there is a version currently available to the public.
- Click View changes to see what changes have been made.
- Click the ellipsis menu icon to Preview changes in the Frontend or Edit the latest revision. If there is more than one revision, you can promote a previous version by selecting Set as new draft.
To view revisions for a content or participation tool:
- Navigate to the Dashboard.
- In the left-hand menu, click Projects. This will display a list of all the projects you have access to.
- Click on a project to open the project Dashboard.
- Select a content or participation tool to display a list of tools created for the project.
- On the right side of the list, click on the ellipsis menu icon, and select Revisions.
- This will display a list of all revisions associated with that project. The details for each revision includes ID, message, author, and the date of the revision. It also includes the workflow status of the revision, and whether or not there is a version currently available to the public.
- Click View changes to see what changes have been made.
- Click the ellipsis menu icon to Preview changes in the Frontend or Edit the latest revision. If there is more than one revision, you can promote a previous version by selecting Set as new draft.
Create a new revision
When you make changes to a project or tool and save it as a draft, a new revision is automatically created. Here's how you can manually create a new draft revision:
- Navigate to the Dashboard and select the project or tool you want to edit.
- In the Edit view, make your desired changes to the project or tool.
- Once done, click New draft. This will create a new version of the project or tool. Leave a Revision message to note your changes. Click Confirm.
- This will create a new revision.
Manage revisions
To manage existing revisions, click on the ellipsis menu icon on the right hand side of the revision list to see a dropdown list of Actions:
- Edit latest revision: This takes you to the Edit page, where you can make changes to the content, including changing the publishing status.
- Set as new draft: Where there is more than one revision, this option allows you to take an older revision and set it as the current draft, enabling you to work from a previous version.
- Frontend preview: This option allows you to preview the revision as it would appear on the public-facing website.
Previewing the version in progress
To preview the latest draft of your project or tool:
- Navigate to the Project or Tool you want to preview
- On the project's Edit page, locate the Preview in frontend button in the top right corner.
- Click the Preview in frontend button.
- In the dropdown menu, select Version in progress to preview the latest draft version.
Note: When you preview the latest draft using this method, it will display the most recent draft version across the entire site, not just the individual project or tool. This allows you to see how all your draft changes will appear together once published.
Revision messages
When making significant changes or publishing a revision, it's good practice to include a Revision message. This message will help you and your team understand what was changed in each revision. The revision message can be added in the status change dialogue when saving or publishing your changes.