Integration Guide for Gatsby Cloud
Learn how to build a first-class integration with Gatsby Cloud
Table of Contents
To integrate with Gatsby’s Cloud offerings (currently Gatsby Preview), we have established a check list to help guide you towards an eventual partnership.
- A Gatsby Source Plugin exists
- Source Plugin can Drive Sub-Five Second Updates
- An example repository is available on GitHub
- Vendor has an extension or widget to preview content
- Vendor has an API or tool to import content
Before progressing to the specific checklist items, it’s necessary to have a source plugin that does the following:
- Fetches data from your CMS and exposes that data via Gatsby’s GraphQL schema
- Has the ability to update data based on CMS updates and deletions
For assistance with both, refer to the “Creating a First Class Source Plugin.” guide.
Once a source plugin has been created that has the ability to fetch data and expose it via GraphQL and the plugin can also update data based on remote changes, you can now progress through the rest of the check list. Woo hoo!
One of the key values of a Preview environment is that changed or draft content is nearly instantly available for live preview in the Gatsby Cloud environment. If the user is stuck waiting for content to appear, the experience is broken and cannot be considered first class.
To ease onboarding, please create an example repository of a Gatsby application using your source plugin. This will currently allow your users to get developing as quickly as possible.
Please see the “Creating an Example Repository” guide for more info.
When switching to a headless model the key value of Gatsby Preview is in delivering an experience that is similar to a traditional CMS. Specifically a traditional CMS oftentimes has a “Preview” button that allows the editor to preview current content changes before publishing, and these changes are shown in context to gain an understanding of what the content will look like after publishing.
To deliver a first-class experience, an extension or widget must be created that will allow certain content types to be previewed directly in Gatsby Preview. This makes the experience seamless and gives content editors that great preview functionality that they’ve come to expect.
Please see the “Creating an Extension or Widget to Preview Content” guide for more info.
One of the key values a vendor can offer is a way to automatically provision content. This enables a flow in which a user of Gatsby Cloud can have a CMS that is automatically created and seeded with sample content, e.g. a blog or portfolio.
To deliver a first-class experience, a means to import content (ideally an API) should be provided that will allow the CMS to be automatically provisioned and content can be created.
Please see the “Importing Content” guide for more info.