Templates used: | |
Release checklists: |
This tutorial covers the steps required to add reference data files for a destination to the docs.
Data files contain data that’s referenced throughout the Stitch Docs. For destinations, it’s used in:
- Destination references
- Error references
- Comparison guides
- Determining which feature fields - such as SSH - to include in a destination’s connection property object
And a wide variety of other places. To summarize, these files are incredibly versatile and also incredibly important.
Step 1: Create a new branch
This step isn’t required if you already have a working branch.
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: Copy data file templates to _data/destinations
In this step, you’ll copy the template folder containing the data files for the destination to the _data/destinations
folder.
- In Finder or the file browser of your choice, navigate to the
_templates/destinations
folder. - Copy the
/data-files
folder and its contents. - Paste the
/data-files
folder into the_data/destinations
folder. -
Rename the
_data/destinations/data-files
folder to the name of the destination.For example: For a Snowflake destination, this folder would be named
snowflake
. The name of the folder must match the destination’s uniquetype
value. -
Rename the
_data/destinations/{destination-type}/version
folder tov{version}
, where{version}
is the version of the destination.For example: If this is version 1 of the destination, the folder would be named
v1
. The end result should follow this format:_data/destinations/{destination-type}/v{version}
Step 3: Fill in the templates
Fill in the data file templates, using the following resources to guide you:
Template name | Documentation |
versions.yml | Integration/destination version template reference |
destination-details.yml | Destination details data file template reference |
stitch-details.yml | Destination Stitch details data file template reference |
loading-errors.yml | Error message template reference |
replication.yml | Destination replication data file template reference |
data-types.yml | Destination data types data file template reference |
user-privileges.yml | Database and destination user privileges template reference |
database-connection-settings.yml | Database and destination connection settings template reference |
Step 4: 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:
Back to top
Last updated: 04 August 2021