Instructions for navigating the Stitch Docs repository.

The _data folder

The _data folder contains YAML files with information that is reused in other files.

For example, _data/destinations contains a folder for each destination with different files used to create sections in the destination’s documentation. The stitch-details.yml files are used to create the Stitch features table and the destination-details.yml files are used to create the Destination details table.

The content in data files can be referenced in Markdown, YAML or HTML files using the following syntax: site.data.destinations.databricks-delta.destination-details.description between double curly braces. Starting from the root of the site, it looks in the _data/destincations/databricks-delta folder, and calls the description element in the destination-details.yml file.

To find where an element from a data file is used, you can simply search for its path with the syntax above. Note: Some files call data files using variables, for example: site.data.destinations[destination.type][version]stitch-details.

The _includes folder

The _includes folder contains HTML files that can also be reused in other files. While data files are usually used to reuse small pieces of data, include files are mostly used to reuse layouts and bigger pieces of content.

For example, _includes/destinations/destination-tiles.html is used to create the tiles on the destinations overview page.

The content in include files can be referenced in Markdown and HTML files using the following syntax: include replication/replicated-rows-calculation.html between curly braces and percent signs. The reference should always start with the include keyword, followed by the path to the HTML file relative to the _includes folder.

To find where an include file is called, you can search for its path.

The integrations folders

The base documentation about integrations is stored in two folders, based on the type of integration: _databse-integrations and _saas-integrations. These folders contain a sub-folder for each integration, and the files located in these folders include a summary of the integration and its setup instructions.

The _integration-schemas folder contains, for each integration, the description of the data extracted by Stitch.

The _destinations folder

The _destinations folder contains the base documentation for each destination. It includes at least a category page, which serves as a landing page for the destination, an overview file, which is used to generate the reference documentation and a setup file which documents how to create a configure a destination.

The developer folders

The _developer-content and _developer-files folders contain the documentation for the Stitch Developer Portal. They include documentation for APIs and webhooks.

The other content folders

The repository contains several other documentation folders about specific topics, such as security, as well as getting started and troubleshooting folders.

The changelog folders

The _changelog and _changelog-files folders contain the files used for the changelog. The _changelog-files is orghanized by year and contains a file for each changelog entry.

The `_templates folder

The templates folder contains different templates that can be used to create new documentation, especially for new integrations and destinations.

The `_layouts folder

The _layouts folder contains HTML files that define the layout for different types of pages.

Last updated: 14 March 2022