If your site uses a content management system (CMS), Gatsby Cloud provides a tool to easily preview content changes and collaborate with content editors. When you add a site to Gatsby Cloud, you will find CMS Previews under the CMS Preview tab of the Site Overview page.
A CMS Preview is a development build of your site that enables you to make changes in your CMS and see those changes take effect in real-time.
Using CMS Previews requires connecting your site to one of the supported CMSs. Check out the Connecting to a Content Management System tutorials for more information on how to configure your site for CMS Previews.
How CMS Previews are Triggered
A CMS Preview build may be triggered when any of following events occur:
- a change in the connected CMS (such as an autosave while typing, save, or publish action)
- a Git commit to the production branch configured in site settings
- manually clicking the Trigger Build or Restart Preview button in the Gatsby Cloud user interface
- a POST request to the Preview Webhook
Some CMSs support a preview extension that enables you to view your CMS Preview build without having to leave your CMS. Preview extensions are available for:
Check out the Preview Extensions tutorials from more information.
CMS Preview Demo
Here's a quick screencast demonstrating how a change in Contentful triggers a CMS Preview update.