zh,en: make the description clearer on how to use the configs #819

Liuxiaozhen12 · 2021-11-01T03:22:36Z

First-time contributors' checklist

I've signed Contributor License Agreement that's required for repo owners to accept my contribution.

What is changed, added, or deleted? (Required)

Make the description clearer to close #733.

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

master (the latest development version)
v2.0 (TiDB DM 2.0 versions)
v1.0 (TiDB DM 1.0 versions)

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

This PR is translated from:
Other reference link(s): Update dm doc to make it clear for is-sharding and shard-mode configuration usage #733

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

ti-chi-bot · 2021-11-01T03:22:37Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

hfxsd

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Details

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

Liuxiaozhen12 · 2021-11-01T03:43:57Z

zh/task-configuration-guide.md

 ## ********* 任务信息配置 *********
 name: test                      # 任务名称，需要全局唯一
-shard-mode: "pessimistic"       # 如果为分库分表合并任务则需要配置该项。默认使用悲观协调模式 "pessimistic"，在深入了解乐观协调模式的原理和使用限制后，也可以设置为乐观协调模式 "optimistic"
+is-sharding: true 


I'm not sure if we should add the config item like this (as mentioned in the related issue #733). If we do, should I add it in all the DM task configuration files? Please help to review it, thx! @lance6716

is-sharding is a deprecated config field and its meaning is cover by shard-mode. So we needn't explicitly set it. This field is only used for the compatibility of legacy configs.

zh/task-configuration-file-full.md

hfxsd

LGTM

glorv

rest LGTM

glorv · 2021-11-25T09:20:56Z

zh/key-features.md

 ### 参数配置

-在 task 的配置文件中设置：
+在 task 的配置文件中将 `is-sharding` 设置为 `true`：


is-sharding 不推荐再显示申明了，建议新的示例配置里面都不要提这个字段

glorv

rest LGTM

glorv · 2021-11-26T04:18:53Z

en/feature-online-ddl.md

 name: test                      # The name of the task. Should be globally unique.
 task-mode: all                  # The task mode. Can be set to `full`/`incremental`/`all`.
-shard-mode: "pessimistic"       # You need to configure this if it is a shard merge task. The "pessimistic" mode is used by default. After understanding the principles and restrictions of the "optimistic" mode, you can set it to the "optimistic" mode.
+shard-mode: "pessimistic"       # The shard merge mode. Optional modes are ""/"pessimistic"/"optimistic". The "" mode is used by default which means no specific mode is required. If the task is a shard merge task, set it to the "pessimistic" mode. After understanding the principles and restrictions of the "optimistic" mode, you can set it to the "optimistic" mode.


Suggested change

shard-mode: "pessimistic" # The shard merge mode. Optional modes are ""/"pessimistic"/"optimistic". The "" mode is used by default which means no specific mode is required. If the task is a shard merge task, set it to the "pessimistic" mode. After understanding the principles and restrictions of the "optimistic" mode, you can set it to the "optimistic" mode.

shard-mode: "pessimistic" # The shard merge mode. Optional modes are ""/"pessimistic"/"optimistic". The "" mode is used by default which means sharding DDL merge is disabled. If the task is a shard merge task, set it to the "pessimistic" mode. After understanding the principles and restrictions of the "optimistic" mode, you can set it to the "optimistic" mode.

glorv · 2021-11-26T04:21:07Z

zh/faq.md

 ## DM v2.0.0 启动任务时出现 `fail to initial unit Sync of subtask`，报错信息的 `RawCause` 显示 `context deadline exceeded`

-该问题是 DM v2.0.0 版本的已知问题，在同步任务的表数目较多时触发，将在 v2.0.1 修复。使用 TiUP 部署的用户可以升级到开发版 nightly 解决该问题，或者访问 GitHub 上 [DM 仓库的 release 页面](https://github.com/pingcap/ticdc/releases)下载 v2.0.0-hotfix 版本手动替换可执行文件。
+该问题是 DM v2.0.0 的已知问题，在同步任务的表数目较多时触发，将在 v2.0.1 修复。使用 TiUP 部署的用户可以升级到开发版 nightly 解决该问题，或者访问 GitHub 上 [DM 仓库的 release 页面](https://github.com/pingcap/dm/releases)下载 v2.0.0-hotfix 版本手动替换可执行文件。


dm 合并到 cdc 之后，最新的 release 也会在 cdc 仓库，我们这里是不是还是放 cdc release 的链接比较合理，用户看到的就是最新版本的 release 了。(v2.x 的 release 将不会包含在里面)

喔喔谢谢提醒！这里解决冲突的时候搞错了

zh/faq.md

Liuxiaozhen12 · 2021-11-26T08:43:52Z

/remove-status LGT1
/status LGT2

Liuxiaozhen12 · 2021-11-26T08:44:55Z

/merge

ti-chi-bot · 2021-11-26T08:44:58Z

This pull request has been accepted and is ready to merge.

Details

Commit hash: 3291bf8

ti-chi-bot · 2021-11-26T08:45:50Z

In response to a cherrypick label: new pull request created: #844.

ti-chi-bot · 2021-11-26T08:46:25Z

In response to a cherrypick label: new pull request created: #845.

…844)

…845)

Make the description clearer on how to use the two configs

cb62696

ti-chi-bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 1, 2021

make all the Chinese expressions clearer

7471da2

ti-chi-bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 1, 2021

Liuxiaozhen12 added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/doing This PR’s assignee is translating this PR. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 1, 2021

