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

tools/tidb-lightning: update Lightning-related docs #1993

Merged

Conversation

anotherrachel
Copy link
Contributor

@anotherrachel anotherrachel commented Oct 29, 2019

What is changed, added or deleted?

  1. Updated download links to 3.0.2 and 2.1.14.
  2. Documented the web interface for master version.
  3. Documented the Grafana dashboard.
  4. Reorganized the "deployment" page --- the full configuration is now moved into a dedicated "configuration" page, while the "deployment" only contains the essential configuration to simplify the steps.
  5. The new "configuration" page also describes the CLI parameters of the associated tools.

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

pingcap/docs#1455
pingcap/docs#1715 (update importer sample config)

Which version does your change affect?

dev, v2.1, v3.0 and v3.1: TOC.md, config.md(new), deployment.md, monitor.md, overview.md, web.md(new), download.md(updated in #2050)

@anotherrachel anotherrachel added v2.1 translation/from-docs This PR is translated from a PR in pingcap/docs. labels Oct 29, 2019
@anotherrachel anotherrachel marked this pull request as ready for review October 31, 2019 06:15
@anotherrachel anotherrachel requested a review from yikeke October 31, 2019 06:57
@lilin90 lilin90 requested a review from kennytm November 4, 2019 05:24
Copy link
Contributor

@kennytm kennytm left a comment

Choose a reason for hiding this comment

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

Rest LGTM

dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/overview.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/overview.md Outdated Show resolved Hide resolved
@TomShawn
Copy link
Contributor

TomShawn commented Nov 11, 2019

@anotherrachel 如果该更新也适用于 v3.1,也请更新至 v3.1,谢谢~

@kennytm kennytm added the status/LGT1 Indicates that a PR has LGTM 1. label Nov 13, 2019
@anotherrachel anotherrachel added the size/large Changes of a large size. label Nov 27, 2019
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.

@anotherrachel Please resolve conflicts.

@anotherrachel anotherrachel force-pushed the update-docs-for-3.0.2-and-master branch from bc7324c to eafc2b7 Compare December 18, 2019 05:17
@anotherrachel anotherrachel changed the title tools/tidb-lightning: update docs for 3.0.2 and master tools/tidb-lightning: update Lightning-related docs Dec 18, 2019
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/config.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/deployment.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
| 面板名称 | 描述 |
|:-----|:-----|
| Import speed - write from lightning | 从 TiDB Lightning 向 TiKV Importer 发送键值对的速度,取决于每个表的复杂性 |
| Import speed - upload to tikv | TiKV Importer 上传所有 TiKV 副本的总体速度 |
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
| Import speed - upload to tikv | TiKV Importer 上传所有 TiKV 副本的总体速度 |
| Import speed - upload to tikv | TiKV Importer 上传键值对到所有 TiKV 副本的总体速度 |

”上传“的是“键值对”吗?麻烦我的改动是否正确 @kennytm

Copy link
Contributor Author

Choose a reason for hiding this comment

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

确认了下~上传的是 SST 文件。

dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/monitor.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

Very clear translations. Good job!

dev/reference/tools/tidb-lightning/overview.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
dev/reference/tools/tidb-lightning/web.md Outdated Show resolved Hide resolved
@anotherrachel anotherrachel force-pushed the update-docs-for-3.0.2-and-master branch 2 times, most recently from 40a96c6 to 3ba3188 Compare January 7, 2020 11:08
@anotherrachel
Copy link
Contributor Author

@yikeke PTAL, thanks!

Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

LGTM

anotherrachel and others added 5 commits January 8, 2020 14:03
@anotherrachel anotherrachel force-pushed the update-docs-for-3.0.2-and-master branch from 50abc80 to 168fb0f Compare January 8, 2020 06:03
@anotherrachel anotherrachel force-pushed the update-docs-for-3.0.2-and-master branch from 168fb0f to 3be8d8d Compare January 8, 2020 06:08
@yikeke yikeke merged commit 4315e43 into pingcap:master Jan 8, 2020
@yikeke yikeke removed the DNM label Jan 8, 2020
@anotherrachel anotherrachel deleted the update-docs-for-3.0.2-and-master branch January 8, 2020 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/large Changes of a large size. status/LGT1 Indicates that a PR has LGTM 1. translation/from-docs This PR is translated from a PR in pingcap/docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants