pingcap / pingcap/docs

Weekly keywords check: mismatches found

Open Beginner friendly
#23,670 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Weekly Keywords Check Report

Summary

  • master — Keywords check result: ❌ mismatch
  • release-8.5 — Keywords check result: ✅ pass

master — 1 issue(s)

Comparing keywords.md
against TiDB parser (master):

Missing docs for non-reserved keyword from UnReservedKeyword: OPERATE

How to fix

Update keywords.md on the affected branch to match the current TiDB parser keywords.
See check-keywords.py for details.


Run date: 2026-08-31 01:19 UTC
Workflow run: https://github.com/pingcap/docs/actions/runs/33347209913

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 keywords.md and scripts/check-keywords.py, then compare the documented keywords with the TiDB parser reference linked in the report. Add the missing OPERATE keyword on the affected branch and run the keyword check to confirm the mismatch is resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.