Intro to Publishing
Pages managed with Scroll Versions are available only to people involved in the documentation process unless/until the version is published. When you publish, you can either preview your publish to see what's new (similar to the compare versions) or skip the preview and publish directly (which is ideal for making small changes, for example).
Space and Doc-Admins can publish versions through the Versions screen.
There are four methods for publishing content with Scroll Versions – you can publish
- to a new space
- within the same space
- to an existing space
- to a remote Confluence system using the Scroll Remote Publishing Endpoint.
When publishing to an existing space, pages are identified by their Scroll Page ID and matched to existing pages with the same ID, ensuring that Scroll Versions updates the correct pages. Pages that are already in that space without a Scroll Page ID, will not be changed on publish.
If you want to have full control of the look and feel or your content, have your documentation meet your CI, and have multiple published versions in the same space, you can use Scroll Viewport to style your versioned content to perfection and make it available online. More information can be found in our Scroll Viewport Documentation.
Setting up your spaces
Confluence Administrators can restrict in which spaces Scroll Versions can be activated. See Restrict Scroll Versions activation by space for further details.
Once Scroll Versions has been installed on your Confluence system, it needs to be activated at space level. There are two approaches to authoring and publishing documentation with Scroll Versions: the Public Master Space approach and the Private Master Space approach.
Additionally, if you install the Scroll Remote Publishing Endpoint on the target system, you can publish to a remote Confluence instance.
In a nutshell, the difference between these publishing approaches is in the permission settings and the publishing mode. If your authoring space is available for your readers, and you publish within the same space, this is a Public Master Space approach. If your authoring space is limited to your authors only, and you publish to a new or existing space, this is a Private Master Space approach.
The Public Master Space approach
In this approach, you work exclusively in a single master space that always contains the most recent version. You publish new versions to that same space, and older versions can be published to separate individual spaces for archiving. This method is preferable if you want to retain your users' comments, but can't have multiple spaces.
If you have a public master space approach, you can also use Scroll Viewport to make your content available without publishing and have multiple versions available for your readers. Please have a look at Manage versions for further details.
The Private Master Space approach
Another approach is to work with a private master space, which readers can't access. You publish new versions to a separate space (new or existing), which is accessible to your readers. This approach works well when you have several spaces for specific variants, customers, etc.
Each published version will have its own URL. In some cases, it makes sense to always publish the latest version within the same space, and publish older versions to a dedicated space. This is the way Atlassian does it!
When using this approach, you do not need to set Scroll Versions specific roles and can leave the default Confluence permissions, which will result in significantly faster publishes.
Publishing Include Library content from other spaces
When you publish content from spaces that use Include Library from other spaces, the pages from other spaces will be copied during the publishing process to the published space.
Page restrictions of the original content will be maintained but space permissions are not copied during publishing. This means that the content that might not be visible in the space being published could be visible in the published space.