Skip to content

Conversation

@breezewish
Copy link
Member

Signed-off-by: Breezewish me@breeswish.org

What is changed, added or deleted? (Required)

Added the following new documentations for TiDB Dashboard, to make content more complete:

  • TiDB Dashboard Introduction
  • Deploy TiDB Dashboard
  • Use TiDB Dashboard behind a Reverse Proxy
  • Enhance TiDB Dashboard Security
  • TiDB Dashboard FAQ

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

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

Signed-off-by: Breezewish <me@breeswish.org>
Signed-off-by: Breezewish <me@breeswish.org>
Signed-off-by: Breezewish <me@breeswish.org>
Signed-off-by: Breezewish <me@breeswish.org>
@yikeke yikeke requested review from TomShawn and lilin90 and removed request for TomShawn June 2, 2020 03:08
@TomShawn TomShawn self-assigned this Jun 2, 2020
@yikeke yikeke added needs-cherry-pick-4.0 translation/doing This PR’s assignee is translating this PR. labels Jun 2, 2020
@TomShawn TomShawn added the size/large Changes of a large size. label Jun 2, 2020
@TomShawn TomShawn requested a review from HunDunDM June 2, 2020 03:20
Signed-off-by: Breezewish <me@breeswish.org>
@lilin90
Copy link
Member

lilin90 commented Jun 2, 2020

I'll review this PR on Jun 3.

Comment on lines +98 to +120
> 修改完成后的配置文件类似于:
>
> ```yaml
> server_configs:
> pd:
> dashboard.public-path-prefix: /foo
> global:
> user: tidb
> ...
> ```
>
> 或
>
> ```yaml
> monitored:
> ...
> server_configs:
> tidb: ...
> tikv: ...
> pd:
> dashboard.public-path-prefix: /foo
> ...
> ```
Copy link
Member

Choose a reason for hiding this comment

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

The > character is unnecessary? Suggest removing them.

Copy link
Member Author

Choose a reason for hiding this comment

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

它们主要是用作补充说明,便于用户校对修改是否正确,应该问题不大

Copy link
Member

Choose a reason for hiding this comment

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

@breeswish 通常建议格式尽量简单,以确保官网解析正常。可以观察下,如果在官网格式错乱了,就请删掉这些字符。 @TomShawn 英文版里不必留这些字符。

Copy link
Contributor

Choose a reason for hiding this comment

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

好的

@lilin90
Copy link
Member

lilin90 commented Jun 3, 2020

@breeswish I added a commit 89607b4 to update wording and format. FYI.

Copy link
Member Author

@breezewish breezewish left a comment

Choose a reason for hiding this comment

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

Thanks for the help! Mostly LGTM

@breezewish
Copy link
Member Author

@HunDunDM PTAL

Copy link
Contributor

@HunDunDM HunDunDM 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

breezewish and others added 5 commits June 4, 2020 15:49
Co-authored-by: 混沌DM <hundundm@gmail.com>
Signed-off-by: Breezewish <me@breeswish.org>
Signed-off-by: Breezewish <me@breeswish.org>
Signed-off-by: Breezewish <me@breeswish.org>
Signed-off-by: Breezewish <me@breeswish.org>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
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.

Image issue: text in dashboard-slow-queries-detail1.png is covered by a red line, like strikethrough. Could you please optimize it?

Rest LGTM

Signed-off-by: Breezewish <me@breeswish.org>
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
Copy link
Member

lilin90 commented Jun 4, 2020

/merge

@sre-bot sre-bot added the status/can-merge Indicates a PR has been approved by a committer. label Jun 4, 2020
@sre-bot
Copy link
Contributor

sre-bot commented Jun 4, 2020

/run-all-tests

@sre-bot sre-bot merged commit 73026cc into master Jun 4, 2020
sre-bot pushed a commit to sre-bot/docs-cn that referenced this pull request Jun 4, 2020
Signed-off-by: sre-bot <sre-bot@pingcap.com>
@sre-bot sre-bot mentioned this pull request Jun 4, 2020
5 tasks
@sre-bot
Copy link
Contributor

sre-bot commented Jun 4, 2020

cherry pick to release-4.0 in PR #3502

@lilin90 lilin90 deleted the more-dashboard-doc branch June 4, 2020 11:30
sre-bot added a commit that referenced this pull request Jun 5, 2020
@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 translation/doing This PR’s assignee is translating this PR. labels Jun 8, 2020
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/can-merge Indicates a PR has been approved by a committer. 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.

7 participants