Docs about Docs logo Docs about Docs

SaaS integration coming soon page template reference

HOME > REFERENCE > INTEGRATION TEMPLATES > SAAS INTEGRATION COMING SOON PAGE TEMPLATE REFERENCE

About this template

File location: /_templates/integrations/saas
Used in:
Repo link: Click to view in the Stitch Docs repo
Instructions:

This template is used to add new SaaS integration coming soon pages for when a new integration has been created before docs.

Template sections

Each template is grouped into sections to make parameters easier to find. These sections and the parameters they contain are described below.

Page and formatting

These parameters control the layout and formatting used on the page.

Parameter Description
title
STRING

The title of the page, typically the name of the integration.

Example values:

  • GitHub
  • Facebook Ads
permalink
STRING

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

Must be one of the following:

  • /integrations/saas/{integration-name}
  • /integrations/databases/{integration-name}
  • /integrations/webhooks/{integration-name}
keywords
STRING

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

The name of the layout (in /_layouts) the page should use. For a coming soon page this wil be set to coming-soon.

Note: If this parameter isn’t present in the template, the default layout defined in _config.yml for the collection (ex: _saas-integrations) will be used. Refer to the Collection Defaults section in the _config.yml file for default collection settings.
input
BOOLEAN

The default value will be false because the coming soon page is designed to be deleted. It exists so that backend testing can be done by the Sources team. If false, the integration coming soon page will not display as its own tile on the integration category pages (ex: SaaS integrations, and won’t be listed in the sidenav, etc.
key
STRING

A semi-unique ID for this page of the integration’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.

Example values:

  • google-analytics-setup
  • snapchat-ads-setup
Back to top

Integration details

High-level details about the integration, including who developed it, its name, its repo, etc.

Parameter Description
name
STRING

The name of the integration, in lowercase. Spaces should be replaced with dashes (-); periods (.) should be removed.

Example values:

  • google-adwords
  • mysql
  • closeio
display_name
STRING

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

Example values:

  • Google AdWords
  • MySQL
  • Close.io
singer
BOOLEAN

If true, the integration is a Singer integration.
tap-name
STRING

If the integration is a tap, the name of the Singer tap that powers the integration.
repo-url
STRING

If this is a Singer integration, the URL of the integration’s Singer GitHub repository.

Example values:

  • https://www.github.com/singer-io/tap-{integration-name}
  • https://www.github.com/singer-io/tap-hubspot
  • https://www.github.com/singer-io/tap-mysql
this-version
STRING

Defines the version for this integration.

Example values:

  • 1
  • 2
  • 10-15-2015
Back to top
Back to top

Last updated: 28 July 2021