How Do I Use the Prepublish Feature?

Answer

To use the Prepublish feature, first complete the required prerequisites and installation steps. Then follow the appropriate usage guide based on whether you are using a CMS plugin, Email Governance, Optimizely CMP, or the Siteimprove API.

Summary

After completing the prerequisites and installation requirements, the process for using Prepublish depends on your integration or platform. CMS plugin users must identify whether they are using the old or new plugin experience, while Email Governance, Optimizely CMP, and API users should follow their respective implementation guides.

Prerequisites

Before using the Prepublish feature:

• Follow the steps above for Prerequisites and installation.

How to Use the Prepublish Feature

Step 1: Determine which Prepublish implementation you are using

Follow the guidance below for your specific platform or integration.

Step 2: Use Prepublish with CMS Plugins

For CMS Plugins, first determine if you are using the "new" or "old" plugin experience by consulting the following section of this page: How do I tell if I am using the 'old' or 'new' plugin user experience (UI/UX)?

Then follow the appropriate steps below for the plugin experience version.

New CMS plugin experience

• Refer to How to Run a Prepublish Check with the New Plugin UI

Old CMS plugin experience

• Refer to the particular plugin's usage guides accessible via links on the Siteimprove CMS Plugin Page under the specific plugin page's installation or user guide tab.

Step 3: Use Prepublish with Email Governance

• Email Governance - refer to the Siteimprove Email Governance Integration Installation and Usage Guide.

Step 4: Use Prepublish with Optimizely CMP

• Optimizely CMP - refer to the installation guide available under the Optimizely page.

Step 5: Use Prepublish with the Siteimprove API

• Siteimprove API - follow the steps here for How to connect to the Siteimprove API.
• The Content endpoints in the API are strictly intended to be used for Prepublish (Content Checks).
• Siteimprove does not provide support or consultation services for custom API implementations, so we don't have instructions on how to set up a custom Prepublish check implementation.

Expected Outcome

After following the appropriate guide for your platform, you will be able to use the Prepublish feature to perform Content Checks prior to publishing content.