Docs about Docs logo Docs about Docs

This checklist is used when a new SaaS integration is slated for release. Note: This may not be the full list of tasks required to release an integration. 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 version file

Instructions for adding a new version to existing integration or destination documentation.

REQUIRED

Add base documentation

Create the base documentation for the integration. This includes setup requirements and steps, replication details, and schema info, if applicable.

REQUIRED

Add Connect source form property

Every new integration has a corresponding source form property in the Connect API. This will create the source form property documentation for the integration.

OPTIONAL

Add integration schema files

Not always required for release. Create the integration’s schema files, which display info about the expected output of the integration.

OPTIONAL

Add SaaS foreign keys

Not required for release. Create a list of reference links for foreign key fields in the integration’s schema documentation.


Back to top

Last updated: 29 January 2020