refactor/improve clarity: change system-table to information-schema by yikeke · Pull Request #4109 · pingcap/docs-cn

yikeke · 2020-07-29T09:57:47Z

For reviewers：

@zz-jason @kissmydb 之前因为英文 review 得不是特别仔细，我在对齐的过程中看得仔细些，在 pingcap/docs#3470 修了一些之前没发现的问题，而且在下面的描述里把这 51 个文件的改动概述了下。两位也可以对着中文版再仔细地 review 下技术细节，thanks~

@lilin90 FYI：原 pr 的 .github/assign-by-files.yml 和 check-cluster-status-using-sql-statements.md 在中文版这已经被移除了，所以中文 PR 改动文件数为 51，英文 PR 为 53。

What is changed, added or deleted? (Required)

这个 PR 非常大，为了方便 review，概述如下：

把原来 system-tables/system-table-information-schema.md 的内容拆成了多个独立的 information-schema/information-schema-xxx.md 文件，多数拆出来的时候内容无大变动，只有一些开头段落和 SQL 例子的更新
新增了几个 information-schema/information-schema-xxx.md 文档，描述了原来没有文档描述的 information-schema 表
修了文档位置移动导致的死链
TOC 目录现在变成了下面这个样子（每个 information-schema 表都有自己独立的文档，和 sql-statement 文档类似）：

+ 系统表
  + [`mysql`](/mysql-schema.md)
  + INFORMATION_SCHEMA
     + [Overview](/information-schema/information-schema.md)
     + [`ANALYZE_STATUS`](/information-schema/information-schema-analyze-status.md)
     + [`CHARACTER_SETS`](/information-schema/information-schema-character-sets.md)
        ......
  + [`METRICS_SCHEMA`](/metrics-schema.md)

把后来合并的 update document for system-table-information-schema.md #3470 的改动也整合到了这个 PR

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

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

This PR is translated from: system-databases: Refactor/Improve clarity docs#3178, Update information schema format and directory docs#3413, system_tables: add column description for several tables docs#3322, Fix some issues in information schema docs docs#3470

…a-updates

yikeke · 2020-07-31T03:07:45Z

PTAL @zz-jason @kissmydb @lilin90

ti-srebot · 2020-08-02T03:08:00Z

@zz-jason, @kissmydb, @lilin90, PTAL.

Co-authored-by: kissmydb <likun@pingcap.com>

zz-jason

LGTM

lilin90

Some suggestions about code block format

lilin90

LGTM

yikeke · 2020-08-05T03:51:57Z

/merge

ti-srebot · 2020-08-05T03:54:18Z

/run-all-tests

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

ti-srebot · 2020-08-05T03:57:52Z

cherry pick to release-4.0 in PR #4195

…4109) (#4195) * cherry pick #4109 to release-4.0 Signed-off-by: ti-srebot <ti-srebot@pingcap.com> * delete 2 files * fix conflicts * dev -> stable * Update deploy-and-maintain-faq.md Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: yikeke <yikeke@pingcap.com>

update information-schema.md

8e1d491

yikeke added needs-cherry-pick-4.0 translation/from-docs This PR is translated from a PR in pingcap/docs. labels Jul 29, 2020

yikeke changed the title ~~change system-table to information-schema: Refactor/Improve clarity~~ change system-table to information-schema to refactor and improve clarity Jul 29, 2020

yikeke changed the title ~~change system-table to information-schema to refactor and improve clarity~~ refactor/improve clarity: change system-table to information-schema Jul 29, 2020

yikeke added 5 commits July 29, 2020 18:42

add 6 files

54d1c05

add 5 files

95eb068

add 5 files

a9112d9

Merge remote-tracking branch 'upstream/master' into information-schem…

0d39934

…a-updates

add commits from pingcap#3470

80bfa73

yikeke commented Jul 30, 2020

View reviewed changes

Comment thread information-schema/information-schema-analyze-status.md Outdated

yikeke and others added 17 commits July 30, 2020 14:49

Update information-schema/information-schema-analyze-status.md

2da351c

add 3 files and rename another file

e8faeda

rename/update a file

cec97fa

rename cluster-hardware

95ea5c5

rename/update a file

700617f

rename/update cluster-systeminfo

5decf34

rename/update cluster-log

7b4430d

rename/update metrics-summary and metrics-tables

1a50a59

rename/update inspection-result

c7e5a4a

rename/update inspection-summary

1d86175

rename/update metrics-schema.md

9a37f52

rename/update mysql Schema

abe1aa4

rename/update sql-diagnostics

246c8ba

Update TOC.md

c8fc79f

fix links

80b2f6b

Update information-schema.md

6e3d865

add 6 files

f71a2e3

yikeke marked this pull request as ready for review July 30, 2020 12:37

yikeke requested a review from lilin90 July 30, 2020 12:37

yikeke commented Jul 30, 2020

View reviewed changes

Comment thread faq/deploy-and-maintain-faq.md Outdated

Update faq/deploy-and-maintain-faq.md

a3cbdc2

yikeke added the size/large Changes of a large size. label Jul 30, 2020

Merge branch 'master' into information-schema-updates

78accca

yikeke commented Jul 30, 2020

View reviewed changes

Comment thread faq/deploy-and-maintain-faq.md

Update faq/deploy-and-maintain-faq.md

687aa88

kissmydb reviewed Aug 3, 2020

View reviewed changes

Comment thread information-schema/information-schema-cluster-config.md Outdated

yikeke and others added 3 commits August 3, 2020 14:44

Update information-schema/information-schema-cluster-config.md

c699293

Co-authored-by: kissmydb <likun@pingcap.com>

Merge branch 'master' into pr/4109

205c388

Merge branch 'master' into pr/4109

965faed

zz-jason approved these changes Aug 5, 2020

View reviewed changes

ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 5, 2020

lilin90 reviewed Aug 5, 2020

View reviewed changes

Apply suggestions from code review

69f8651

lilin90 approved these changes Aug 5, 2020

View reviewed changes

ti-srebot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Aug 5, 2020

ti-srebot approved these changes Aug 5, 2020

View reviewed changes

ti-srebot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 5, 2020

Merge branch 'master' into information-schema-updates

41dc612

ti-srebot merged commit 9bdd50e into pingcap:master Aug 5, 2020

ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Aug 5, 2020

cherry pick pingcap#4109 to release-4.0

2fdfaea

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

ti-srebot mentioned this pull request Aug 5, 2020

refactor/improve clarity: change system-table to information-schema (#4109) #4195

Merged

5 tasks

yikeke deleted the information-schema-updates branch August 5, 2020 04:00

Conversation

yikeke commented Jul 29, 2020 • edited 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)?

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yikeke commented Jul 31, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ti-srebot commented Aug 2, 2020

Uh oh!

Uh oh!

zz-jason left a comment

Choose a reason for hiding this comment

Uh oh!

lilin90 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lilin90 left a comment

Choose a reason for hiding this comment

Uh oh!

yikeke commented Aug 5, 2020

Uh oh!

ti-srebot commented Aug 5, 2020

Uh oh!

ti-srebot commented Aug 5, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

yikeke commented Jul 29, 2020 •

edited

Loading

yikeke commented Jul 31, 2020 •

edited

Loading