Liuxiaozhen12 self-assigned this Nov 1, 2021

ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Nov 1, 2021

Liuxiaozhen12 commented Nov 1, 2021

View reviewed changes

Liuxiaozhen12 requested review from hfxsd and lance6716 November 1, 2021 03:44

Liuxiaozhen12 added the needs-cherry-pick-release-2.0 Should cherry pick this PR to release-2.0 branch. label Nov 1, 2021

ti-chi-bot removed the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 1, 2021

Liuxiaozhen12 requested a review from fubinzh November 1, 2021 03:58

ti-chi-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 1, 2021

hfxsd reviewed Nov 10, 2021

View reviewed changes

zh/task-configuration-file-full.md Show resolved Hide resolved

hfxsd approved these changes Nov 10, 2021

View reviewed changes

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Nov 10, 2021

glorv reviewed Nov 17, 2021

View reviewed changes

Liuxiaozhen12 added the needs-cherry-pick-release-5.3 Should cherry pick this PR to release-5.3 branch. label Nov 19, 2021

Liuxiaozhen12 changed the title ~~Make the description clearer on how to use the two configs~~ zh: make the description clearer on how to use the configs Nov 25, 2021

glorv reviewed Nov 25, 2021

View reviewed changes

Liuxiaozhen12 added 2 commits November 25, 2021 18:23

Update task-configuration-guide.md

319efb7

address comments

3ec957c

ti-chi-bot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 26, 2021

ti-chi-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 26, 2021

Liuxiaozhen12 added 2 commits November 26, 2021 11:04

Update key-features.md

8e76db7

Merge branch 'master' into add-descrption-for-shard-mode

c5452f3

ti-chi-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 26, 2021

Liuxiaozhen12 added translation/no-need The changes in this PR don't need to be translated. and removed translation/doing This PR’s assignee is translating this PR. labels Nov 26, 2021

Liuxiaozhen12 changed the title ~~zh: make the description clearer on how to use the configs~~ zh,en: make the description clearer on how to use the configs Nov 26, 2021

glorv reviewed Nov 26, 2021

View reviewed changes

Liuxiaozhen12 commented Nov 26, 2021

View reviewed changes

zh/faq.md Outdated Show resolved Hide resolved

Liuxiaozhen12 added 2 commits November 26, 2021 16:39

Apply suggestions from code review

491c370

address comments

3291bf8

Liuxiaozhen12 requested a review from glorv November 26, 2021 08:43

ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Nov 26, 2021

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Nov 26, 2021

Liuxiaozhen12 merged commit fa447cc into pingcap:master Nov 26, 2021

Liuxiaozhen12 deleted the add-descrption-for-shard-mode branch November 26, 2021 08:45

ti-chi-bot mentioned this pull request Nov 26, 2021

zh,en: make the description clearer on how to use the configs (#819) #844

Merged

8 tasks

ti-chi-bot mentioned this pull request Nov 26, 2021

zh,en: make the description clearer on how to use the configs (#819) #845

Merged

8 tasks

ti-chi-bot added a commit that referenced this pull request Nov 26, 2021

zh,en: make the description clearer on how to use the configs (#819) (#…

fa9d24f

…844)

ti-chi-bot added a commit that referenced this pull request Nov 26, 2021

zh,en: make the description clearer on how to use the configs (#819) (#…

d7fd005

…845)

	shard-mode: "pessimistic" # The shard merge mode. Optional modes are ""/"pessimistic"/"optimistic". The "" mode is used by default which means no specific mode is required. If the task is a shard merge task, set it to the "pessimistic" mode. After understanding the principles and restrictions of the "optimistic" mode, you can set it to the "optimistic" mode.
	shard-mode: "pessimistic" # The shard merge mode. Optional modes are ""/"pessimistic"/"optimistic". The "" mode is used by default which means sharding DDL merge is disabled. If the task is a shard merge task, set it to the "pessimistic" mode. After understanding the principles and restrictions of the "optimistic" mode, you can set it to the "optimistic" mode.

zh,en: make the description clearer on how to use the configs #819

zh,en: make the description clearer on how to use the configs #819

Uh oh!

Conversation

Liuxiaozhen12 commented Nov 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added, or deleted? (Required)

Which DM 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?

Uh oh!

ti-chi-bot commented Nov 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Liuxiaozhen12 Nov 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

glorv Nov 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hfxsd left a comment

Choose a reason for hiding this comment

Uh oh!

glorv left a comment

Choose a reason for hiding this comment

Uh oh!

glorv Nov 25, 2021

Choose a reason for hiding this comment

Uh oh!

glorv left a comment

Choose a reason for hiding this comment

Uh oh!

glorv Nov 26, 2021

Choose a reason for hiding this comment

Uh oh!

glorv Nov 26, 2021

Choose a reason for hiding this comment

Uh oh!

Liuxiaozhen12 Nov 26, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Liuxiaozhen12 commented Nov 26, 2021

Uh oh!

Liuxiaozhen12 commented Nov 26, 2021

Uh oh!

ti-chi-bot commented Nov 26, 2021

Uh oh!

ti-chi-bot commented Nov 26, 2021

Uh oh!

ti-chi-bot commented Nov 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Liuxiaozhen12 commented Nov 1, 2021 •

edited

Loading

ti-chi-bot commented Nov 1, 2021 •

edited

Loading

Liuxiaozhen12 Nov 1, 2021 •

edited

Loading

glorv Nov 17, 2021 •

edited

Loading