大网数据广告活动
数据库部署与 SQL 参考

StarRocks 中文参考:How to feedback and contribute

· 52CE 我爱测

贡献文档或反馈意见前,请您仔细阅读本文,快速了解注意事项、问题提交和编写流程,以及文档模版。

How to feedback and contribute

非常感谢您参与 StarRocks 文档建设,您的帮助和意见是文档改进的关键!

贡献文档或反馈意见前,请您仔细阅读本文,快速了解注意事项、问题提交和编写流程,以及文档模版。

反馈意见

如果您在阅读文档时,发现文档里描述有误、描述不清晰、或者不规范,可以直接在文档页面底部的 文档是否有帮助 中进行反馈,或者直接在左下角点击编辑此页,提交 PR 修改文档。

提交PR修改文档

如果您想直接修改或更新文档里的描述,可提交 PR 贡献修改。

  1. 进入文档编辑页面。

    • 方式一:在官网文档中,单击页面左下角的编辑此页,选择对应的文档分支后(一般为 main 分支),进入文档编辑页面。
    • 方式二:登录 GitHub,直接在中文文档仓库找到对应文档,单击文档右上角的铅笔图标,进入文档编辑页面。

    [图示请参阅官方原文]

  2. 完成文档编辑后,在页面底部的 Propose changes 区域中,输入此次文档变更的标题或更多描述。 [图示请参阅官方原文]

  3. 单击 Propose changes,提交文档变更。

  4. 新建PR,输入PR标题和描述,然后单击 Create pull request。

    [图示请参阅官方原文]

  5. PR 进入评审阶段,评审通过后,文档变更会合入至 StarRocks 文档仓库,并最终更新至官网。 评审阶段分为自动检查和人工评审。

    1. 自动检查:提交人是否已经签署CLA,提交文档是否符合markdown语法。
    2. 人工评审:StarRocks Committer 会阅读并沟通文档内容。最终合入至StarRocks文档仓库,并更新官网。

贡献新文档

注意事项

  1. StarRocks文档仓库使用 markdown 格式,贡献文档前,请熟悉基本的 markdown 语法。
  2. 语言:请至少选择中英文一种语言,欢迎提供中英双语版本。
  3. 导航栏:如果文档为新增文档,则需要在 docs/docusaurus 下的 sidebars.json 文件中为新增文档添加中文和英文索引。如果您不熟悉此操作,提交 PR 后,文档团队也会自行添加索引。
  4. 图片:图片需要先放入文件 assets 中,文档中引用图片时请输入图片的相对路径,比如 [图示请参阅官方原文] 。
  5. 引用:如果引用官网文档,推荐使用文档相对路径,比如 [test md](./data_source/catalog/hive_catalog.md)(../zh/data_source/catalog/hive_catalog.md)。如果引用外部文档,则引用格式为 [引用文档名称](引用文档链接)。
  6. 代码块:代码块必须标明语言类型,比如:sql,json。

编写流程

  1. 登录 GitHub 帐户,直接在中文文档仓库单击 Add file,进入新文档编辑页面。 [图示请参阅官方原文]

  2. 编写文档(markdown 格式),并在 sidebars.json 文件中添加索引。

  3. 在 Github 上提交文档 Propose new file,输入标题和描述,然后提交,创建 PR。 [图示请参阅官方原文]

    请关注 PR 的 check 检查结果,如果有 failed check,请及时修复问题。

  4. PR 进入评审阶段,评审通过后,文档变更会合入至 StarRocks 文档仓库,并最终更新至官网。

文档模板

本文来自 StarRocks 文档贡献者,按 Apache 2.0 整理版式与相对链接,保留正文与代码。图示请参阅原文。作者与贡献记录。

资料来源与适用范围

资料来源
StarRocks 文档贡献者
适用范围
main 文档快照(2026-11-16)
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
Apache 2.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。