Skip to content
This repository was archived by the owner on Jan 3, 2025. It is now read-only.

Conversation

qiancai
Copy link
Collaborator

@qiancai qiancai commented Dec 21, 2021

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

As a preparation step of merging DM master docs to TiDB master docs, this PR makes the following changes:

  1. For filenames that already exist in TiDB master docs (for example, alert-rules.md), add the prefix dm- to avoid filename conflicts during the merge, update the corresponding doc links, and add the aliases for the filename changes.
  2. For filenames that might look confusing after merging to TiDB master docs (for example, benchmark-v5.3.0.md), add the prefix dm- to the filenames, update the corresponding doc links, and add the aliases for the filename changes.

Please note that the only purpose of this PR is to show the DM filename changes before merging to TiDB Docs, so this PR is not intended to be merged.

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

  • master (the latest development version)
  • v5.3 (TiDB DM 5.3 versions)
  • 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):

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
Copy link
Member

ti-chi-bot commented Dec 21, 2021

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • shichun-0415

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.

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 added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 21, 2021
@qiancai qiancai added the translation/done This PR has been translated. label Dec 21, 2021
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Dec 21, 2021
@qiancai qiancai requested a review from TomShawn December 21, 2021 03:50
Copy link
Contributor

@shichun-0415 shichun-0415 left a comment

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 Dec 21, 2021
@qiancai qiancai changed the title add the prefix dm- to the filenames for 5 DM docs add the prefix dm- to the filenames for DM docs Dec 21, 2021
@ti-chi-bot ti-chi-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 21, 2021
title: Data Migration Overview
summary: Learn about the Data Migration tool, the architecture, the key components, and features.
aliases: ['/docs/tidb-data-migration/dev/overview/']
aliases: ['/docs/tidb-data-migration/dev/overview/','/tidb-data-migration/dev/overview.md/]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
aliases: ['/docs/tidb-data-migration/dev/overview/','/tidb-data-migration/dev/overview.md/]
aliases: ['/docs/tidb-data-migration/dev/overview/','/tidb-data-migration/dev/overview/]

---
title: Data Migration 简介
aliases: ['/docs-cn/tidb-data-migration/dev/overview/','/docs-cn/tools/dm/overview/']
aliases: ['/docs-cn/tidb-data-migration/dev/overview/','/docs-cn/tools/dm/overview/','/zh/tidb-data-migration/dev/overview.md/]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
aliases: ['/docs-cn/tidb-data-migration/dev/overview/','/docs-cn/tools/dm/overview/','/zh/tidb-data-migration/dev/overview.md/]
aliases: ['/docs-cn/tidb-data-migration/dev/overview/','/docs-cn/tools/dm/overview/','/zh/tidb-data-migration/dev/overview/]

title: Key Features
summary: Learn about the key features of DM and appropriate parameter configurations.
aliases: ['/docs/tidb-data-migration/dev/feature-overview/','/tidb-data-migration/dev/feature-overview']
aliases: ['/docs/tidb-data-migration/dev/feature-overview/','/tidb-data-migration/dev/feature-overview','/tidb-data-migration/dev/key-features.md/]
Copy link
Contributor

Choose a reason for hiding this comment

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

Global comment: aliases 是浏览器里实际出现的 URL,不以 .md 结尾。请批量去掉 aliases 中的 .md。

title: 主要特性
summary: 了解 DM 的各主要功能特性或相关的配置选项。
aliases: ['/docs-cn/tidb-data-migration/dev/key-features/','/docs-cn/tidb-data-migration/dev/feature-overview/']
aliases: ['/docs-cn/tidb-data-migration/dev/key-features/','/docs-cn/tidb-data-migration/dev/feature-overview/','/zh/tidb-data-migration/dev/key-features.md/]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
aliases: ['/docs-cn/tidb-data-migration/dev/key-features/','/docs-cn/tidb-data-migration/dev/feature-overview/','/zh/tidb-data-migration/dev/key-features.md/]
aliases: ['/docs-cn/tidb-data-migration/dev/key-features/','/docs-cn/tidb-data-migration/dev/feature-overview/','/zh/tidb-data-migration/dev/key-features/]

---
title: DM 5.3.0 Benchmark Report
summary: Learn about the performance of 5.3.0.
aliases: ['/tidb-data-migration/dev/benchmark-v5.3.0.md/]
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto

@ti-chi-bot ti-chi-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 21, 2021
@ti-chi-bot ti-chi-bot removed the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 21, 2021
@ti-chi-bot ti-chi-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Dec 21, 2021
@TomShawn TomShawn added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 22, 2021
@TomShawn
Copy link
Contributor

LGTM

@qiancai qiancai changed the title add the prefix dm- to the filenames for DM docs add the prefix dm- to the filenames for some DM dev docs Dec 23, 2021
@qiancai qiancai closed this Feb 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/LGT1 Indicates that a PR has LGTM 1. translation/done This PR has been translated.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants