Skip to content

Relink some missing docs and remove unnecessary docs - #8724

Merged
ti-chi-bot merged 8 commits into
pingcap:masterfrom
sunetic:add-some-missed-docs
Apr 19, 2022
Merged

ti-chi-bot merged 8 commits into
pingcap:masterfrom
sunetic:add-some-missed-docs

Conversation

@sunetic

@sunetic sunetic commented Mar 22, 2022 •

Copy link
Copy Markdown
Contributor

First-time contributors' checklist

What is changed, added or deleted? (Required)

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)
  • v6.0 (TiDB 6.0 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

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

  • This PR is translated from:
  • Other reference 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

@ti-chi-bot

ti-chi-bot commented Mar 22, 2022 •

Copy link
Copy Markdown
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn

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.

@ti-chi-bot
ti-chi-bot requested a review from TomShawn March 22, 2022 07:22
@ti-chi-bot 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 Mar 22, 2022
@shichun-0415 shichun-0415 added translation/doing This PR’s assignee is translating this PR. type/bugfix This PR fixes a bug. area/dm and removed missing-translation-status This PR does not have translation status info. labels Mar 22, 2022
Comment thread TOC.md Resolved
Comment thread TOC.md Resolved
TomShawn
TomShawn previously approved these changes Mar 22, 2022

@TomShawn TomShawn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 22, 2022
@TomShawn TomShawn self-assigned this Mar 22, 2022
@TomShawn TomShawn added the require-LGT1 Indicates that the PR requires an LGTM. label Mar 22, 2022
@TomShawn
TomShawn dismissed their stale review March 22, 2022 09:57

needs reconsider

Comment thread TOC.md Outdated
- [通过 SQL 表达式过滤 DML](/dm/feature-expression-filter.md)
- 迁移任务操作
- [任务前置检查](/dm/dm-precheck.md)
- [配置文件](/dm/task-configuration-file.md)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

这一部分是【入门指南】下的【迁移任务操作】,对应一系列任务,是 Task 导向的。这一篇参考类型的【配置文件】放在这里感觉有些奇怪。

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

task 的配置文件,所有 task 操作的前提就是配置文件

Comment thread TOC.md Resolved
@TomShawn TomShawn assigned sunetic and unassigned TomShawn Mar 22, 2022
Comment thread TOC.md Resolved
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>
Comment thread TOC.md Resolved
@TomShawn

Copy link
Copy Markdown
Contributor

@shichun-0415 删除了这些文件是否需要加 aliases 呢?

@shichun-0415

shichun-0415 commented Mar 23, 2022 •

Copy link
Copy Markdown
Contributor

@shichun-0415 删除了这些文件是否需要加 aliases 呢?

多谢 Tom 提醒,删除的五篇文档中:

  1. quick-create-migration-task.md、scenarios.md 和 task-configuration-file.md 不存在被引用,是否可以直接删除,不加 aliases?
  2. dm-benchmark-v5.3.0.md:docs 仓库两篇文档引用了它。但是,dm 的文档是 5.4 才迁移到 docs 仓库,这篇文档严格说只应存在于 dm 仓库,所以这里是不是可以删除 docs 仓库的这篇文档,然后加外链引用 dm 仓库的这篇文档呢?
  3. shard-merge-best-practices.md:这一篇重新看了,感觉不能直接删,因为有三个文档都引用了它,且没有新的文档供重定向。@SunZhaoyang

@sunetic

sunetic commented Apr 18, 2022

Copy link
Copy Markdown
Contributor Author

@shichun-0415 删除了这些文件是否需要加 aliases 呢?

多谢 Tom 提醒,删除的五篇文档中:

  1. quick-create-migration-task.md、scenarios.md 和 task-configuration-file.md 不存在被引用,是否可以直接删除,不加 aliases?
  2. dm-benchmark-v5.3.0.md:docs 仓库两篇文档引用了它。但是,dm 的文档是 5.4 才迁移到 docs 仓库,这篇文档严格说只应存在于 dm 仓库,所以这里是不是可以删除 docs 仓库的这篇文档,然后加外链引用 dm 仓库的这篇文档呢?
  3. shard-merge-best-practices.md:这一篇重新看了,感觉不能直接删,因为有三个文档都引用了它,且没有新的文档供重定向。@SunZhaoyang
  1. task-configuration-file.md 和 task-configuration-file-full.md 重复了,所以留 full 的这篇就行;quick-create-migration-task.md 有新的 quick-start-with-dm.md 也不需要了;scenarios.md 目录重构后也不需要了;
  2. 可以的。
  3. 可以放到使用示例里先

@TomShawn

Copy link
Copy Markdown
Contributor

@shichun-0415 删除了这些文件是否需要加 aliases 呢?

多谢 Tom 提醒,删除的五篇文档中:

  1. quick-create-migration-task.md、scenarios.md 和 task-configuration-file.md 不存在被引用,是否可以直接删除,不加 aliases?
  2. dm-benchmark-v5.3.0.md:docs 仓库两篇文档引用了它。但是,dm 的文档是 5.4 才迁移到 docs 仓库,这篇文档严格说只应存在于 dm 仓库,所以这里是不是可以删除 docs 仓库的这篇文档,然后加外链引用 dm 仓库的这篇文档呢?
  3. shard-merge-best-practices.md:这一篇重新看了,感觉不能直接删,因为有三个文档都引用了它,且没有新的文档供重定向。@SunZhaoyang
  1. 这些文档都出现在了文档站,直接删除的话,再访问这些页面就是 404,不推荐直接删。
  2. 「docs」仓库是英文仓库,为什么英文仓库会引用中文文档呢?

@TomShawn

TomShawn commented Apr 18, 2022 •

Copy link
Copy Markdown
Contributor

@SunZhaoyang 也请根据 ci / pull (pull_request) 报错提示修复死链,谢谢!

@shichun-0415

Copy link
Copy Markdown
Contributor

@TomShawn 「docs」仓库是英文仓库,为什么英文仓库会引用中文文档呢?----我的问题,想说的是 docs-cn 两篇文档引用了 dm-benchmark-v5.3.0.md。

@shichun-0415

Copy link
Copy Markdown
Contributor

/merge

@ti-chi-bot

Copy link
Copy Markdown
Member

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

DetailsCommit hash: 0225cb6

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 19, 2022
@ti-chi-bot
ti-chi-bot merged commit e754835 into pingcap:master Apr 19, 2022
@ti-chi-bot ti-chi-bot mentioned this pull request Apr 19, 2022
4 of 16 tasks
@ti-chi-bot

Copy link
Copy Markdown
Member

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

ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request Apr 19, 2022
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
ti-chi-bot pushed a commit to ti-chi-bot/docs-cn that referenced this pull request Apr 19, 2022
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot mentioned this pull request Apr 19, 2022
4 of 16 tasks
@ti-chi-bot

Copy link
Copy Markdown
Member

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

ti-chi-bot added a commit that referenced this pull request Apr 19, 2022
ti-chi-bot added a commit that referenced this pull request Apr 19, 2022
@shichun-0415 shichun-0415 changed the title Relink some missed docs Relink some missing docs and remove unnecessary docs Apr 19, 2022
@shichun-0415 shichun-0415 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 Apr 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/dm require-LGT1 Indicates that the PR requires an LGTM. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants