Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enrich Documentation: ADMIN CHECKSUM TABLE #15468

Open
qiancai opened this issue Nov 27, 2023 · 2 comments · May be fixed by #17617
Open

Enrich Documentation: ADMIN CHECKSUM TABLE #15468

qiancai opened this issue Nov 27, 2023 · 2 comments · May be fixed by #17617
Assignees
@dveeden
Labels
2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. type/enhancement This issue/PR improves documentation usability or supplements document content.

Comments

@qiancai
Copy link
Collaborator

qiancai commented Nov 27, 2023 •
edited

Overview

According to My Top 10 Feature Requests for TiDB, the current ADMIN CHECKSUM TABLE document for TiDB is "poorly documented as to what it actually checks". To make this document more comprehensive and user-friendly, we welcome external contributors to add more information about its purpose, usage scenarios, examples in these scenarios, and output explanations.

Required skills

Proficiency in TiDB statements.

Contribution guidelines

  1. Assign the issue to yourself by commenting /assign.
  2. Submit a pull request (PR) to the TiDB docs repositories (either pingcap/docs in English or pingcap/docs-cn in Chinese, or both).
  3. In the PR description, indicate which issue this PR resolves, such as "Fix #15468".
@qiancai qiancai added 2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. type/enhancement This issue/PR improves documentation usability or supplements document content. labels Nov 27, 2023
This was referenced Dec 20, 2023
Open
Open
@takaidohigasi
Copy link
Contributor

correct link for ADMIN CHECKSUM TABLE would be
https://github.com/pingcap/docs/blob/611cddeb452ec2a652b1a644e36079fa6e1253a4/sql-statements/sql-statement-admin-checksum-table.md

@qiancai
Copy link
Collaborator Author

qiancai commented Jan 10, 2024

Hi @takaidohigasi, thanks a lot for catching that. I've fixed the link in the issue description.

@dveeden dveeden self-assigned this May 24, 2024
@dveeden dveeden linked a pull request May 24, 2024 that will close this issue
Open
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dveeden dveeden

Labels
2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. type/enhancement This issue/PR improves documentation usability or supplements document content.
Projects
2024 TiDB Docs Dash Issue List | 2024 TiDB 文档挑战赛任务列表
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update EBNF for admin statements and add checksum details dveeden/docs
3 participants
@dveeden @takaidohigasi @qiancai