Update Publications

When a new version of your documentation is ready you can either create a new version of it or update the existing publication if you want your URLs to remain the same. ClickHelp allows you to fully replace the existing publication content, or perform a partial update where only changed topics are updated. You can read more about these modes below.

Full Replace mode

To fully replace the content of an existing publication, you first need to open the Publishing Wizard. You can do this in one of two ways:

  • From the Projects page: Hover over the needed project and click the Publish button.
    The Publish button on the Projects page
  • From the Topic Editor: You can open the publishing wizard from the Topic Editor by clicking the Publish button and selecting Publish Project.
    Publish a project.

Once the Publishing Wizard is open, follow these steps: 

  1. Select the Publishing mode and pick a publication that needs to be updated with the latest content.
    Select mode and publication
  2. Make sure the publication visibility is correct.
  3. If you use the conditional content, ensure the necessary output tags are selected.
  4. Typically, you will also enable the Publish only Ready topics option since you'd like to update only those topics that are in the Ready status at the moment and keep other topics untouched.
  5. Click Next.
  6. On the second step, select the Full Replace mode.
    Select Full Replace
  7. If you also need to replace the publication settings - such as icons, order and visibility in the publication list - check the corresponding option.
  8. Click Next.
  9. Wait till the publishing process is finished and click Next.
  10. On the last step you can open the publication or just close the dialog by clicking Finish.

Partial update mode

The partial update is suitable when you performed small changes and the TOC hasn't changed much. You can read more about it here: The Partial Update Publishing Mode.

When using this mode, be sure to keep the TOC update logic in mind, which is described in detail here: Partial Update - TOC Update Algorithm.