*: generalize and link to the external storage docs from Lightning by kennytm · Pull Request #5528 · pingcap/docs-cn

kennytm · 2021-02-18T08:15:49Z

What is changed, added or deleted? (Required)

Fix pingcap/docs#4445.

Generalize the "BR storage" page to "external storage", and talk about all associated migration services.

Link back to this page from their documents.

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

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

This PR is translated from:
Other reference link(s): lightning supports s3 parameters docs#4555

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

kennytm · 2021-02-18T08:16:16Z

/cc @TomShawn

ti-srebot · 2021-02-20T08:23:42Z

@overvenus, @glorv, @3pointer, @TomShawn, PTAL.

ti-srebot · 2021-02-22T09:15:43Z

@glorv, @overvenus, @3pointer, @TomShawn, PTAL.

glorv · 2021-02-23T02:03:00Z

LGTM

ti-srebot · 2021-02-23T02:03:03Z

@glorv, 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).

ti-srebot · 2021-02-25T02:03:10Z

@overvenus, @3pointer, @TomShawn, PTAL.

overvenus · 2021-02-25T06:50:19Z

LGTM

ti-srebot · 2021-02-27T06:51:10Z

@glorv, @overvenus, @3pointer, @TomShawn, PTAL.

ti-srebot · 2021-03-01T06:51:06Z

@3pointer, @TomShawn, PTAL.

TomShawn · 2021-03-01T08:33:52Z

 ---
-title: BR 存储
-summary: 了解 BR 中所用存储服务的 URL 格式。
+title: 外部存储


外部存储 is not only for BR. So we need to change the file name (like tools-remote-storage.md) and put the file out of BR directory.

We also need to move its position in the TOC menu. @kissmydb @overvenus @IANTHEREAL Any good idea?

For tools there's a bunch of these "shared language" description needing such position. Table-filter is another instance.

But in this case, the BR-specific file name is clearly not suitable and can be misleading.

For the file position, what about /tools-external-storage.md?

For TOC, what about

For the table filter case, put it under TiDB 生态工具 LGTM. But it also needs opinion from others.

It belongs to BR, so br/backup-and-restore-storages.md LGTM.

I agree with @TomShawn, Thanks for the user's understanding perspective.

For 外部存储 and Table-filter

the similarity is that the tools ecosystem uses the same code implementation(table-filter and external storage). From the usage perspective, before the implementation is unified (usage, configuration, naming, etc.), it is better to put the introduction in each tool separately; otherwise, we can consider building a special manual for them.

the external storage focuses on the external ecosystem supported by the entire tool ecosystem. From this point, it needs to be introduced separately

@kennytm PTAL

Note: we have discussed about this internally, and the consensus is we will perform the rename in a separate PR.

kennytm · 2021-03-15T10:17:15Z

PTAL @TomShawn

TomShawn · 2021-03-15T10:48:22Z

/lgtm

ti-chi-bot · 2021-03-15T10:48:23Z

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

Details

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

TomShawn · 2021-03-15T10:55:45Z

Follow-up: Change the file name for 外部存储 and remove it out of /br. @IANTHEREAL will work on its new position in TOC.

TomShawn · 2021-03-15T10:58:42Z

/merge

ti-chi-bot · 2021-03-15T10:58:45Z

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

Details

Commit hash: 9f04c75

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

ti-srebot · 2021-03-15T10:59:30Z

cherry pick to release-4.0 in PR #5741

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

ti-srebot · 2021-03-15T11:00:11Z

cherry pick to release-5.0 in PR #5742

