Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Image Added
Table of Contents
maxLevel3
minLevel2
absoluteUrltrue
excludeYou've installed the app, now what?
typeflat
separatorpipe
Excerpt
hiddentrue

You've installed the app, now what?

You've installed the app, now what?

You will need to edit the Comala the Comala Publishing global configuration and then configure each individual space.

Configure the app

 Configure the app global permissions 

Image Added

Space publishing configuration and copy space configuration

  • add/amend the Confluence user group members that can publish content

  • add/amend the Confluence user group members that can copy content

  • define the spaces can be published

Image Removedpublishing global configurationImage Added

In the app global configuration

  • the app Publishers Group can publish content. The default setting is the confluence-administrators group

  • ANY space can be linked to another space and published

Users who will be publishing content will need to be both

  • members of the Confluence group added to the app Publishers Group

  • have space admin permission for the space to be published (the draft space) and the published space

Snapshot publishing configuration

  • add/amend the Confluence user group members that can snapshot publish the content

  • define the spaces can be snapshot published

Image Added

If using Comala Document Management prior to v7.20 you need generate user tokens for snapshot users

Configure the space for space publishing

In space tools, Comala Publishing can be used to link two spaces - these will be a draft space and a published space.

You will need

  • space admin permissions for both spaces

  • to be a member of the Confluence group added to the app Publishers Group

You can then configure the content to be published and initialize the synchronisation of the two spaces.

Linking

Link the draft and the published space for space publishing

There are two options to set up the draft and published spaces:

  • Option 1: Publish content from one space to a new published space.

  • Option 2: Publish existing public content, from a new draft space.

Here are two example scenarios that can help you understand these two options.

Option 1: A new documentation space

Tip
title

Use this option if...

  • you are starting a new documentation space

, or

OR

  • you have an existing space you will use as the draft (source) space, and will publish to a new space (the target space)

Option 2: Adding to a populated space

Tip

Use this option if...

  • you have an existing space, on which people have comments, watched pages, etc

AND

  • you need a draft space to which you can make changes, and when approved, will publish to your existing space

Let's say you're starting a new documentation space

  • your content is ready for your audience

  • you will occasionally update the content

  • you want a clean and approved version for your audience to read

You can create a new space, then use Comala Publishing to link and sync your draft documentation space with this new space, which will be the published version. 

Image Removed
Image Added

Any time you make a change to a page in the draft space, the page's state changes to out of sync until you publish the space or the page.

You first need to create a new empty space. This will be the Published space.

Image Removed
Image Added
  • link the current space to the target space that will be the Published space

Image Removed
Image Added
  • choose Publish to synchronize the content in the two

spaces
  • space

Image Removed
Image Added
Info

Before choosing Publish you can

Once synced, you can make changes to your content in the new

Draft

draft space (the source space) then publish the whole space or individual pages

Option 2: Adding to a populated space

Tip
titleUse this option if...
  • you have an existing space, on which people have comments, watched pages, etc
    AND
  • you need a draft space to which you can make changes, and when approved, will publish to your existing space

    Let's say you have a space that

    • is rich in content

    • already has comments

    • has users watching pages and user labels

    You need a new draft space you will publish to this pre-existing populated space.

    Image Removed
    Image Added

    You first need to create a new empty space. This will be the Draft space.

    The existing populated space will be the Published space and the initial configuration of Comala Publishing for this Option 2  is in space tools in this populated space.

    In the populated Published space space

    tools use

    tools use Comala Publishing option to Publish from another Space

    Image Removed
    Image Added
    • link

    the
    • two spaces by using the dropdown menu


    Image Removed
    • to choose the draft space

    Image Added
    • choose Link

    A on-screen dialog confirms linking the two spaces.

    Image Added
    • choose Finish

    The next step is to synchronize the content in the two spaces.

    Image Added
    • choose Synchronize to copy the populated space content to the new

    Draft
    • draft space


    Image Removed

    All the content on the current populated space will be copied over to the

    Draft Image Removed

    linked draft space.

    Info

    Before choosing Synchronize, you can select Advanced options to manage the configuration for this initial copy process.

    For example, you might need to consider unchecking Ignore Top-Level Pages to ensure the populated space home page and any other orphan or top-level pages are copied to the new draft space.

    Image Added

    Once this initial synchronization is done, navigate to the new linked Draft space.

    In the new Draft space you can configure publishing options to decide how to handle deleted pages, labels, properties and more.

    • all further configuration and publishing of Comala Publishing is undertaken in this linked Draft space

    You can make changes to your content in the new Draft space then publish the whole space or individual pages.

     

    Note that unlinking

    Unlinking the spaces can only be completed in the Draft space space tools Publishing dashboard.

    Exclude some page content from being published

    What can you do if you don't want some of the page content to be published?

    Comala Publishing provides a simple solution.

    You can

    Image RemovedImage Added

    Copy space content

    Comala Publishing can also be used to simply copy a space to another space. This

    Copy Space will be a snapshot one-off copy of the current space at the time of the copy. There is no sync between the spaces after the copying of the content has been completed.

    The target space must be set prior to each space copy.

    Users who can copy spaces will need to have

    • space admin permission in the draft space

    • at least

      View

      view,

      Edit

      edit,

      Delete

      delete permissions for pages, blogs, attachments and comments in the destination space

    • be a member of the Confluence user group added to the app global

      Publishing configuration Copiers Group

      publishing configuration Copiers Group

    Set the copy space content to be coped

    The content to be copied each time you copy a space can be configured in the Copy options in the space Copy space dashboard.

    Image Added

    Snapshot space publishing

    Use snapshot publishing to create static versions of a Confluence document at specific moments in time, ensuring that the content remains unchanged and compliant with regulatory or quality standards.

    Image Added

    Snapshot Publishing includes Collections, purpose-built snapshot document repositories that make it easier to distribute FAQs, policies, and other documentation.

    Confluence macros like Jira Issues, Excerpt Include or Metadata, that displays live content will be frozen on each snapshot document version

    To use snapshot publishing a space administrator must

    Image Added

    A collection is managed by the space administrators who created it - the collection manager. The collection manager adds users who can contribute a snapshot to the collection and users who can view the collection snapshots.

    Page editors can be given contributor permission to each collection allowing them to add snapshots of Confluence documents to that collection.

    Each collection can be configured to add users who can view the collection. Users can view collections using the collections global viewer.

    Image Added

    Snapshots can be viewed in HTML or PDF view.

    Snapshot publishing can be used to

    • build and manage Collections by document type and user permissions, not space permissions

    • publish one page to many Collections or many pages to one Collection

    • display page metadata

    • manage version control

    • access previous versions

    • Work seamlessly with Comala Document Management to create versioned snapshot documents using the snapshot-page macro in a workflow trigger