cdc: reformat Changefeed config and Server config #19166

Oreoxmt · 2024-11-28T09:11:51Z

What is changed, added or deleted? (Required)

This PR is a first step. It converts the existing format of code blocks to the body heading format for config descriptions in CLI and Configuration Parameters of TiCDC Changefeeds | TiDB Docs and TiCDC Server Configurations | TiDB Docs, like that in TiDB Configuration File | TiDB Docs.

This PR doesn't add new descriptions, except describe some config value as 示例值 for now, because those config items have no description or default value. Some missing explanations need to be added in new PRs.

cdc: reformat Changefeed config and Server config
ref: pingcap/docs#19522 and pingcap/docs#19521

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s): Reformat the config file documentation format of DM, Lightning, TiCDC, TiFlash to the same as that of TiDB, TiKV, PD, TiProxy docs#19005

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Signed-off-by: Aolin <[email protected]>

ti-chi-bot · 2024-11-28T09:11:54Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

…ommit pingcap/docs-cn@3f4c437

Signed-off-by: Aolin <[email protected]>

…ommit pingcap/docs-cn@82be93b

Oreoxmt · 2024-12-09T10:47:07Z

ticdc/ticdc-changefeed-config.md

Preview: https://pingcap-docsite-preview-git-preview-pi-364f09-oreoxmts-projects.vercel.app/zh/tidb/dev/ticdc-changefeed-config

ticdc/ticdc-changefeed-config.md

…ommit pingcap/docs-cn@77fe5d2

Oreoxmt · 2024-12-09T10:55:44Z

ticdc/ticdc-server-config.md

Preview: https://pingcap-docsite-preview-git-preview-pi-364f09-oreoxmts-projects.vercel.app/zh/tidb/dev/ticdc-server-config

Oreoxmt · 2024-12-10T02:40:31Z

/cc @lilin90

ticdc/ticdc-changefeed-config.md

ticdc/ticdc-server-config.md

ti-chi-bot · 2024-12-10T09:26:37Z

[LGTM Timeline notifier]

Timeline:

2024-12-10 09:26:36.997798493 +0000 UTC m=+344187.086601036: ☑️ agreed by hfxsd.

Co-authored-by: xixirangrang <[email protected]>

…ommit pingcap/docs-cn@68b6f7a

Signed-off-by: Aolin <[email protected]>

ti-chi-bot · 2024-12-20T03:38:25Z

@flowbehappy: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Oreoxmt · 2024-12-20T03:48:04Z

/approve

Oreoxmt · 2024-12-20T03:48:08Z

/unhold

ti-chi-bot · 2024-12-20T03:48:12Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Oreoxmt

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [Oreoxmt]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ti-chi-bot · 2024-12-20T03:51:37Z

In response to a cherrypick label: new pull request created to branch release-8.5: #19331.

cdc: reformat Changefeed config and Server config

3f4c437

Signed-off-by: Aolin <[email protected]>

ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 28, 2024

Oreoxmt self-assigned this Nov 28, 2024

ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Nov 28, 2024

ti-chi-bot bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Nov 28, 2024

Oreoxmt added the translation/doing This PR’s assignee is translating this PR. label Nov 28, 2024

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Nov 28, 2024

Preview PR pingcap/docs-cn#19166 and this preview is triggered from c…

4347ace

…ommit pingcap/docs-cn@3f4c437

Oreoxmt added 2 commits December 9, 2024 17:20

reformat ticdc-server-config.md

967c31c

Signed-off-by: Aolin <[email protected]>

reformat ticdc-changefeed-config.md

82be93b

Signed-off-by: Aolin <[email protected]>

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Dec 9, 2024

Preview PR pingcap/docs-cn#19166 and this preview is triggered from c…

ac4790e

…ommit pingcap/docs-cn@82be93b

Oreoxmt commented Dec 9, 2024

View reviewed changes

ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved

Oreoxmt commented Dec 9, 2024

View reviewed changes

ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved

fix format

77fe5d2

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Dec 9, 2024

Preview PR pingcap/docs-cn#19166 and this preview is triggered from c…

31f1a03

