-
Notifications
You must be signed in to change notification settings - Fork 701
offline 6tb tikv disk #21194
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.
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
Open
jinwhu
wants to merge
543
commits into
pingcap:master
Choose a base branch
from
jinwhu:hjw_test_v1
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
offline 6tb tikv disk #21194
Changes from all commits
Commits
Show all changes
543 commits
Select commit
Hold shift + click to select a range
476e7c3
fix incorrect message for set_var() (#19451) (#19498)
ti-chi-bot f6d9b9d
cloud: update the default TiDB version of new TiDB Dedicated clusters…
ti-chi-bot 8d996a8
cloud: add release notes 2024-11-26 (#19501) (#19503)
ti-chi-bot c48c3b4
Fix an issue number number for #52294 (#19505)
qiancai e692a15
cloud: Polish availability and limitation of Vector Search (#19494) (…
ti-chi-bot a128724
add the removal reason for `tidb_enable_change_multi_schema` (#19526)…
ti-chi-bot c4b6019
Improve 2FA docs (#19533)
dveeden 4387b9c
Improve DB audit logging documentation (#19534)
ljun0712 34fab29
br-pitr-manual: remove an unnecessary quotation mark (#19535) (#19537)
ti-chi-bot 0704aba
update serverless tidb_gc_life_time restriction (#19511) (#19513)
ti-chi-bot a9d8920
cloud: replace “Basic SSO” with “Standard SSO” (#19532)
qiancai 461672f
release-8.1: add a note for Red Hat Enterprise Linux 7 (#19551)
qiancai 1bf65f6
cloud: add 20241203 release notes (#19550)
hfxsd 16c8b6c
privilege: change privilege for SHOW PROCESSLIST from SUPER to PROCES…
ti-chi-bot 5455e74
*: update TiDB community channel descriptions and links (#19556) (#19…
ti-chi-bot 622d780
store limit v2: add more experimental description (#19553) (#19582)
ti-chi-bot c331f27
Add TiDB Cloud SQL proxy account (#18696) (#19588)
ti-chi-bot 5c7971b
ticdc: fix alert doc (#19596) (#19597)
ti-chi-bot 68b005a
update OWNERS (#19599) (#19602)
ti-chi-bot b4466c9
Update CentOS Stream 8 End of Builds (#19607) (#19610)
ti-chi-bot 5850759
sync_diff_inspector: add the check-data-only configuration item (#196…
ti-chi-bot 12ca4c4
tidb-cloud: update dev-guide-overview.md (#19612) (#19614)
ti-chi-bot 4b9644d
Announce GA of memory control on stats cache (#19604) (#19622)
ti-chi-bot 813f10f
Recommend RC instead of SQL Priority (#19605) (#19629)
ti-chi-bot 0faf9d2
tiup: restriction about DXF (#19632) (#19634)
ti-chi-bot 3122536
br: add doc for latest backup protection (#19639) (#19647)
ti-chi-bot 53ae27d
sql: fix the synopsis of `REVOKE <privileges>` (#19659) (#19666)
ti-chi-bot 8827790
planner: update the fix-control doc (#19520) (#19675)
ti-chi-bot 5e987b0
tiup: refine description about `tiup playground --tag` (#19669) (#19682)
ti-chi-bot 7969325
planner: fix the default value of 46177 to OFF for versions earlier t…
ti-chi-bot ab6a662
flashback: add limitation with stale read/snapshot (#19347) (#19696)
ti-chi-bot d0c3afa
develop: fix CURD to CRUD (#19706) (#19710)
ti-chi-bot b64c0f6
cloud: fix control add 56318 (#19694) (#19712)
ti-chi-bot 36f3423
serverless BR (#19679)
shiyuhang0 c254525
fix format error in backup-and-restore-serverless.md (#19719)
hfxsd 9953689
add 20241217 release notes (#19702)
hfxsd e0062c9
wrong-index-solution: update (#19286) (#19730)
ti-chi-bot dcbd01c
check-before-deployment: add selinux (#19703) (#19738)
ti-chi-bot eda6926
Add the "toml" code fence to TiKV config (#19742) (#19745)
ti-chi-bot ef22795
dm: update the example version to 8.1.2 (#19760) (#19766)
ti-chi-bot 164030b
Improve usage of `IMPORT FROM SELECT` (#19777) (#19780)
ti-chi-bot 8bafa96
tiup-playground: add info about TiProxy (#19769) (#19771)
ti-chi-bot 96795c7
perftest: readd v8.5.0 lts perftest result(back to original templete)…
stevenayu f3a960d
sql: Update sql-statement-flashback-cluster.md (#19787) (#19789)
ti-chi-bot 681d866
v8.5.0 lts-perftest: fix 8.5 update non-index test result (#19798)
stevenayu ac40374
tidb cloud: add tidb node groups docs (#19713)
hfxsd 1d8dc93
v8.1.2: dynamic config add `import.num-threads` (#19716) (#19799)
ti-chi-bot bcee634
add release notes for v8.1.2 (#19720) (#19801)
ti-chi-bot a249033
v8.1.2: bump version (#19721)
Oreoxmt 8c42147
restore: update full restore speed (#19806) (#19811)
ti-chi-bot e499f18
fix the table schema for cluster_tidb_index_usage (#18783) (#19794)
ti-chi-bot 6cd803a
configuration-file: correct the initial capitalization of certain con…
ti-chi-bot efad6c4
Add lightning import support for parquet format files exported by Sno…
ti-chi-bot dcb6b03
add release notes for v7.5.5 (#19724) (#19847)
ti-chi-bot ad5fd83
update Clinic free period (#19850) (#19855)
ti-chi-bot 1a7fa5d
v7.5.5: support Kylin SP3 (#19862) (#19864)
ti-chi-bot e03bf99
TiDB Cloud serverless export update (#19824)
shiyuhang0 69452c7
Add descriptions of load schema snapshot (#19835)
Frank945946 5c57b36
Connect to Kafka PL/PSC service from TiDB Cloud (#19323) (#19872)
ti-chi-bot 0ee8586
cloud: serverless HA (#19500) (#19876)
ti-chi-bot 2b38475
sql: `RENAME TABLE` supports renaming multiple tables and across dbs …
ti-chi-bot 9fbf40d
cloud: refine roles in organizations and projects (#19830)
qiancai cea204d
add cloud release notes 20250102 (#19866)
hfxsd ab8f5cd
Add warning for spark support (#19868) (#19869)
ti-chi-bot 95766c9
update year to 2025 in copyright.tex (#19879) (#19882)
ti-chi-bot 9b698cf
cloud: fix Kafka download link (#19907)
Oreoxmt b60e5b4
Spm fix hint issue (#19740) (#19914)
ti-chi-bot b279bdc
Clarify swap descriptions (#14480) (#19923)
ti-chi-bot 711632a
8.5 performance highlights: update the table for IO jitter improvemen…
qiancai ecd2cd5
fix: correct CHAR and BINARY maximum length from 256 to 255 (#19927) …
ti-chi-bot e07e22c
Refine tiflash docs to remove deprecated description (#19913) (#19946)
ti-chi-bot f9887f8
changefeed: add tips for Private Connect to Kafka SaaS services (#19945)
grovecai 02d2ec7
cloud: update TiDB Cloud product links to reflect current URLs (#19950)
Oreoxmt db4a4ba
cloud: optimize TOC and add concept docs (#19717)
qiancai 9e65f8e
mysql-compatibility: correct performance_schema statement (#19737) (#…
ti-chi-bot 336d988
Fix Percolator URL (#19961) (#19965)
ti-chi-bot 13f5e86
cherry-pick config performance to release-8.1 (#19973)
dbsid eee095e
partitioned-table: remove incorrect limitation (#19977) (#19980)
ti-chi-bot 04175a7
Update cop rpc execution info (#19995) (#19997)
ti-chi-bot 789aa94
cloud: add the notification doc (#19953)
qiancai e430f4a
cloud: add 20250114 release notes (#19987)
qiancai 09ff266
releases: move #41048 bug fix from v7.1.0 to v7.2.0 (#20001) (#20005)
ti-chi-bot abc9e0c
update the link of release notes PDFs (#19989) (#19991)
ti-chi-bot 4cd371b
cloud: new generation of TiDB Cloud support services - Connected Care…
Yujie-Xie 52ce27f
Support Plan: minor changes for clarity (#20011)
lucifinil cca2741
fix TiDB Cloud Connected Care support services (#20017)
Yujie-Xie fc30865
remove unnecessary white space (#20025) (#20029)
ti-chi-bot 4834abe
tiup-component-cluster-check: Update (#20021) (#20043)
ti-chi-bot 5930feb
*: add a note to clarify IP addresses (#20049) (#20053)
ti-chi-bot 984cfdc
tiflash: add two more TiFlash config items (#20050) (#20063)
ti-chi-bot d3f21db
tidb cloud: AWS Lambda integration (#13233) (#20067)
ti-chi-bot dd2a0d5
Add more details for dumpling (#20072) (#20076)
ti-chi-bot 1ea3ab2
Update prometheus grafana integration dashboard (#16714) (#20079)
ti-chi-bot 249582c
polish import doc (#20019)
xuanyu66 3f9e6ce
cloud: add release notes 20250121 (#20064)
qiancai bc18cfe
dm: enable-relay is undeprecated since v5.4.0 (#18781) (#20088)
ti-chi-bot f9a8afd
ticdc: add note to the Avro protocol (#19573) (#20100)
ti-chi-bot cb4dcee
ticdc: add a faq about generated column (#19369) (#20107)
ti-chi-bot bc57fbc
tiflash: remove deprecated http_port (#20116) (#20123)
ti-chi-bot 75f949d
cdc: add description about support versions for redo log parameters (…
ti-chi-bot d39e2e9
cloud: update AWS private endpoint steps (#20137)
qiancai 4c9401d
cloud: update the index page according to the latest TOC (#20143)
qiancai ea25142
TiDB Cloud Serverless does not support changing `enable-table-lock` c…
ti-chi-bot e7c2fe4
fix the default value of `periodic-full-compact-start-max-cpu` (#2015…
ti-chi-bot 8f4545e
TiCDC: Add 3 kafka addresses and correct the names of parameters (#20…
ti-chi-bot 72bfe10
Fix keywords orders (#20169) (#20171)
ti-chi-bot 8f1b3ff
pd: update the default value of read-base-cost (#20173) (#20175)
ti-chi-bot fabb580
system-variables: add the experimental info for tidb_evolve_plan_base…
ti-chi-bot 14d27d7
tidb-troubleshooting-map: fix a spelling mistake (#20182) (#20183)
ti-chi-bot 5fd1fab
lighting: reorder tidb.session-vars (#20185) (#20190)
ti-chi-bot 49eaa13
ticdc: add event filter example (#20186) (#20207)
ti-chi-bot a8126ca
fix the default value of tidb_enable_plan_replayer_capture in release…
ti-chi-bot 1dce132
tiup: update sysctl settings (#20078) (#20215)
ti-chi-bot b21ef75
variable: tidb_slow_txn_log_threshold (#20198) (#20221)
ti-chi-bot 1dd932c
cloud: fix the default value of tidb_enable_plan_replayer_capture (#2…
ti-chi-bot dc83671
Add doc for `APPROX_COUNT_DISTINCT` aggregate function (#20188) (#20242)
ti-chi-bot 932a775
*: update wording for accuracy (#20233) (#20239)
ti-chi-bot 89e47b6
ticdc: update "safe-mode" description (#20252) (#20255)
ti-chi-bot 33b23b4
ci: sync media folder to cos (#20251) (#20268)
ti-chi-bot 950d93e
cloud: switch the tab sequence (aws-cli first) for private endpoint c…
qiancai 199b321
cloud: update the intro sentence of creating AWS endpoints (#20273)
qiancai 5ba5f83
doc: correct subquery optimization examples for clarity (#20274) (#20…
ti-chi-bot b569b49
TiDB auto increment MySQL-compatible behavior clarification (#20152) …
ti-chi-bot 9773ea1
Separate serverless/dedicated import (#20282)
zhangyangyu 4233f44
cloud: update the category type name for AWS endpoint creations (#20292)
qiancai fac652b
support: replace internals.tidb.io with discussions on GitHub (#20294…
ti-chi-bot 73972ad
cloud: update alert subscriber (#19461) (#20312)
ti-chi-bot 9ce6591
cloud: Clinic on TiDB Cloud (#19895) (#20313)
ti-chi-bot 90cfe3a
connected care: add features docs (#20303)
Yujie-Xie a0eb271
serverless import gcs/azure (#20230)
xuanyu66 7928060
cloud: add release notes 20250218 (#20310)
Oreoxmt 5a262ad
fix import snapshot from dedicated to serverless (#20304)
zhangyangyu eed4bdd
add tiup no-sudo doc (#20179)
Yujie-Xie 721c8d5
cloud: add links to the connected care overview (#20317)
Yujie-Xie 7c72b55
Document bug: API command for changefeed (/api/v2/changefeed/test1/sy…
ti-chi-bot 40fef69
tiup: give a more clear recommendation about SELinux (#20068) (#20315)
ti-chi-bot 6daa242
ticdc: add description about safe-mode arguments (#20314) (#20327)
ti-chi-bot da7f4b4
pd: add note for tombstone store gc (#20331) (#20335)
ti-chi-bot 43741ee
mysql-compatibility.md: Add note about JOIN on subquery (#20309) (#20…
ti-chi-bot 7b834c5
tidb-configuration-file: Add like to Coprocessor Cache docs (#20289) …
ti-chi-bot e456d33
release-8.1: fix typo (#20360)
qiancai 56d43ef
cloud: update sample data import docs titles to clarify serverless an…
Oreoxmt 041be7a
cloud: update product name (#20366)
Oreoxmt 9dfde6f
Update Cloud:v8.5-performance-highlights.md with suggestion (#20307)
kennedy8312 ade200e
Update notes for scaling PD nodes (#20379) (#20384)
ti-chi-bot 4899cf3
add v6.5.12 release notes (#20347) (#20403)
ti-chi-bot 130a657
Add a TiUP note to production deployment (#20407) (#20419)
ti-chi-bot 4c0dfbb
update media resource links to point to new locations (#20415) (#20423)
ti-chi-bot c4a6d7f
migration-tools: update the descriptions for Dumpling (#20410) (#20441)
ti-chi-bot 8a2fe1d
cloud: update a few steps for connection and migration (#20370)
qiancai c4b195c
cloud: remove the beta info for IM via Lark (#20432)
qiancai 58e7823
mysql-schema: add information about several missing system tables (#2…
ti-chi-bot e18da95
Update auto increment by adding explanations (#20390) (#20434)
ti-chi-bot c1816a2
br: add more info about the br log structure (#20443) (#20456)
ti-chi-bot 0715a07
Refresh the state of Encryption at Rest in serverless limitations (#2…
sunxiaoguang 4c77e7a
sql-statements: expand DefaultValueExpr defination (#20468) (#20470)
ti-chi-bot 5125ec3
v6.5.0 release notes: add descriptions about tidb_store_batch_size (#…
ti-chi-bot 22a38f2
tiup: Update/fix no sudo mode docs (#20437) (#20495)
ti-chi-bot f9a5622
cloud: use sections instead of tabs for S3 configuration instructions…
qiancai 2d9f5d2
br: fix description about case-sensitive and insensitive (#20438) (#2…
ti-chi-bot 24c1e7e
A Practical Guide For SQL Tuning (#19108) (#20514)
ti-chi-bot 7ffed17
tidb-lightning: update wording about parallel import (#20431) (#20520)
ti-chi-bot a4eab61
cloud: clarify the retention policy for manual backups (#20501)
qiancai ee8a3bc
feat: serverless ip firewall for public endpoint (#20494)
shizn 8cc1ce3
add release notes 7.5.6 (#20463) (#20529)
ti-chi-bot a85d033
Add a section to change isolation level in transaction-isolation-leve…
ti-chi-bot b8cdcd0
Fix the desciption about cluster index and pre split region on auto r…
ti-chi-bot 126ee51
tidb-cloud: update the doc of migration from op to cloud (#19453) (#2…
ti-chi-bot 4981329
tidb node group support gcp (#20509)
qqqdan ee0131c
cloud: add 20250318 release notes (#20548)
hfxsd 640beea
Optimizing Database audit logging (#20565)
ljun0712 805d8fe
cloud: update release notes 20250318 (#20571)
ljun0712 7444b50
Improve TiDB Cloud MFA function (#20567)
ljun0712 e094142
sync-diff-inspector: add limitations (#20572) (#20584)
ti-chi-bot 79f9fac
cdc: add release version for the simple protocol (#20570) (#20588)
ti-chi-bot ab7b066
br: add compatibility notes to the Before you use section (#20569) (#…
ti-chi-bot f2ce02d
tiup: extend the firewall docs (#20081) (#20595)
ti-chi-bot e890902
connected-care: add some notes (#20599)
Yujie-Xie b27186b
Improve the description of TLS configuration parameters between compo…
ti-chi-bot 1d24d6a
Add ExportBackup event type (#20524)
ideascf 3077107
ticdc: refine faq doc (#20547) (#20615)
ti-chi-bot 05fb57b
system-variables: fix links (#20535) (#20545)
ti-chi-bot 5a7a3a9
tikv: add missing tikv configs (#20566) (#20628)
ti-chi-bot fe98959
ticdc: add duplicate entry faq (#20550) (#20637)
ti-chi-bot bcad86e
cloud: support Amazon Bedrock integration (#20649)
qiancai 32da4b2
cloud: add 20250326 release notes (#20651)
hfxsd 5f465b9
Clarify TiKV SM4 encryption descriptions (#20657) (#20660)
ti-chi-bot be8ff1f
ticdc: add more parameters (#20138) (#20664)
ti-chi-bot 196ae53
delete Import Sample Data from GCS (#20675)
xuanyu66 b3eb701
cloud: remove SimpleTab for import-sample-data-serverless.md (#20677)
Oreoxmt 8abcd2c
Describe TiCDC support in TiFlash (#20681) (#20685)
ti-chi-bot 6b4e95c
add tidb-upgrade-migration-guide (#20688) (#20691)
ti-chi-bot c8fbf96
cloud: add TiKV node storage types and Note Group GA (#20662)
qqqdan b726304
cloud: add 20250401 release note (#20687)
qiancai d81efa6
system-variables: Update/extend tidb_general_log docs (#20534) (#20655)
ti-chi-bot 59c1adf
fix: remove unnecessary whitespace (#20697) (#20700)
ti-chi-bot 2704745
Chronyc makestep (#20622) (#20706)
ti-chi-bot 558832a
fix a sample in ticloud shell (#20711)
zhangyangyu 400d6e5
stale read: update the description of tidb_external_ts (#20667) (#20727)
ti-chi-bot 4c0d8c3
ticdc: add detailed notes for table version (#20735) (#20740)
ti-chi-bot 88197cb
ticdc: use `cdc cli changefeed list` to check `checkpoint-ts` (#20749…
ti-chi-bot 05d2ca9
Add import from Alibaba Cloud Object Storage Service (#20726)
xuanyu66 e15238c
cloud: add 20250415 release notes (#20757)
qiancai 4dabb4d
best practices: refine java connection pools (#20728) (#20763)
ti-chi-bot 1b1247d
v6.0.0 release notes: update the description of "setting incorrect va…
ti-chi-bot b1a8309
tidb-monitoring-framework: add TiDB Dashboard (#20776) (#20787)
ti-chi-bot e623f07
fix some grammar issues and typo (#20784) (#20791)
ti-chi-bot 4df40e6
cloud: remove outdated cloud roadmap (#20797)
hfxsd 194df99
update prisma-adapter (#20794)
shiyuhang0 e575f2b
Update vector-search-index.md (#20800) (#20804)
ti-chi-bot 3540c36
docs: add attribution for KNN vector search description (#20809) (#20…
ti-chi-bot 504d707
update the default collation of GBK from gbk_bin to gbk_chinese_ci (#…
ti-chi-bot faacb2a
chore: configure gemini bot for doc review (#20803) (#20820)
ti-chi-bot a1a26b6
Serverless Export support OSS (#20783)
shiyuhang0 eb66b97
cloud: add 20250422 release notes (#20836)
qiancai d78dd24
Replace node number with node count (#20811)
yahonda e648f92
serverless support import into (#20832) (#20844)
ti-chi-bot cfd8473
Update tidb-cloud-quickstart.md for AI service provider name (#20842)
zhoubasten d4de26a
releases: add one br entry to v8.1.2 (#20861) (#20862)
ti-chi-bot bf36700
pd configuration: add dashboard.disable-custom-prom-addr (#20853) (#2…
ti-chi-bot 267cd90
add FAQs about collation for JDBC connections (#20848) (#20868)
ti-chi-bot 69d1dd5
hardware-and-software-requirements: update Kylin Euler to Kylin (#208…
ti-chi-bot d5363ec
fix(pd): add missing configuration items for PD (#20883) (#20892)
ti-chi-bot b809d44
JDBC URL: update the letter case for defaultFetchSize (#20884) (#20886)
ti-chi-bot 12c23f4
planner: add doc for `tidb_ignore_inlist_plan_digest`. (#20870) (#20888)
ti-chi-bot 1f125f3
tikv: recorrect the settings of some configs and supplement missing a…
ti-chi-bot f26d007
Add restriction for IMPORT INTO regarding empty (#20562) (#20906)
ti-chi-bot 4d27b3c
tidb-cloud: update LOAD DATA INFILE description (#20917)
lilin90 bf3ee83
Add tidb index usage limitation for valid stats (#20833) (#20911)
ti-chi-bot f76e577
ticdc: add [[filter.event-filters]] to the toml example (#20921) (#20…
ti-chi-bot 622cc50
Serverless restore timeout (#20920)
shiyuhang0 0ddf354
TiDB Cloud Cli v1.0.0-beta.4 (#20838)
shiyuhang0 15cfdcd
cloud: add export speed and note (#20846)
shiyuhang0 4666018
cloud: Add FullText Search docs (#20849) (#20930)
ti-chi-bot 64385d8
cloud: minor wording changes for full-text search docs (#20931)
qiancai 1089ed6
cloud: add links in connected care detail (#20927)
Yujie-Xie 6ba093d
Update load data sql description (#20928)
Frank945946 1331efe
br: clarify PITR restrictions (#20938) (#20943)
ti-chi-bot 1b377d6
tidb-cloud: explain beta (#20947)
lilin90 cdabb9f
Maintenace window 2.0 short (#20901)
nicole-yc 99657e2
cloud: add Performance and Plus storage (#20936)
qqqdan 975d688
cloud: update TiFlash node storage (#20915) (#20949)
ti-chi-bot b09d6ee
cloud: add 20250513 release notes (#20944)
Oreoxmt eeea4b8
cloud: update Backup Setting page (#20950)
Oreoxmt 8e927a3
Update scale-tidb-cluster.md
jinwhu 98a64ba
Update scale-tidb-cluster.md
jinwhu d5a81e2
Update scale-tidb-cluster.md
jinwhu 6858811
Update tidb-cloud/scale-tidb-cluster.md
jinwhu aed90d2
update links
Oreoxmt 761b798
Update size-your-cluster.md
jinwhu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
$schema: "http://json-schema.org/draft-07/schema#" | ||
title: RepoConfig | ||
description: Configuration for Gemini Code Assist on a repository. | ||
|
||
have_fun: false # Disables fun features like poems in PR summaries | ||
|
||
code_review: | ||
disable: false # Enables code reviews | ||
comment_severity_threshold: LOW ## Allows low severity comments such as grammar and spelling mistakes to be added to the PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Documentation Review Style Guide | ||
|
||
## Behavior instruction | ||
|
||
You are acting as a **senior technical writer** who is reviewing TiDB documentation pull requests and you always provide ready-to-commit doc suggestions so the PR author can commit them directly. | ||
|
||
## Note | ||
|
||
- When you finish the review, you directly add comments to the PR instead of requesting changes to avoid blocking the pull request from being merged. | ||
- If the PR author is ti-chi-bot, you only correct English grammar, spelling, and punctuation mistakes, if any. | ||
|
||
## Review aspects | ||
|
||
- Clarity, simplicity, completeness, and readability | ||
- Logical flow and sentence structure | ||
- Technical accuracy and terminology consistency | ||
|
||
## General writing principles | ||
|
||
- Correct English grammar, spelling, and punctuation mistakes, if any. | ||
- Make sure the documentation is easy to understand for TiDB users. | ||
- Write in **second person** ("you") when addressing users. | ||
- Prefer **present tense** unless describing historical behavior. | ||
- Avoid unnecessary words and repetition. | ||
- Use **consistent terminology**. For example: | ||
|
||
- ❌ Do not mix "database" and "instance" | ||
- ✅ Use "replicate" instead of "synchronize" when referring to replicating data from one TiDB cluster to another. | ||
|
||
## Structure and format | ||
|
||
- Use sentence case for headings (e.g., `## Configure the cluster`). | ||
- Use ordered lists (`1.`, `2.`) for steps. | ||
- Code snippets, command names, options, and paths should be in backticks (`` ` ``). | ||
|
||
## Markdown style | ||
|
||
- Add a blank line before and after headings and lists. | ||
- Use proper heading hierarchy (no jumping from `##` to `####`). | ||
|
||
## Common issues to flag | ||
|
||
- Passive voice overuse | ||
|
||
_"The cluster is started by TiUP"_ → _"TiUP starts the cluster"_ | ||
|
||
- Inconsistent use of technical terms | ||
|
||
_"TiDB Cloud Serverless clusters" vs. "TiDB Serverless clusters"_ – pick one. | ||
|
||
- Unclear step instructions | ||
|
||
_"Do it like before"_ → _"Repeat step 3 using the updated config file"_ | ||
|
||
- Grammar and spelling issues | ||
|
||
_"recieve"_ → _"receive"_, _"an TiDB instance"_ → _"a TiDB instance"_ | ||
|
||
## Special notes | ||
|
||
- Follow any existing terminology in our glossary (`/glossary.md` if available). | ||
- When in doubt, favor clarity over cleverness. | ||
- If something might confuse a new user, suggest a reword. | ||
|
||
## Purposes of this style guide | ||
|
||
This guide helps Gemini Code Assist provide actionable, high-quality suggestions for improving technical documentation, especially for PRs related to user guides, how-to articles, and product reference material. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ on: | |
- ".github/**" | ||
branches: | ||
- master | ||
- release-8.1 | ||
- release-7.2 | ||
- release-7.1 | ||
- release-7.0 | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,10 +17,6 @@ jobs: | |
CHANGED_FILES=$(git diff-tree --name-only --diff-filter 'AM' -r HEAD^1 HEAD -- "*.md" | sed -z "s/\n$//;s/\n/' '/g") | ||
echo "all_changed_files=${CHANGED_FILES}" >> $GITHUB_OUTPUT | ||
|
||
- name: Download Exclude Path | ||
run: | | ||
curl https://raw.githubusercontent.com/pingcap/docs/master/.lycheeignore -O | ||
|
||
- name: Link Checker | ||
if: ${{ steps.changed-files.outputs.all_changed_files }} | ||
uses: lycheeverse/[email protected] | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,32 @@ | ||
# See the OWNERS docs at https://go.k8s.io/owners | ||
approvers: | ||
- breezewish | ||
- CaitinChen | ||
- CharLotteiu | ||
- cofyc | ||
- csuzhangxc | ||
- DanielZhangQD | ||
- dcalvin | ||
- dragonly | ||
- en-jin19 | ||
- hfxsd | ||
- Icemap | ||
- jackysp | ||
- kissmydb | ||
- lance6716 | ||
- lichunzhu | ||
- lilin90 | ||
- Liuxiaozhen12 | ||
- morgo | ||
- Oreoxmt | ||
- overvenus | ||
- qiancai | ||
- tangenta | ||
emeritus_approvers: | ||
- CaitinChen | ||
- CharLotteiu | ||
- cofyc | ||
- DanielZhangQD | ||
- dcalvin | ||
- dragonly | ||
- en-jin19 | ||
- lichunzhu | ||
- Liuxiaozhen12 | ||
- morgo | ||
- queenypingcap | ||
- ran-huang | ||
- shichun-0415 | ||
- SunRunAway | ||
- tangenta | ||
- TomShawn | ||
- toutdesuite | ||
- WangXiangUSTC | ||
Comment on lines
+15
to
32
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This change moves several approvers to
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change adds several URLs to the ignore list. It would be helpful to add a brief description or comment explaining why these URLs are being ignored, for future maintainability. This is in line with the style of the file, and the documentation review style guide (lines 14-16) emphasizes clarity and maintainability.
Style Guide References