docs/data/README.md

1.6 KiB

Data

This directory contains data files that are parsed and made available to pages in the site.data object.

All YML and Markdown files in this directory are configured to be translated by default.

Features

Feature files are used for feature-based versioning. See features/README.md.

Glossaries

We provide a customer-facing glossary on the site. Other glossary files are used by our translation pipeline. See glossaries/README.md.

GraphQL

GraphQL schema files are kept in sync with github/github via scheduled workflows. See graphql/README.md.

Reusables

Reusables are long strings of reusable text. See reusables/README.md.

Variables

Variables are short strings of reusable text. See variables/README.md.

Webhooks

Webhook payload JSON files are used in the webhook events docs.

ui.yml

ui.yml contains localized strings used in layouts.

Learning Tracks

Learning tracks are a collection of articles that help you master a particular subject. See learning-tracks/README.md.

Versioning

Many YAML files in this directory's subdirectories, like features, glossaries, variables, and learning tracks, as well as Markdown files within the reusables directory, can include YAML versioning or Liquid versioning within Markdown strings. See the README.md files in the subdirectories for details.