mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-24 02:25:42 +08:00
Paul Gottschling
59ab788411
Make our docs guidance discoverable Currently, our guidance for making docs changes is organized into a /docs/docs page that is only accessible if you know the URL. This change ensures that people who have not received an informal training on docs contributions can contribute in a way that abides by our expectations for consistency and effectiveness. - Splits the docs/docs and docs/docs/best-practices pages into a UI reference, getting started guide, and style guide. This ensures that each kind of content we have in our contributing guide (i.e., tutorial or reference) is accessible from the main nav menu. - Adds a "Contributing" tab to the navigation menu. There is one subsection here related to documenation, and we can add another subsection later with developer guides for editing Teleport's code. - Moves the "philosophy" section into the intro page of the documentation contribution section menu. - Makes various edits to the original docs guidance for clarity. - Document our docs labels in a dedicated "creating an issue" page Fixes #9538
35 lines
1.6 KiB
Plaintext
35 lines
1.6 KiB
Plaintext
---
|
|
title: Contributing to Teleport's Documentation
|
|
description: Resources for contributing to Teleport's documentation
|
|
layout: tocless-doc
|
|
---
|
|
|
|
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.
|
|
|
|
<Admonition type="tip">
|
|
Read through Divio's documentation to get a sense about
|
|
the kind of documentation we want to transform our current documentation into.
|
|
|
|
https://docs.divio.com/en/latest/
|
|
|
|
</Admonition>
|
|
|
|
- [How to Contribute to Teleport's Documentation](./documentation/how-to-contribute.mdx):
|
|
Follow this guide to start contributing changes to Teleport's documentation.
|
|
- [Documentation UI Reference](./documentation/reference.mdx): Consult
|
|
this resource to ensure that you are making the most of our documentation's user
|
|
interface components.
|
|
- [Style Guide](./documentation/style-guide.mdx): Use this reference to ensure our
|
|
docs are consistent and effective.
|
|
- [Creating documentation issues](./documentation/issues.mdx): Guidelines for creating Teleport documentation issues on GitHub
|