README.md

Teleport docs site

This repo contains the source for the Teleport docs site, including the content of the docs, docs engine, and some relevant scripts.

If you notice that something is vague, inaccurate, or incomplete about the documentation, or have an idea for a great guide, we encourage you to create a GitHub issue in the gravitational/teleport repo using our issue template.

Documentation content

To learn how to contribute content changes to the Teleport docs site, read the following guides:

• How to contribute: A step-by-step guide to making changes to the Teleport documentation.
• Reviewing Teleport documentation: How to run a local preview site to review documentation changes.
• Docs UI reference: UI components available to documentation authors.
• Documentation style guide: Rules for maintaining consistent Teleport docs.

Docs engine development

Read the following guides to learn how to work on the Teleport docs engine:

• Yarn command reference: yarn commands available for development-related tasks.
• Docs configuration guide: Options for configuring the Teleport docs site.