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.

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

cdc: reformat Changefeed config and Server config #19166

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

Oreoxmt
Copy link
Collaborator

@Oreoxmt Oreoxmt commented Nov 28, 2024

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).

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

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

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

Copy link

ti-chi-bot bot commented Nov 28, 2024

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

@ti-chi-bot 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 Oreoxmt self-assigned this Nov 28, 2024
Copy link

ti-chi-bot bot commented Nov 28, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from oreoxmt, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

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 ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Nov 28, 2024
@Oreoxmt Oreoxmt added type/enhancement The issue or PR belongs to an enhancement. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. and removed missing-translation-status This PR does not have translation status info. labels Nov 28, 2024
@ti-chi-bot ti-chi-bot bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Nov 28, 2024
@Oreoxmt 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
github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Dec 9, 2024
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Oreoxmt Oreoxmt marked this pull request as ready for review December 10, 2024 02:40
@ti-chi-bot 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
@Oreoxmt
Copy link
Collaborator Author

Oreoxmt commented Dec 10, 2024

/cc @lilin90

@ti-chi-bot ti-chi-bot bot requested a review from lilin90 December 10, 2024 02:40
@hfxsd hfxsd self-requested a review December 10, 2024 08:09
ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-changefeed-config.md Show resolved Hide resolved
ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-changefeed-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-server-config.md Outdated Show resolved Hide resolved
ticdc/ticdc-server-config.md Outdated Show resolved Hide resolved
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Dec 10, 2024
Copy link

ti-chi-bot bot commented Dec 10, 2024

[LGTM Timeline notifier]

Timeline:

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

Oreoxmt and others added 3 commits December 10, 2024 17:39
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
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
Signed-off-by: Aolin <[email protected]>
@Oreoxmt 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
Signed-off-by: Aolin <[email protected]>
@lilin90 lilin90 requested a review from flowbehappy December 12, 2024 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants