Skip to content

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

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
Merged
merged 33 commits into from
Aug 5, 2020
Merged

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

merged 33 commits into from
Aug 5, 2020

Conversation

@yikeke
Copy link
Contributor

@yikeke yikeke commented Jul 29, 2020 •
edited
Loading

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，概述如下：

  1. 把原来 system-tables/system-table-information-schema.md 的内容拆成了多个独立的 information-schema/information-schema-xxx.md 文件，多数拆出来的时候内容无大变动，只有一些开头段落和 SQL 例子的更新
  2. 新增了几个 information-schema/information-schema-xxx.md 文档，描述了原来没有文档描述的 information-schema 表
  3. 修了文档位置移动导致的死链
  4. 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)
  1. 把后来合并的 update document for system-table-information-schema.md #3470 的改动也整合到了这个 PR

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)?

@yikeke 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 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 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
yikeke commented Jul 30, 2020
View reviewed changes
@yikeke yikeke marked this pull request as ready for review July 30, 2020 12:37
@yikeke yikeke requested a review from lilin90 July 30, 2020 12:37
yikeke
yikeke commented Jul 30, 2020
View reviewed changes
@yikeke yikeke added the size/large Changes of a large size. label Jul 30, 2020
yikeke
yikeke commented Jul 30, 2020
View reviewed changes
@yikeke
Copy link
Contributor Author

yikeke commented Jul 31, 2020 •
edited
Loading

PTAL @zz-jason @kissmydb @lilin90

@ti-srebot
Copy link
Contributor

ti-srebot commented Aug 2, 2020

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

kissmydb
kissmydb reviewed Aug 3, 2020
View reviewed changes
zz-jason
zz-jason approved these changes Aug 5, 2020
View reviewed changes
Copy link
Member

@zz-jason zz-jason 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 Aug 5, 2020
lilin90
lilin90 reviewed Aug 5, 2020
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.

Some suggestions about code block format

lilin90
lilin90 approved these changes Aug 5, 2020
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 status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Aug 5, 2020
@yikeke
Copy link
Contributor Author

yikeke commented Aug 5, 2020

/merge

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

ti-srebot commented Aug 5, 2020

/run-all-tests

@ti-srebot 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
@yikeke @ti-srebot
cherry pick pingcap#4109 to release-4.0
2fdfaea 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Aug 5, 2020
Merged
5 tasks
@ti-srebot
Copy link
Contributor

ti-srebot commented Aug 5, 2020

cherry pick to release-4.0 in PR #4195

@yikeke yikeke deleted the information-schema-updates branch August 5, 2020 04:00
ti-srebot added a commit that referenced this pull request Aug 5, 2020
@ti-srebot @yikeke
refactor/improve clarity: change system-table to information-schema (#…
bdf6a73 
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lilin90 lilin90 lilin90 approved these changes

@ti-srebot ti-srebot ti-srebot approved these changes

+2 more reviewers

@kissmydb kissmydb kissmydb left review comments

@zz-jason zz-jason zz-jason approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

size/large Changes of a large size. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@yikeke @ti-srebot @zz-jason @kissmydb @lilin90