pingcap / pingcap/docs

Debug TiDB Cloud Documentation: Summary Issue

Open
#15,480 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2024-tidb-docs-dash
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with one available TiDB Cloud document sub-issue, such as #15740, and follow its linked documentation page from the release-7.5 branch. Run the complete documented workflow and check accuracy, completeness, and readability. Done means posting the verification findings on the sub-issue and opening a pull request for any corrections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.