The title of the page.

Example values:

• Connecting an Amazon Redshift destination to Stitch
• Connecting a Google BigQuery destination to Stitch

The page’s permalink value, used to generate its final URL.

Example values:

• /destinations/{destination-type}/connecting-{destination-type}-to-stitch

Relevant keywords that could be used to search for the doc in a search engine.

The type of content the page contains. This will be destination-setup.

A semi-unique ID for this page of the destination’s documentation set. This controls the links that display in the version menu. Only files with this key will be included as links in the version menu.

This value should be formatted as: {destination-type}-destination-setup

Example values:

• redshift-destination-setup
• snowflake-destination-setup

The order this page should display in the list of Getting Started guides for the destination. Example

Example values:

• 1
• 2

If true, the mini table of contents will display on the page.

The layout the page will use. This should be tutorial.

If true, the page will use the tutorial sidenav instead of the general (stitchnav) sidenav.

The display name of the destination. The destination’s name should match how the provider uses it, including capitalization, punctuation, etc.

Example values:

• Amazon Redshift
• Google BigQuery
• Amazon Aurora PostgreSQL

The name of the destination, in lowercase.

Example values:

• redshift
• bigquery
• aurora-postgres

The name of the destination, in lowercase. This is used to associate variants of a destination to their parent. For example: Amazon Aurora PostgreSQL destinations are based on Stitch’s PostgreSQL destination, or postgres.

To correctly associate variants to a parent destination type, this value must match the type value in the parent destination’s overview, located at /_destinations/v{version}/{destination-name}-overview-v{version}.md

Example values:

• redshift
• bigquery
• postgres

The display name of the destination in Stitch that should be used to connect the destination.

For example: While Stitch’s PostgreSQL destination supports connecting to an Amazon Aurora PostgreSQL database, there isn’t a branded destination in Stitch for Amazon Aurora. To connect an Amazon Aurora PostgreSQL database as a destination, users should use the PostgreSQL destination in Stitch.

Note: This property only needs to be used if the guide is for a variant of a destination.

Example values:

• PostgreSQL

If the destination is cloud-based, the name of the provider, in lowercase. This is used to:

• Determine which include to use for whitelisting IP addresses, if applicable to setup.

  For example: If amazon, the include for whitelisting IP addresses in Amazon Web Services (AWS) will be used.

• Create a link in relevant SSH setup guides, if the destination supports SSH.

  For example: If amazon and the destination supports SSH, a link to the guide will be included in the Setting Up SSH for Amazon databases guide.

  Note: If the guide is for a self-hosted database, use generic as the value for this property.

Example values:

• generic
• amazon
• google
• microsoft-azure

If true, the destination supports SSH connections. This must be set to true if the guide includes the Define SSH connection details step.

If true, the destination supports SSL connections. This must be set to true if the guide includes the Define SSL connection details step.

The name of the API connection property object that corresponds to the destination. For example: Amazon Redshift destinations correspond to the redshift destination connection property object.

The version of the destination. This value should be an integer.

Example values:

• 1
• 2

The prerequisites for setting up the integration in Stitch. Markdown may be used to write the content in this field. If needed, HTML will also work.

This is formatted as a list, with an - item: parameter underneath requirements for each individual requirement. For example:

requirements:
  - item: "**An Amazon Web Services (AWS) account**. Signing up is free - go to `https://aws.amazon.com` to create an account if you don’t have one already."
  - item: "**Some technical know-how and familiarity with AWS."

An array of content sections which contain the instructions for setting up the destination in Stitch. The content in these sections creates the setup steps in the finished doc.

The title of the section.

Example values:

• Whitelist Stitch's IP addresses in AWS
• Install the Amazon S3 bucket policy

The value to be used as the anchor for section’s title.

For example: select-attribution-window will create the anchor #select-attribution-window.

The section content. Markdown may be used to write the content in this field. If needed, HTML will also work. Additionally, note that:

• For single lines of content, the copy must be enclosed in double quotes (" "). For example:

   - title:
     anchor: 
     content: "Start content here."
  

• For content requiring line breaks:

  • Add a pipe (|) just after content: to allow Jekyll to correctly parse the YAML,
  • On the new line, indent two spaces, and

  • Begin writing the copy; don’t enclose in double quotes.

    For example:

    - title:
      anchor:
      content: |
        Start content here.
    

For setup instructions (setup-steps). If smaller steps make up completing a task, then substeps may be used. The substeps array requires the same parameters as its parent (setup-steps).

For example:

setup-steps:
- title: "Add Facebook Ads as a Stitch data source"
  anchor: "connect-to-stitch"
  content: "Last, you'll configure the FB settings in Stitch."
  substeps:
    - title: "Select an attribution window"
      anchor: "select-attribution-window"
      description: |
        Configure the attribution window with these steps:

        1. ...
        2. ...

    - title: "Include deleted data"
      anchor: "include-deleted-data"
      content: |
        Check this box if you want to include deleted data...