…5528) (#5742)

…5528) (#5741)

TomShawn · 2021-04-12T07:44:05Z

/remove-translation doing
/translation done

*: generalize and link to the external storage docs from Lightning

b09dfe1

ti-srebot requested a review from TomShawn February 18, 2021 08:16

TomShawn requested review from 3pointer and overvenus February 18, 2021 08:18

TomShawn self-assigned this Feb 18, 2021

TomShawn added needs-cherry-pick-4.0 size/large Changes of a large size. status/PTAL This PR is ready for reviewing. translation/doing This PR’s assignee is translating this PR. labels Feb 18, 2021

TomShawn mentioned this pull request Feb 19, 2021

tidb-lightning: add lightning supported storage page #5544

Closed

11 tasks

TomShawn requested a review from glorv February 19, 2021 13:09

glorv reviewed Feb 20, 2021

View reviewed changes

Comment thread br/backup-and-restore-storages.md

br: document --s3.* and --gcs.* CLI parameters

dad543e

kennytm force-pushed the expand-storage-params-to-lightning-dumpling branch from 4cab887 to dad543e Compare February 22, 2021 11:32

overvenus reviewed Feb 22, 2021

View reviewed changes

Comment thread br/backup-and-restore-storages.md Outdated

*: s/远端/外部/g

b961f81

ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Feb 25, 2021

Merge branch 'master' into expand-storage-params-to-lightning-dumpling

cdb3151

Merge branch 'master' into expand-storage-params-to-lightning-dumpling

e5e268b

TomShawn reviewed Mar 1, 2021

View reviewed changes

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 Mar 15, 2021

ti-chi-bot added the requires-followup This PR requires a follow-up task after being merged. label Mar 15, 2021

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 15, 2021

ti-chi-bot merged commit 2c9622b into pingcap:master Mar 15, 2021

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Mar 15, 2021

cherry pick pingcap#5528 to release-4.0

97110f4

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

ti-srebot mentioned this pull request Mar 15, 2021

*: generalize and link to the external storage docs from Lightning (#5528) #5741

Merged

10 tasks

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Mar 15, 2021

cherry pick pingcap#5528 to release-5.0

b27ffff

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

ti-srebot mentioned this pull request Mar 15, 2021

*: generalize and link to the external storage docs from Lightning (#5528) #5742

Merged

10 tasks

kennytm deleted the expand-storage-params-to-lightning-dumpling branch March 15, 2021 11:04

ti-chi-bot pushed a commit that referenced this pull request Mar 16, 2021

*: generalize and link to the external storage docs from Lightning (#…

8f55d8d

…5528) (#5742)

ti-chi-bot pushed a commit that referenced this pull request Mar 16, 2021

*: generalize and link to the external storage docs from Lightning (#…

b040cd3

…5528) (#5741)

This was referenced Apr 12, 2021

*: generalize and link to the external storage docs from Lightning pingcap/docs#5286

Merged

FIx typos in br external storages #6018

Merged

ti-chi-bot 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 Apr 12, 2021

ran-huang mentioned this pull request Feb 2, 2023

lightning supports s3 parameters pingcap/docs#4555

Closed

Conversation

kennytm commented Feb 18, 2021 • edited by TomShawn Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

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

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

Do your changes match any of the following descriptions?

Uh oh!

kennytm commented Feb 18, 2021

Uh oh!

ti-srebot commented Feb 20, 2021

Uh oh!

Uh oh!

ti-srebot commented Feb 22, 2021

Uh oh!

Uh oh!

glorv commented Feb 23, 2021

Uh oh!

ti-srebot commented Feb 23, 2021

Uh oh!

ti-srebot commented Feb 25, 2021

Uh oh!

overvenus commented Feb 25, 2021

Uh oh!

ti-srebot commented Feb 27, 2021

Uh oh!

ti-srebot commented Mar 1, 2021

Uh oh!

TomShawn Mar 1, 2021

Choose a reason for hiding this comment

Uh oh!

kennytm Mar 1, 2021

Choose a reason for hiding this comment

Uh oh!

TomShawn Mar 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

overvenus Mar 3, 2021

Choose a reason for hiding this comment

Uh oh!

IANTHEREAL Mar 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TomShawn Mar 11, 2021

Choose a reason for hiding this comment

Uh oh!

kennytm Mar 12, 2021

Choose a reason for hiding this comment

Uh oh!

kennytm commented Mar 15, 2021

Uh oh!

TomShawn commented Mar 15, 2021

Uh oh!

ti-chi-bot commented Mar 15, 2021

Uh oh!

TomShawn commented Mar 15, 2021

Uh oh!

TomShawn commented Mar 15, 2021

Uh oh!

ti-chi-bot commented Mar 15, 2021

Uh oh!

ti-srebot commented Mar 15, 2021

Uh oh!

ti-srebot commented Mar 15, 2021

Uh oh!

TomShawn commented Apr 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

kennytm commented Feb 18, 2021 •

edited by TomShawn

Loading

TomShawn Mar 1, 2021 •

edited

Loading

IANTHEREAL Mar 3, 2021 •

edited

Loading