This tutorial covers the steps required to add a destination setup guide to the docs.

Step 1: Create a new branch

This step isn’t required if you already have a working branch as part of adding a new destination or destination version.

If you haven’t already, create a new branch off of the Stitch Docs master branch. Name it something descriptive to ensure it’s easy to find and tell what you’re working on.

Note: Do not fork the Stitch Docs repo and create a branch. Please clone the repo locally, and then create a new branch.

Step 2: Replace instances of DESTINATION-NAME, destination-type, and version

1. In the template, replace the DESTINATION-NAME and destination-type placeholders with the display name and type of the destination.

   For example: For Snowflake destinations, DESTINATION would become Snowflake and destination would become snowflake

2. Replace VERSION with the version of the integration.

   For example: If the version is 1, VERSION would become 1

Step 3: Define the destination's details

In the Destination Details section of the template, define the destination details. Refer to the Destination Details section of the Destination Setup Frontmatter reference for more info and examples on what these parameters do.

Step 4: Add the intro, requirements, and instructions

In this step, you’ll add the content for the guide:

• INTRO: In the intro section, add an introduction for the guide.

• SETUP REQUIREMENTS: In this section of the template is a list named requirements. In this section, add the prerequisites for setting up the destination in Stitch.

  Each prerequisite should be its own item. Refer to the Setup instructions: Requirements of the Destination Setup Frontmatter reference for examples.

• SETUP INSTRUCTIONS: In this section is a list named steps. Add the steps for setting up the destination in Stitch.

  Each action should be its own step. Refer to the Content sections of the Destination Setup Frontmatter reference for examples.

Step 5: Refer to your release checklist

If you’re working on a release, refer to the release checklist you’re using to wrap up the remaining steps for launch:

• New destination release checklist
• All release checklists

Last updated: 28 July 2021