We're delighted that you've chosen to get started with Scroll Versions.
This guide takes you on a tour of Scroll Versions' key functionality – how to activate Scroll Versions in a space, create new versions, and compare versions to review how new content will impact both of them. It's important to note that in using Scroll Versions, you are creating versions of entire spaces, not just pages.
Before you begin, make sure that you are in a space suitable for testing, as this guide involves creating mock pages and content.
1: Activate Scroll Versions
Scroll Versions is activated in a space when you create the first version of a space.
- Click Space Tools > Scroll Add-ons which will show you an overview of which features are enabled in this space and in this case, Scroll Versions.
- Under Scroll Versions > Versions click New Version
- When creating a new version, you can define the version settings:
- Preceding Version: since this is our first version, this will have no preceding version
- Color: used for visualization or coordination, in this case Gray
- Version name: how you will identify this version, in this case 1.0. Version name may only contain letters, numbers and these special characters: . - _
- Description: description of the version
- Release Date: anticipated release date for this version
- Click Create and your first version will now be activated.
- Create an example page in version 1.0 and add some mock content.
2: Create a new version
Now that versions has been activated, we want to create a second version to demonstrate the behavior of each version as content is edited or new pages are added.
- Click New Version
- Enter the settings for the new version with the preceding version set to 1.0 which will mean that all content of 1.0 will be inherited by this new version. Add a new color, description, and name the version 2.0.
- Click Create to create the new version.
3: Compare Versions
It's important to understand how content will behave in past and future versions. When you add a new page to a version, it then exists in the version you have specified and its subsequent versions, but none of the preceding versions. The same is true when editing a versioned page. Here is an example:
- Always make sure you have the version you want to be working in selected in the version picker, in this case 2.0:
- Create a new blank page in version 2.0. You will see that the working version is also visible in the editor on the top right. Name the page New 2.0 Feature, add some example content, and click Publish.
- Switch to version 1.0 and create a mock page with some dummy content.
- Next, switch to version 2.0 and edit the mock page that you have just created. Add some new example content to the top of the page:
- Your space will have content that resembles this screenshot, with a new 2.0 page in the page tree and the mock page you created updated with the new 2.0 content:
- To compare the versions, revert to version 1.0 using the version picker. Notice the new content that was added to the mock page is no longer visible and the New 2.0 Feature page is grayed out in the page tree. Selecting this page will show a message that this page is only available in version 2.0: