Contributing to Teleport's Documentation
Documentation is essential for learning about a product or service. Even for internal contributors, reference documentation is often the ultimate source of truth and the final arbiter of disputes and disagreements. And for decision makers at organizations evaluating solutions, documentation is often a key resource.
Teleport emphasizes accuracy and user satisfaction in our documentation, and does not use documentation as a marketing tool. Our documentation supplements other support mediums like Stack Overflow, discussion forums, GitHub issues, Slack, and so on. There are many customer voices and we want to hear them all. As such, we provide several avenues for expression, questions, and feedback.
Read through Divio's documentation to get a sense about the kind of documentation we want to transform our current documentation into.
- How to Contribute to Teleport's Documentation: Follow this guide to start contributing changes to Teleport's documentation.
- Documentation UI Reference: Consult this resource to ensure that you are making the most of our documentation's user interface components.
- Style Guide: Use this reference to ensure our docs are consistent and effective.
- Creating documentation issues: Guidelines for creating Teleport documentation issues on GitHub