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

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.

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: Fill in the Details and features section

In this step, you’ll fill in the Details and features section of the reference.

The Stitch features and Destination details subsections both use the _includes/destinations/overviews/destination-reference-table.html include, which uses the stitch-details.yml and destination-details.yml data files, respectively.

This section also includes information about pricing, if relevant to the destination. For example: This is the Pricing section from the Google BigQuery (v2) destination reference:

- title: "Google BigQuery pricing"
  anchor: "pricing"
  content: |
    Unlike many other cloud-based data warehouse solutions, {{ destination.display_name }}'s pricing model is based on **usage** and not a fixed-rate. This means that your bill can vary over time. 

    Before fully committing yourself to using {{ destination.display_name }} as your data warehouse, we recommend familiarizing yourself with the {{ destination.display_name }} pricing model and how using Stitch may impact your costs.

    **[Learn more about Stitch & {{ destination.display_name }} pricing]({{ link.destinations.overviews.bigquery-pricing | prepend: site.baseurl }})**

The Details and features section can also include other general information about the destination and Stitch. For example: The Google BigQuery (v2) destination reference includes a section about the Google Cloud Storage regions Stitch supports for the destination:

- title: "Supported Google Cloud Storage regions"
  anchor: "supported-gcs-regions"
  content: |
    When you set up a {{ destination.display_name }} destination, you'll select a Google Storage location. This determines the location of the internal Google Storage bucket Stitch uses during the replication process.

    Stitch supports the following Google Cloud Storage regions for version {{ destination.this-version }} of the {{ destination.display_name }} destination:

    {% include destinations/templates/bigquery-supported-regions-table.html %}

Step 3: Fill in the Replication section

In this step, you’ll fill in the Replication section of the reference.

In general, the content that exists in the template will suffice for the destination. It’s a general look at the entire replication process, from Extraction to Loading, for the destination.

For example: The Google BigQuery (v2) destination reference includes information about loading that’s specific to BigQuery v2, such as how Primary Keys are used:

- title: "Primary Keys"
  anchor: "replication--primary-keys"
  content: |
    Stitch requires Primary Keys to de-dupe incrementally replicated data. To ensure Primary Key data is available, Stitch creates an `{{ stitch.system-tables.sdc-primary-keys.name }}`table in every integration dataset. This table contains a list of all tables in an integration's dataset and the columns those tables use as Primary Keys.

    Refer to the [{{ stitch.system-tables.sdc-primary-keys.name }} table documentation]({{ link.destinations.storage.primary-key-system-table | prepend: site.baseurl }}) for more info.

    **Note**: Removing or altering this table can lead to replication issues.

Step 4: Fill in the Transformations section

In this step, you’ll fill in the Transformations section of the reference.

Adjust the sections as needed, using the boilerplate copy in the template as a guide. You can also add additional sections if there isn’t an existing one for a topic that’s relevant.

Step 5: Save the file

If you haven’t already, save the file using the following naming convention: [destination-type]-overview-v[version].md

The file should be saved into the version folder for the destination in the _destinations collection. For example: _destinations/bigquery/v2/bigquery-overview-v2.md

Last updated: 04 August 2021