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.

Sign up for GitHub

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

Jump to bottom

BR: reorganize content about BR tool #5299

Merged
merged 22 commits into from
Jan 27, 2021
Merged

BR: reorganize content about BR tool #5299

merged 22 commits into from
Jan 27, 2021

Conversation

yikeke
Copy link
Contributor

@yikeke yikeke commented Jan 12, 2021 •
edited
Loading

What is changed, added or deleted? (Required)

主要改了 /br/use-br-command-line-tool.md、br/backup-and-restore-tool.md、br/backup-and-restore-use-cases.md 三个文档，旨在加强 BR 文档间的连接，优化用户获取内容的路径，方便索引。

  1. 将使用 BR 命令行工具的部分单独拆到了 /br/use-br-command-line-tool.md 文档中， preview
  2. 将 br/backup-and-restore-tool.md 文档变成 BR 工具简介 (overview) 文档，并总结了使用 BR 的三种方式，结尾处给出了 BR 所有文档的链接 preview
  3. 将 最佳实践 部分与 使用限制 部分分开，更加易读，方便引用
  4. 优化了 use case 文档 preview
  5. 在 BR 简介文档中给了 BR 存储文档的链接
  6. 将 /backup-and-restore-using-dumpling-lightning.md 从 TOC 移除，见BR: reorganize content about BR tool #5299 (comment)

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

  • master (the latest development version)
  • 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

@yikeke yikeke marked this pull request as draft January 12, 2021 10:39
@yikeke yikeke added needs-cherry-pick-3.1 translation/doing This PR’s assignee is translating this PR. labels Jan 12, 2021
@yikeke yikeke self-assigned this Jan 12, 2021
@yikeke yikeke marked this pull request as ready for review January 12, 2021 11:40
IANTHEREAL
IANTHEREAL reviewed Jan 14, 2021
View reviewed changes
br/backup-and-restore-use-cases.md Outdated

本文展示了以下几种备份和恢复场景下的 BR 操作过程：

* 将单表数据备份到网络盘（推荐）
Copy link
Contributor

Choose a reason for hiding this comment

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

「将单表数据备份到网络盘」和 「从网络磁盘恢复备份数据」 推荐生产使用，其余的两个只推荐测试使用。

为了有更鲜明的区分，我建议把 use case 拆成两个文档，前者针对推荐生产使用，后者标明只适合测试开发环境试用

Copy link
Contributor Author

Choose a reason for hiding this comment

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

这样的话，前面的「环境准备」一节和最后的「备份过程中的异常处理」一节对于拆分的两个文档是否是一样的？

Copy link
Contributor

Choose a reason for hiding this comment

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

我看了一下大体可以保持一样，不过细节建议 @3pointer 确认一下有没有问题

Copy link
Contributor Author

Choose a reason for hiding this comment

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

如果要拆，建议面向不同的目的（生产用和测试用）稍微重新设计一下两篇文章，让区分更明显。

如果除了操作部分，其他的内容（准备部分和后面的异常处理部分）在两篇文章里是重复的，我建议就不要拆了，目前这样可能更有助于用户在同一篇文档里获取更全面的信息，这一点可以听一听 @Ishiihara 的意见？

@yikeke yikeke requested a review from 3pointer January 19, 2021 09:25
@IANTHEREAL
Copy link
Contributor

LGTM! thanks @yikeke

Ishiihara
Ishiihara approved these changes Jan 25, 2021
View reviewed changes
Copy link

@Ishiihara Ishiihara 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-srebot
Copy link
Contributor

@Ishiihara, Thanks for your review. The bot only counts LGTMs from Reviewers and higher roles, but you're still welcome to leave your comments. See the corresponding SIG page for more information. Related SIG: docs(slack).

@yikeke yikeke requested a review from lilin90 January 25, 2021 02:14
lilin90
lilin90 reviewed Jan 25, 2021
View reviewed changes
backup-and-restore-using-dumpling-lightning.md Show resolved Hide resolved
backup-and-restore-using-dumpling-lightning.md Outdated Show resolved Hide resolved
br/backup-and-restore-use-cases.md Outdated Show resolved Hide resolved
br/use-br-command-line-tool.md Outdated Show resolved Hide resolved
br/use-br-command-line-tool.md Outdated Show resolved Hide resolved
br/use-br-command-line-tool.md Outdated Show resolved Hide resolved
br/use-br-command-line-tool.md Outdated Show resolved Hide resolved
lilin90
lilin90 approved these changes Jan 27, 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

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jan 27, 2021
@yikeke yikeke merged commit 8dad50b into pingcap:master Jan 27, 2021
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 27, 2021
@yikeke @ti-srebot
cherry pick pingcap#5299 to release-3.1
65cf91d 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jan 27, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-3.1 in PR #5422

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 27, 2021
@yikeke @ti-srebot
cherry pick pingcap#5299 to release-4.0
e9b4455 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jan 27, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-4.0 in PR #5423

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jan 27, 2021
@yikeke @ti-srebot
cherry pick pingcap#5299 to release-5.0
fa57517 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jan 27, 2021
Merged
10 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-5.0 in PR #5424

ti-srebot added a commit that referenced this pull request Jan 29, 2021
@ti-srebot
BR: reorganize content about BR tool (#5299) (#5424)
5b6a3f2
yikeke added a commit that referenced this pull request Feb 4, 2021
@ti-srebot @yikeke
BR: reorganize content about BR tool (#5299) (#5423)
2ee0d6d 
* cherry pick #5299 to release-4.0

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* resolve conflicts

* Delete release-5.0.0-rc.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
yikeke added a commit that referenced this pull request Feb 4, 2021
@ti-srebot @yikeke
BR: reorganize content about BR tool (#5299) (#5422)
dcafc74 
* cherry pick #5299 to release-3.1

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

* resolve conflicts

* add a warning to backup-and-restore-using-mydumper-lightning.md

* Delete backup-and-restore-using-dumpling-lightning.md

* Update TOC.md

* Delete release-5.0.0-rc.md

* Delete troubleshoot-ticdc.md

* fix 3 links

* Update backup-and-restore-tool.md

* Update backup-and-restore-tool.md

* Update use-br-command-line-tool.md

* Update use-br-command-line-tool.md

Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-authored-by: yikeke <yikeke@pingcap.com>
@yikeke yikeke mentioned this pull request Feb 5, 2021
Merged
11 tasks
@yikeke yikeke 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 Feb 19, 2021
This was referenced Feb 20, 2021
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IANTHEREAL IANTHEREAL IANTHEREAL left review comments

@kissmydb kissmydb kissmydb left review comments

@lichunzhu lichunzhu lichunzhu left review comments

@Ishiihara Ishiihara Ishiihara approved these changes

@lilin90 lilin90 lilin90 approved these changes

@3pointer 3pointer Awaiting requested review from 3pointer

Assignees

@yikeke yikeke

Labels
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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@yikeke @IANTHEREAL @ti-srebot @Ishiihara @kissmydb @lichunzhu @lilin90