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

*: refine data migration document #2244

Merged
merged 13 commits into from
Feb 18, 2020
Merged

*: refine data migration document #2244

merged 13 commits into from
Feb 18, 2020

Conversation

IANTHEREAL
Copy link
Contributor

@IANTHEREAL IANTHEREAL commented Feb 14, 2020

What is changed, added or deleted?

refine document releated data migration

  • remove operation tutorial base on syncer/loader, migrate/from-mysql.md and incrementally-from-mysql.md
  • replace 迁移概述 by 工具使用指南
  • update TOC
  • remove br from 工具使用指南 3.0

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

  • Reference link(s):
  • This PR is to align with:
  • N/A (not applicable)

Which TiDB version(s) does your changes apply to?

  • All active versions: dev, v3.0, v2.1, v3.1
  • dev (the latest development version)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)
  • v3.1 (TiDB 3.1 versions)
  • v4.0 (TiDB 4.0 versions)
  • All active and inactive versions
  • N/A (not applicable)

Note: If your changes apply to multiple TiDB versions, make sure you update the documents in the corresponding version folders such as "dev", "v3.0", "v2.1" and "v3.1" in this PR.

  • Updated one version first. Will update other versions after I get two LGTMs.

@IANTHEREAL
Copy link
Contributor Author

@TomShawn TomShawn added size/large Changes of a large size. translation/doing This PR’s assignee is translating this PR. labels Feb 14, 2020
@TomShawn TomShawn changed the title refine data migration document *: refine data migration document Feb 14, 2020
@IANTHEREAL IANTHEREAL added v3.0 v4.0 This PR/issue applies to TiDB v4.0. labels Feb 14, 2020
@WangXiangUSTC
Copy link
Contributor

LGTM

Copy link
Member

@csuzhangxc csuzhangxc left a comment

Choose a reason for hiding this comment

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

LGTM

@csuzhangxc csuzhangxc added the status/LGT2 Indicates that a PR has LGTM 2. label Feb 14, 2020
dev/TOC.md Outdated
@@ -51,11 +51,9 @@
- [概述](/dev/how-to/monitor/overview.md)
- [监控 TiDB 集群](/dev/how-to/monitor/monitor-a-cluster.md)
+ 迁移
- [概述](/dev/how-to/migrate/overview.md)
- [工具使用指南](/dev/reference/tools/use-guide.md)
Copy link
Contributor

@kissmydb kissmydb Feb 14, 2020

Choose a reason for hiding this comment

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

1、这个链接应该指向迁移方案那一部分,而不是所有工具的指南
2、原来的[概述]被删掉了,里面有一些好的地方。比如,新加的这个指南里,“什么场景使用什么样的迁移方式”感觉可以再清晰一些(简写了建议的思路):
a、MySQL 1T 以上:mydumper+lightning 全量,dm 做增量(这个文档貌似没有)
b、MySQL 1T 以下:dm 全量+增量(已经有了)
c、非 MySQL,如 CSV

Copy link
Contributor Author

Choose a reason for hiding this comment

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

这个指南里面也涉及 “什么场景使用什么样的迁移方式”,而且更加合理和全面。其实 1T 这个算是拍脑袋的数据。 此外合并两个文档的原因是,不想维护两份,另外这个指南其实都是迁移相关,可能名字不够直接

dev/how-to/migrate/from-mysql-aurora.md Show resolved Hide resolved
title: 从 Amazon Aurora MySQL 迁移数据
summary: 使用 DM 从 Amazon Aurora MySQL 迁移数据。
title: 从 MySQL/Amazon Aurora MySQL 迁移数据
summary: 使用 DM 从 MySQL/Amazon Aurora MySQL 迁移数据。
category: how-to
---

# 从 Amazon Aurora MySQL 迁移数据
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
# 从 Amazon Aurora MySQL 迁移数据
# MySQL/Amazon Aurora MySQL 迁移数据

v3.0/how-to/migrate/from-mysql-aurora.md Show resolved Hide resolved
v3.0/reference/tools/use-guide.md Outdated Show resolved Hide resolved
v3.0/reference/tools/use-guide.md Show resolved Hide resolved
@TomShawn
Copy link
Contributor

还需在各版本 use-guide.md 的 metadata 部分添加被删去文档的 aliases:

  • ['/docs-cn/dev/how-to/migrate/from-mysql/']
  • ['/docs-cn/dev/how-to/migrate/incrementally-from-mysql/']
  • ['/docs-cn/dev/how-to/migrate/overview/']

@TomShawn TomShawn removed the v4.0 This PR/issue applies to TiDB v4.0. label Feb 14, 2020
@lilin90 lilin90 added the DNM label Feb 14, 2020
dev/how-to/migrate/from-mysql-aurora.md Show resolved Hide resolved
@@ -1,6 +1,7 @@
---
Copy link
Member

@lilin90 lilin90 Feb 17, 2020

Choose a reason for hiding this comment

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

  • 这个文件取代了原迁移概述,内容性质一样,也很重要,属于直接使用类,而非辅助参考类,不建议放在 reference 下,建议采用原来的目录即可: dev/how-to/migrate/overview.md。因为这篇文档是总括性质的,个人认为可以用 overview.md
  • 数据迁移解决方案 提到 工具演进路线 前面?演进路线更像一个参考类内容,个人认为解决方案内容的优先级高于演讲路线。

@kissmydb 怎么看?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • 原来的概述不是“直接使用类”的,是介绍可以用什么工具来进行全量备份和恢复,是 “指引类” 的,use-guide.md 也是指引类的。
  • 这个 link 直接跳转到 tidb-集群数据的全量备份及恢复

另外用户反馈 use-guide.md 这个 page 可以让他们获得他们想要的所有信息,所以我们集中只维护一个 “指引类” 的页面

Copy link
Member

Choose a reason for hiding this comment

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

@GregoryIan

  • 这里概述的功能是指引用户如何根据自己的场景选择工具,是直接使用前必要的一步;而参考类文档通常带有辅助性质。所以,放在前面的目录里更能凸显重要性。
  • 在 how-to 的迁移章节只放一个链接的话,PDF 用户无法在前面得到想要的信息。建议将该文档放在 how-to 里,下面的 reference 工具下放链接。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

我们不是都是靠 TOC 来索引的吗? 所以具体内容放在哪里其实没有关系。为什么放在 reference/tools 下面是因为,有人反馈过,他们习惯性去 reference/tools 下面找 tools 的所有文档,反而不会去 how-to

Copy link
Contributor Author

Choose a reason for hiding this comment

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

其实我不太明白,你表达什么 @lilin90

v2.1/how-to/migrate/from-aurora.md Outdated Show resolved Hide resolved
dev/TOC.md Show resolved Hide resolved
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

@lilin90 lilin90 removed the DNM label Feb 18, 2020
@IANTHEREAL IANTHEREAL merged commit 8f4916b into pingcap:master Feb 18, 2020
@IANTHEREAL IANTHEREAL deleted the refine-migration branch February 18, 2020 03:49
@TomShawn TomShawn added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed size/large Changes of a large size. translation/doing This PR’s assignee is translating this PR. labels Mar 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants