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

add the prefix dm- to the filenames for some stable DM docs #872

Merged
merged 3 commits into from
Dec 28, 2021
Merged

add the prefix dm- to the filenames for some stable DM docs #872

merged 3 commits into from
Dec 28, 2021

Conversation

qiancai
Copy link
Collaborator

@qiancai qiancai commented Dec 23, 2021 •
edited
Loading

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

As the following two PRs are merged, once a newer stable TiDB version is released in the future, the DM stable docs are included in TiDB stable docs naturally.

At that time, the current DM stable links will be changed to v5.3 links. If users save a DM stable doc link, clicking the link is expected to be redirected to the corresponding DM section in TiDB docs.

As a prerequisite of directing DM stable docs to TiDB stable docs after a newer stable TiDB version is released, this PR makes the following changes to avoid deadlinks:

  1. For filenames that already exist in TiDB 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 23, 2021 •
edited
Loading

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

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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 23, 2021
@ti-chi-bot ti-chi-bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 23, 2021
@ti-chi-bot ti-chi-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 23, 2021
@qiancai qiancai changed the title add the prefix dm- to the filenames for DM docs add the prefix dm- to the filenames for some stable DM docs Dec 23, 2021
@qiancai qiancai added the translation/done This PR has been translated. label Dec 23, 2021
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Dec 23, 2021
TomShawn
TomShawn reviewed Dec 23, 2021
View reviewed changes
en/dm-alert-rules.md
---
title: DM Alert Information
summary: Introduce the alert information of DM.
aliases: ['/tidb-data-migration/stable/alert-rules/']
Copy link
Contributor

@TomShawn TomShawn Dec 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Global comment: for each alias in v5.3, another /v5.3/ should be added. So each renamed file corresponds to two aliases.

Suggested change
aliases: ['/tidb-data-migration/stable/alert-rules/']
aliases: ['/tidb-data-migration/stable/alert-rules/','/tidb-data-migration/v5.3/alert-rules/']

Copy link
Collaborator Author

@qiancai qiancai Dec 23, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

After a new TiDB stable version is released, /tidb-data-migration/stable/dm-alert-rules/will be changed to /tidb-data-migration/v5.3/dm-alert-rules/, but /tidb-data-migration/stable/alert-rules/ will not be changed /tidb-data-migration/v5.3/alert-rules/ because /tidb-data-migration/stable/alert-rules/ is remove from this PR.

In this case, there is no chance that anyone saves the /tidb-data-migration/v5.3/alert-rules/ link, so we do not need to add an alias for it.

TomShawn
TomShawn approved these changes Dec 23, 2021
View reviewed changes
Copy link
Contributor

@TomShawn TomShawn 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 23, 2021
lilin90
lilin90 approved these changes Dec 23, 2021
View reviewed changes
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

LGTM

@qiancai
Copy link
Collaborator Author

qiancai commented Dec 28, 2021

/remove-status LGT1
/status LGT2

@ti-chi-bot 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 Dec 28, 2021
@qiancai
Copy link
Collaborator Author

qiancai commented Dec 28, 2021

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: e9bb9e2

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Dec 28, 2021
@ti-chi-bot ti-chi-bot merged commit 6e418cb into pingcap:release-5.3 Dec 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shichun-0415 shichun-0415 Awaiting requested review from shichun-0415

3 more reviewers

@sunzhaoyang sunzhaoyang sunzhaoyang approved these changes

@lilin90 lilin90 lilin90 approved these changes

@TomShawn TomShawn TomShawn approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@qiancai @ti-chi-bot @sunzhaoyang @lilin90 @TomShawn