Under maintenance

Heretto Help

Publishing Content to Portal

Once your content is ready for publishing and your deployments are configured in the CCMS, you are ready to publish your content the the portal production environment. Publishing content to portal can be done by users assigned the Administrator role in Heretto CCMS.

Note:

Publishing content to your production portal environment means going live, especially for public portals without single sign-on (SSO). For public portals with SSO, published content is only accessible to users with sign-in credentials.

Publishing to portal is possible once:

  • Your content has conditional processing (profiling) applied and DITAVAL filters exist, if applicable

  • Your content is organized into sitemaps

  • Your production branch exists in Heretto CCMS

  • Your deployments are configured in Heretto CCMS

These actions are typically completed by or in cooperation with the Heretto team during the implementation phase. Once all those components are in place, publishing is performed in three simple steps:

  • Version: Create a release for your main sitemap on the master branch for version control

  • Preview: Push your content from the master branch to your portal-production branch, then publish your content to your staging portal environment for a final quality check

  • Publish: Publish your content in the portal-production branch to your production portal environment to go live with that content

If you have content in your main sitemap on the master branch that is not ready to be published, temporarily remove it from the map or filter it out with conditional profiling to make your initial deployment easier. We recommend to only push ready-to-publish (final) content to your portal-production branch.

Publish Content

You publish content to Heretto Portal from the Deployments interface available in Heretto CCMS.

You must have the role of Administrator in Heretto CCMS to complete portions of this procedure.

Note:

Publishing content to your production portal environment means going live, especially for public portals without single sign-on (SSO). For public portals with SSO, published content is only accessible to users with sign-in credentials.

  • If you are planning to go live with your production content at this point, verify with your Customer Success Manager that your production portal environment has a custom domain configured.

  • Ensure you are assigned the Administrator role in Heretto CCMS.

In this procedure we assume that these components of the initial configuration have been completed during the implementation phase:

  • Your content has conditional processing (profiling) applied and DITAVAL filters exist, if applicable

  • Your content is organized into sitemaps for Heretto Portal publishing

  • Your production branch exists in Heretto CCMS

  • Your deployments are configured in Heretto CCMS

Ensure your main sitemap contains only ready-to-publish (final) content

  1. In the master branch, inspect content in your main sitemap and temporarily remove or filter out with conditional profiling any content that is not ready to be published.

    The branch you are in is indicated in the Content Library breadcrumbs in the top-left corner, next to the Create New button, and in the Branch drop-down menu in the top-right corner, next to your user name.

    Figure 1. The the master branch open in the CCMS
    Layer 1

Ensure your main sitemap contains no preflight check issues

  1. In the master branch, navigate to and click your main sitemap.
  2. In the Resource Drawer that opens, click Output > Publish.
  3. If at the bottom of the Publish window you see a warning about preflight issues, click the warning and resolve all issues before proceeding.
    Preflight check warning about issues which need to be resolved before publishing

Create a release for your main sitemap

Note:

If the changes you're publishing don't need versioning of the main sitemap, create a release on a lower-level map where the changes apply.

  1. In the master branch, navigate to and click your main sitemap.
  2. In the Resource Drawer that opens, click Releases > Create Release.
  3. In the Create Release dialog, do the following:
    1. Fill in the Release name field.
      Tip:

      We recommend making the release names consistent and representative of how the document progressed from one release to another. For example, the first release for a specific product can be called "Product A Release 1.0", then the second one "Product A Release 1.1", and so on.

    2. Optional: Fill in the Notes field. Click Create.

      Here you can add additional details and information about a specific release.

    You created a snapshot of the current state of your main sitemap and all its dependencies. A release enables you to perform actions like view, publish to a static output, or even edit that specific version of your content at any point in time. The Resource Drawer remains open.

Push the main sitemap from the master branch to the portal-production branch

  1. In the Resource Drawer, click Branches.
  2. In the upper-right corner, click Push Changes > Replace.
  3. In the Replace window, do the following:
    1. From the Into drop-down menu, select your portal-production branch.
    2. Keep Include linked files (recommended) selected.

      This ensures that both your main sitemap and all its dependencies are included in the push-replace operation.

    3. If at the bottom of the window you see a warning about issues in document, click the warning and resolve all issues before proceeding.
    4. Click Replace.

    You replaced content on your portal-production branch in Heretto CCMS with content on your master branch.

Publish content to your preview portal environment (Administrators only)

  1. In the upper-left corner, click the Main Menu and go to Deployments.
    Note:

    You must have the role of Administrator in Heretto CCMS to complete this section.

  2. In the deployments list that opens, select the appropriate deployment for your preview portal environment.
  3. In the page that opens, click Publish.

    The content in your portal-production branch is published to your preview portal environment.

Check the content in your staging portal environment

  1. Go to your staging portal environment and ensure that your content is complete and correct.

    To ensure that all changes have loaded, wait a moment and do a hard refresh of the staging portal environment in your browser. In Google Chrome™ and Mozilla Firefox (supported browsers), press

    Ctrl > Shift > R for Windows® and Cmd > Shift > R for macOS®.

    • If there are unexpected results in your preview portal environment, check your main sitemap and content that belongs to it on the master branch. Make necessary corrections to your content on the master branch and push the updated content to the production-portal branch.

    • If your content published as expected to your preview portal environment, continue to the next section.

Publish content to your production portal environment (Administrators only)

  1. In the upper-left corner, click the Main Menu and go to Deployments.
    Note:

    You must have the role of Administrator in Heretto CCMS to complete this section.

  2. In the deployments list that opens, select the appropriate deployment for your production portal.
  3. In the page that opens, click Publish.

Once the publishing process completes, the content in your production branch is published to your production portal. The changes are now visible to anyone who can access your production portal. Congratulations! Your production portal is now live!