Gretyl's Portal

Heretto Help

Deployments

A deployment is a configuration in Heretto CCMS that defines which main sitemap is published to which Heretto Portal environment. Deployments carry information about the deployment type and audience. They enable you to publish content to your portal.

There are two types of deployments: active sync and manual deploy.

Active Sync

Active Sync automatically publishes content updates to the Heretto Portal. Any change introduced in a topic or map is immediately visible in your portal environment. This deployment type is particularly useful to preview content that is still work-in-progress in a staging portal environment.

Manual Deploy

Manual Deploy requires the deployment to be triggered by a Heretto CCMS Administrator. That means your updates are not reflected in the Heretto Portal until a deployment is published manually. Manual Deploy enables you to control when content updates are visible in a portal environment. It's especially useful when you want to publish approved updates for a specific release to a production portal environment.

Known Limitations

  • You cannot deploy from a release. You can, however, branch a release and deploy from that branch.

  • Deployments do not warn about validation issues in your content. Use the preflight check to validate your content before publishing it to portal. For more information, see Preflight Check.

Configure Deployments

Deployments are configured in Heretto CCMS. They connect content in the CCMS with Heretto Portal environments via Heretto Deploy API and enable you to publish content to the associated portal environment. Deployments can be configured by users assigned the Administrator role in the Heretto CCMS. A portion of the configuration must be completed by the Heretto team.

If you want to create a deployment for a map on a specific branch, switch to that branch.

  1. In the Administration interface, go to Deployments.
  2. In the upper right, click + New Deployment.
  3. In the Create Deployment window, provide the following details:
    Create Deployment Window
    1. Provide the name of the deployment.
      Note:

      We recommend including the name of the branch and portal environment in the deployment name. For example, when your deployment is to publish content from the Verification branch to the staging portal environment, your deployment name could be Verification branch & Staging portal. This ensures that anyone can understand how each deployment is configured.

    2. Decide which deployment type you want to set up. By default, deployments are set to Manual Deploy. If you want to configure an Active Sync deployment, select the Active Sync option.
    3. Click Add file and navigate to the map that you want to deploy.
      Remember: To deploy a map from a specific branch, switch to that branch before starting this step.
    4. Click Add audiences and navigate to the DITAVAL file you want to use in this deployment.
    5. Decide if you want to automatic redirects enabled for this deployment. By default, automatic redirects are enabled. If you want t disable them, select the Portal Content Automatic Redirects option.
  4. Click Save.
  5. Copy the ID Heretto generated for your deployment and pass it to your Customer Success Manager, along with the following information:
    • Share URL to the deployment map

    • The name of the branch that contains the deployment map

    • The Heretto Portal environment the deployment map should be connected to

Once the Heretto team completes the configuration on their side, the configuration of the deployment is complete.