…ommit pingcap/docs-cn@77fe5d2

Oreoxmt commented Dec 9, 2024

View reviewed changes

Oreoxmt marked this pull request as ready for review December 10, 2024 02:40

ti-chi-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 10, 2024

ti-chi-bot bot requested a review from lilin90 December 10, 2024 02:40

hfxsd self-requested a review December 10, 2024 08:09

hfxsd approved these changes Dec 10, 2024

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Dec 10, 2024

fix format

4cfc883

Co-authored-by: xixirangrang <[email protected]>

Oreoxmt and others added 2 commits December 11, 2024 16:52

fix format

f834312

Co-authored-by: xixirangrang <[email protected]>

update unit of max-log-size

68b6f7a

Co-authored-by: xixirangrang <[email protected]>

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Dec 11, 2024

Preview PR pingcap/docs-cn#19166 and this preview is triggered from c…

3209fa6

…ommit pingcap/docs-cn@68b6f7a

fix format

af2164d

Signed-off-by: Aolin <[email protected]>

Oreoxmt mentioned this pull request Dec 11, 2024

cdc: reformat Changefeed config and Server config pingcap/docs#19654

Merged

16 tasks

Oreoxmt added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Dec 11, 2024

make ci happy

d6eb9fd

Signed-off-by: Aolin <[email protected]>

lilin90 requested a review from flowbehappy December 12, 2024 06:15

flowbehappy approved these changes Dec 20, 2024

View reviewed changes

make ci happy

66092bb

Oreoxmt added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Dec 20, 2024

This was referenced Dec 20, 2024

reformat TiCDC Server config file to the same as that of TiDB pingcap/docs#19521

Open

reformat TiCDC changefeed config file to the same as that of TiDB pingcap/docs#19522

Open

Oreoxmt added the lgtm label Dec 20, 2024

ti-chi-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 20, 2024

ti-chi-bot bot added the approved label Dec 20, 2024

ti-chi-bot bot merged commit 47f49f3 into pingcap:master Dec 20, 2024
7 checks passed

Oreoxmt deleted the reformat-config-ticdc branch December 20, 2024 03:51

ti-chi-bot mentioned this pull request Dec 20, 2024

cdc: reformat Changefeed config and Server config (#19166) #19331

Merged

16 tasks

ti-chi-bot bot pushed a commit that referenced this pull request Dec 20, 2024

cdc: reformat Changefeed config and Server config (#19166) (#19331)

45e6dfd

ti-chi-bot mentioned this pull request Dec 24, 2024

cdc: reformat Changefeed config and Server config (#19654) pingcap/docs#19782

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cdc: reformat Changefeed config and Server config #19166

cdc: reformat Changefeed config and Server config #19166

Oreoxmt commented Nov 28, 2024 •

edited

Loading

ti-chi-bot bot commented Nov 28, 2024

Oreoxmt Dec 9, 2024

Oreoxmt Dec 9, 2024

Oreoxmt commented Dec 10, 2024

ti-chi-bot bot commented Dec 10, 2024

ti-chi-bot bot commented Dec 20, 2024

Oreoxmt commented Dec 20, 2024

Oreoxmt commented Dec 20, 2024

ti-chi-bot bot commented Dec 20, 2024

ti-chi-bot commented Dec 20, 2024

cdc: reformat Changefeed config and Server config #19166

cdc: reformat Changefeed config and Server config #19166

Conversation

Oreoxmt commented Nov 28, 2024 • edited Loading

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

ti-chi-bot bot commented Nov 28, 2024

Oreoxmt Dec 9, 2024

Choose a reason for hiding this comment

Oreoxmt Dec 9, 2024

Choose a reason for hiding this comment

Oreoxmt commented Dec 10, 2024

ti-chi-bot bot commented Dec 10, 2024

[LGTM Timeline notifier]

ti-chi-bot bot commented Dec 20, 2024

Oreoxmt commented Dec 20, 2024

Oreoxmt commented Dec 20, 2024

ti-chi-bot bot commented Dec 20, 2024

ti-chi-bot commented Dec 20, 2024

Oreoxmt commented Nov 28, 2024 •

edited

Loading