Docs about Docs logo Docs about Docs

This checklist is used when a new destination is slated for release. Note: This may not be the full list of tasks required to release a destination. Refer to the documentation task in JIRA for the full list.

Items marked as REQUIRED must be completed prior to release.

Required Description
REQUIRED

Add base documentation

Create the base documentation for the destination.

REQUIRED

Add reference data files

Data about destinations are kept in _data files, which allows for use throughout the docs. In this step, you’ll create the base data files for the destination.

REQUIRED

Add data typing info

Stitch converts data types only where needed to ensure data is compatible when loaded into a destination. Learn more about the Stitch data typing process here.

In this step, you’ll add the mapping info for data types to the destination’s data-types.yml data file.

REQUIRED

Add the destination's reference page

Destination references (or overviews) are a high-level look at a given version of a destination. They include information about how the loading process for the destination works, what features Stitch supports, and any known limitations of the destination.

REQUIRED

Add data file for UI fields

Add the list of UI fields the user must complete in Stitch to successfully connect the destination. This data is used in the destination’s setup guide.

REQUIRED

Complete user privileges data file

Add info about the user privileges Stitch requires to successfully connect and load data into the destination. This includes the privileges themselves, the SQL commands the user has to run, if any, and the steps for creating the Stitch user.

Data from this file is used in the destination’s setup guide to generate instructions for creating a Stitch user.

REQUIRED

Add the setup guide(s)

Create the setup guide(s) for the destination, including requirements and specific steps.

Note: A destination may have more than one setup guide, if there are variants of a destination that Stitch can support.

REQUIRED

Add API connection property object

Every new destination has a corresponding destination connection property object in the Connect API. This will create the destination connection property object documentation for the destination.

REQUIRED

Add category page

todo

REQUIRED

Add destination to stitchnav.yml data file

todo

OPTIONAL

Add data loading scenario guide

todo

OPTIONAL

Add connection errors to troubleshooting

todo

OPTIONAL

Add loading errors to troubleshooting

todo


Back to top

Last updated: 04 August 2021