docs-cn icon indicating copy to clipboard operation
docs-cn copied to clipboard

Debug TiDB Documentation: TiDB 中文文档测试说明

Open qiancai opened this issue 2 years ago • 1 comments

欢迎参与测试验证TiDB 文档。您的文档使用反馈对我们不断提升 TiDB 的文档使用体验非常重要。

待验证文档列表

注意:在以下列表中,除了前 15 行之外,其它行对应的文档测试任务目前还未创建成 GitHub issue。我们会在前 15 个测试任务有人认领后,再将其他的测试任务创建为 GitHub issue。如果以下您想测试的某个文档目前还未创建成 GitHub issue,请在当前 issue 下留言告诉我们。

如何验证测试文档

  1. 从上述文档列表中选择一篇你想要验证的 TiDB 文档。
  2. 点击跳转到该文档对应的 sub-issue 链接,然后在 sub-issue 页面通过发表 /assign 评论将此 sub-issue 分配给自己。如果该 sub-issue 右上角的 Assignees 字段已显示有人认领,请重新选择一篇待验证文档。
  3. 按照文档中提供的说明使用 TiDB (部署方式请选择 “本地部署 TiDB"),一步一步完成验证过程。
  4. 验证过程中,验证文档内容的准确性、可用性、完整性和可读性。

文档验证反馈

  1. 在完成文档验证后,将您的验证结果以评论的形式添加到该文档对应的 sub-issue 中。验证结果可以是您遇到的问题、发现的错误或其他任何发现。如果验证顺利通过,您也可以添加评论说明。
  2. 对于在验证过程中发现的任何问题或错误,欢迎创建 Pull Request(PR)直接修正文档。创建 PR 时,请在 PR 描述中指明该 PR 解决了哪个问题。关于如何创建 PR 的详情,请参考TiDB 中文文档贡献指南

非常感谢您对测试和验证文档的贡献!感谢您帮助改进 TiDB 用户体验。

qiancai avatar Dec 16 '23 12:12 qiancai

文档中涉及到CA_PATH的地方表述不统一,建议更新一下的好。

TIDB_CA_PATH={downloaded_ssl_ca_path}
CA_PATH='{your-downloaded-ca-path}'
DATABASE_SSL_CA=<downloaded_ssl_ca_path>

shawn0915 avatar Jan 10 '24 09:01 shawn0915