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

sql-statements: improve alter index docs #3586

Merged
merged 5 commits into from Aug 14, 2020
Merged

sql-statements: improve alter index docs #3586

merged 5 commits into from Aug 14, 2020

Conversation

ghost
Copy link

@ghost ghost commented Aug 8, 2020

What is changed, added or deleted? (Required)

This only applies to master, which features invisible indexes.

It improves the consistency of the docs for ALTER INDEX to follow the common format (including ## MySQL compatibility). There is some duplication in the page where it has examples, and then a section for invisible indexes with examples. Since the main use case for this statement is for invisible indexes, I merged the two together. The ## syntax section is also somewhat redundant with both the synposis and examples sections. So I've removed it.

The CREATE INDEX docs are also updated to remove a broken link, pointing to ALTER INDEX for invisible index docs. Really invisible indexes should have its own documentation page, with these pages just being for statement reference - but that's for a different task. The text also said that it was a "new feature introduced in MySQL 8.0" -- I think this text can be confusing to a casual reader, because it could imply that TiDB is somehow code-related to MySQL 8.0, which it is not.

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

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Have version specific changes
  • Might cause conflicts

@ghost ghost added the status/PTAL This PR is ready for reviewing. label Aug 10, 2020
@TomShawn TomShawn added size/medium Changes of a medium size. translation/doing This PR's assignee is translating this PR. v5.0 This PR/issue applies to TiDB v5.0. labels Aug 10, 2020
@TomShawn TomShawn self-assigned this Aug 10, 2020
Copy link
Contributor

@kolbe kolbe 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
Copy link
Contributor

@kolbe,Thanks for your review. However, LGTM is restricted to Reviewers or higher roles.See the corresponding SIG page for more information. Related SIGs: docs(slack).

@ti-srebot
Copy link
Contributor

@kolbe, @bb7133, @AilinKid, @TomShawn, PTAL.

@ghost
Copy link
Author

ghost commented Aug 13, 2020

@TomShawn I have a technical review from @kolbe. This should hopefully be straight forward, I am just looking for a language review.

Copy link
Contributor

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

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 14, 2020
Null not nil and others added 4 commits August 13, 2020 21:11
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@TomShawn TomShawn merged commit 2f2d900 into pingcap:master Aug 14, 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 Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/medium Changes of a medium size. status/LGT1 Indicates that a PR has LGTM 1. status/PTAL This PR is ready for reviewing. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. v5.0 This PR/issue applies to TiDB v5.0.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants