Publish to Confluence
Confluence Publishing enables you to publish content that has been authored in private to a designated location within the same Confluence system, serving as an access point for internal audiences. This feature is great for creating and distributing internal handbooks, knowledge bases, and other similar internal assets.
How Publishing Works
Publishing lets you copy a specific version, variant, or translation of your documentation to another Confluence location, whether in the same space or in another.
Here’s the process:
Prepare: Create the target space or prepare a parent page in an existing space to server as the publishing location.
Make sure you have the required permissions in the source and target space.
Publish: Work on your documentation in one place – your Scroll Document –, then publish the desired version to the target location. You can publish the Working version directly, or create saved versions and publish those instead.
Any version can be published to many locations.
Update: After your initial publish, you can keep working on the content of your document and update the previously published version with changes from the same version or publish content from newer versions.
What Gets Published
Publishing copies only the pages of your chosen version/variant/translation combination, not the entire Scroll Document itself.
The Document toolbox in the public version enables authors to navigate to the source document for management.
Below you can see in more detail what is published:
Content | Does it get published? | |
|---|---|---|
Page tree of the selected version | Yes | - |
Text | Yes | - |
Macros | Yes | - |
Attachments | Yes | - |
Page labels | Yes | You can decide if you want to publish page labels along with your content. |
Page restrictions | No ⛔ | Page-level restrictions from the source space are not copied to the public version. |
Prefixes | Yes | When publishing, you have the option to add prefixes to page titles. If you choose not to add a prefix, any existing version prefixes will be removed from the published pages. |
Page history | No ⛔ | Publishing creates new pages in the target space, so the original page history isn't copied. However, each publish action is recorded as a new revision for the corresponding page. |
Scroll page titles | Yes | You can't change Scroll page titles in published space using Scroll Documents. However, Scroll Viewport and Scroll Exporter apps will still recognize them. We recommend only updating the Scroll page titles in the source space. However, if you need to edit Scroll page titles in the target space, install the free Scroll Exporter Extensions app. Just remember, changes will be overwritten when you republish from your Scroll Document. |
How to Publish Your First Version
Ready to publish your first version? Follow the steps below:
Go to the Document Manager of your document.
Click on Publish.
Choose Publish to Confluence.
Select the version/language/variant to publish, and click Next.
Search for and select the target space.
Choose the parent page in the target space where the content will be added.
(Optional) If needed, add a prefix to avoid page title conflicts.
If there are no conflicting page titles, and you choose not to add a custom prefix, existing version prefixes will be removed from the published page titles.
(Optional) Select if you want to publish page labels.
Click on Publish.
Your version's page tree will now be copied and available in the chosen target space.
View Published Versions
After publishing, the new public version remains connected to the document in order to be able to update it later. You can view which versions have been published to which location in a new column in the Document Manager.
Clicking on Published to X locations opens a dialog which enables you to do the following:
Delete: Remove a published version and its pages from the target space. You can also choose to keep the pages but remove their connection to the Scroll Document.
Update: Republish the same version to update the content in the target space, or publish a new version to replace the existing content.
View: Go directly to the published version in the target space.
This dialog also shows you key information about the published version, including:
Version name
Whether a translation was published
Whether a variant was published
Any prefixes applied to the published pages
How to Update a Published Version
Future changes to the original version won't automatically update the published version, unless you manually update it. To update an existing public version, follow these steps:
Go to the Document Manager.
Click Published to X locations for the version you want to update.
Click Update 🔄 .
Choose to republish the same version, language, and variant or select new ones. Click Next.
(Optional) Choose whether to publish page labels.
(Optional) Add prefixes to avoid page title conflicts.
Click Publish.
This will update your published documentation with the latest changes from your chosen version, variant, and language.
How to Delete a Published Version
To remove a published version from the target space (while keeping the version itself in your document):
Go to the Document Manager.
Click the Published to X locations icon belonging to the published version.
In the Published locations dialog, click Delete.
Choose your deletion option:
To keep the published pages in the target space: Click Delete again.
To delete the published pages in the target space: Check the delete pages box and click Delete.
This deletes the published version, but the original version in the source space remains unaffected.