Skip to main content

Setting up a Subsite as a Preview Site

Overview​

By configuring a subsite created in Kuroco as a source of synchronization, it can be used as a preview site.
Once configured, content created on the source site will automatically be sent to the preview site, allowing for verification of display in the deployed environment of the preview site.

The diagram below illustrates the functionality.

Image from Gyazo

This document explains the setup and operation of a preview site on Kuroco.

Prerequisites​

info

Setting up the Preview Site​

Synchronize the Source Site and Preview Site Completely​

Only content is synchronized in the preview site feature. Perform a complete synchronization in advance to align tag IDs and member IDs.

Click on [Environment Settings] -> [Site List].
Image from Gyazo

Click on [Edit] for the subsite to be set as the preview site.

Image from Gyazo

Enable [Sync Immediately], select full synchronization with the source site, and click [Update].

Image from Gyazo

Configure the Source Site​

After completing the full synchronization, set the [Content Sync Source Site Key] for the preview site.

Again, click on [Edit] for the subsite to be set as the preview site.

Image from Gyazo

Set the source site key as the content sync source site key and click [Update].

Image from Gyazo

With this, the setup of the preview site is complete.

Please ensure that the option "Send to Preview Site" is added to the public settings in the content editing interface of the source site.

Image from Gyazo

Operation of the Preview Site​

  • Content added, updated, or deleted on the source site will also be added, updated, or deleted on the preview site.
  • When "Send to Preview Site" is selected on the source site to add or update content, it will go through an approval workflow on the source site, while the content will be immediately added to the preview site.
    *Approval workflow must be enabled.
  • Verification of display on the preview site is done, and if it is okay, the workflow for approval on the source site is expected to be followed.
  • If there are updates to content under approval on the source site, the content on the preview site will be automatically updated.

Restrictions​

  1. Only contents are synchronized. (Tags and masters are not synchronized.)
  2. If the member IDs do not match between the source site and the preview site, there is a possibility that the member_id of the content owner may be misaligned.
  3. If the tag IDs are different, the tagging will be misaligned.
  4. Contents added or updated via CSV upload will not be synchronized to the preview site.
  5. Changes in the publication status or order from the list screen will not be synchronized to the preview site.
  6. Draft saves will not be synchronized to the preview site.
  7. Content categories will not be synchronized to the preview site. If addition or update is required, please update on both sites. Adjust the content category IDs to be the same.
  8. The file manager will not be synchronized to the preview site.
    • Images added via WYSIWYG will refer to the source site's images.
    • For files (from the file manager), please save the files on both the source and preview sites.
  9. It is assumed that content updates will not be made on the preview site.
    If content is added or updated on the preview site, the content will be updated. However, if synchronization occurs from the source site, the data from the source site will overwrite.
tip

Many of the restrictions are affected by the different IDs between the source site and the preview site.
If the differences are significant, please execute "Synchronization" to align the IDs.

Support

If you have any other questions, please contact us or check out Our Slack Community.

Contact form
Join Kuroco Slack community