菜单
开源
最近评审：2024 年 9 月 4 日文档简介
Grafana Labs 将技术文档与文档对应的项目代码一起存放。
一些开源项目及其仓库包括
- Grafana：https://github.com/grafana/grafana
- Grafana Alloy：https://github.com/grafana/alloy
- Grafana k6：https://github.com/grafana/k6-docs
- Grafana Loki：https://github.com/grafana/loki
- Grafana Mimir：https://github.com/grafana/mimir
- Grafana Pyroscope：https://github.com/grafana/pyroscope
- Grafana Tempo：https://github.com/grafana/tempo
每个仓库都包含一个 docs/sources 目录，其中存放文档源文件。
基于主题的写作
Grafana Labs 文档团队使用基于主题的写作方法。基于主题的写作是一种模块化的内容创建方法，内容围绕主题构建，可以在不同情境下混合和重用。
有关主题类型的更多信息，请参阅 主题类型。
为什么基于主题的写作很重要？
非基于主题的写作很难重用。
如果每个人都将信息复制到多个位置并进行少量修改，结果将是重复劳动和错误增加，这会使维护和翻译相关的成本倍增。
非基于主题的写作读者很难理解。
内容、结构、术语和写作风格各异，可能会让读者感到困惑和沮丧。
基于主题的写作更一致且用户友好。
用户可以快速轻松地找到所需信息。它具有更一致的格式和语气，清晰地定义了 Grafana Labs 的品牌形象。
Markdown
Grafana Labs 使用 Markdown 编写技术文档。有关更多信息，请参阅 Markdown 指南 中的 Markdown 风格指南。
贡献方式
您可以通过以下方式贡献内容
加入社区
如需进行文档方面的通用讨论，欢迎加入 Grafana Labs 公共 Slack 工作空间中的 #docs 频道。