Skip to content

Debug TiDB Cloud Documentation: Summary Issue #15480

New issue
New issue
Open
Open
Debug TiDB Cloud Documentation: Summary Issue#15480
Labels
2024-tidb-docs-dashThis issue or PR is included in the 2024 TiDB Docs Dash event.
@qiancai

Description

@qiancai
qiancai
opened on Nov 27, 2023

Overview

TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings everything great about TiDB to your cloud.

Welcome to test and verify the accuracy of TiDB Cloud documentation. Your feedback on the provided instructions and overall user experience is crucial for ensuring the documentation is reliable and user-friendly.

Tip: If TiDB Cloud is new to you, you can quickly get started with it by following this document.

Documents to verify

Note: Except for the first 16 lines, the other lines in the following list are not issues yet. We'll convert them to sub-issues after the first 16 sub-issues are assigned. If you want to debug one or more of the following documents that are not sub-issues yet, please add a comment on this issue to let us know.

How to debug

  1. Choose a TiDB Cloud document for verification from the above list.
  2. Go to the sub-issue link of the document, and then assign the sub-issue to yourself by commenting /assign. If the sub-issue has already been assigned to someone else, please choose another document for verification instead.
  3. Follow the provided instructions in that document step by step to validate the entire process.
  4. Verify the accuracy, completeness, and readability of the instructions.

Feedback guidelines

  1. After finishing your verification, please add your verification result to the sub-issue as a comment. The result can be the issues you encounter, the mistakes you find, or any other findings. If everything looks fine, you can also add it as a comment.

  2. For any issues you found during the verification, welcome to create a pull request (PR) to fix them directly. In the pull request, please indicate which issue this PR resolves in the PR description. To learn how to create a pull request, see TiDB Documentation Contributing Guide.

    Note: Currently, the TiDB Cloud documentation is in English only and it is stored in the release-7.5 branch of pingcap/docs for reusing the SQL documentation of TiDB. Hence, to create a pull request for TiDB Cloud documentation, make sure that your PR is based on the release-7.5 branch.

Your contribution to testing and verifying the documentation is highly appreciated! Thank you for helping improve the TiDB Cloud user experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    2024-tidb-docs-dashThis issue or PR is included in the 2024 TiDB Docs Dash event.

    Type

    No type

    Projects

    2024 TiDB Docs Dash Issue List | 2024 TiDB 文档挑战赛任务列表

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions