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

TiKV configuration: better description for pin-l0-filter-and-index-blocks #6667

Merged
merged 2 commits into from
Jul 15, 2021
Merged

TiKV configuration: better description for pin-l0-filter-and-index-blocks #6667

merged 2 commits into from
Jul 15, 2021

Conversation

yiwu-arbug
Copy link
Contributor

@yiwu-arbug yiwu-arbug commented Jul 14, 2021

First-time contributors' checklist

What is changed, added or deleted? (Required)

The description for "pin" l0 index and filter block needs to be more descriptive.

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

  • master (the latest development version)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)
  • 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
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Yi Wu added 2 commits July 13, 2021 19:10
…ocks

Signed-off-by: Yi Wu <yiwu@pingcap.com>
Signed-off-by: Yi Wu <yiwu@pingcap.com>
@ti-chi-bot ti-chi-bot requested a review from TomShawn July 14, 2021 02:13
@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 14, 2021
@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Jul 14, 2021
@yiwu-arbug
Copy link
Contributor Author

cc @tabokie

@yiwu-arbug yiwu-arbug changed the title Rocks pin tikv configuration: better description for pin-l0-filter-and-index-blocks Jul 14, 2021
@yiwu-arbug yiwu-arbug changed the title tikv configuration: better description for pin-l0-filter-and-index-blocks TiKV configuration: better description for pin-l0-filter-and-index-blocks Jul 14, 2021
@TomShawn TomShawn added type/enhancement The issue or PR belongs to an enhancement. translation/doing This PR’s assignee is translating this PR. sig/docs Indicates that the Issue or PR belongs to the docs SIG. area/engine Indicates that the Issue or PR belongs to the area of TP storage or Cloud storage. and removed missing-translation-status This PR does not have translation status info. labels Jul 14, 2021
@ti-chi-bot ti-chi-bot requested a review from TomShawn July 14, 2021 03:23
@ti-chi-bot
Copy link
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn
  • tabokie

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.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot 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 Jul 14, 2021
@yiwu-arbug
Copy link
Contributor Author

yiwu-arbug commented Jul 14, 2021

Do we want to update for previous versions (all the way back to v3.0) ? @TomShawn

@TomShawn
Copy link
Contributor

TomShawn commented Jul 15, 2021

Do we want to update for previous versions (all the way back to v3.0) ? @TomShawn

Now we are adopting a new doc content strategy based on @alex-quan-001 's proposal on documentation.

According to Alex: Once the code is frozen and released as a production version, we should not modify the released code, which is exactly how we should handle user documentation. Once the documentation of a product version is delivered, we should not modify the released documentation, no matter it is about typos, incorrect or inaccurate descriptions. These modifications should be made only on the master branch, the latest development branch, and delivered as document enhancements for the upcoming release versions.

In the light of this proposal, as already announced in an R&D weekly meeting, document enhancements and content fixes will not be cherry-picked to release branches. Only the version-specific content affecting only the current release version (e.g. 5.0.3, 4.0.13, and 5.1.0) are permitted for cherry-pick.

@yiwu-arbug
Copy link
Contributor Author

Do we want to update for previous versions (all the way back to v3.0) ? @TomShawn

Now we are adopting a new doc content strategy based on @alex-quan-001 's proposal on documentation.

According to Alex: Once the code is frozen and released as a production version, we should not modify the released code, which is exactly how we should handle user documentation. Once the documentation of a product version is delivered, we should not modify the released documentation, no matter it is about typos, incorrect or inaccurate descriptions. These modifications should be made only on the master branch, the latest development branch, and delivered as document enhancements for the upcoming release versions.

In the light of this proposal, as already announced in an R&D weekly meeting, document enhancements and content fixes will not be cherry-picked to release branches. Only the version-specific content affecting only the current release version (e.g. 5.0.3, 4.0.13, and 5.1.0) are permitted for cherry-pick.

Got it

@TomShawn
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: 0cc702b

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Jul 15, 2021
@ti-chi-bot ti-chi-bot merged commit 1194355 into pingcap:master Jul 15, 2021
@en-jin19 en-jin19 removed the translation/doing This PR’s assignee is translating this PR. label Jul 21, 2021
@en-jin19 en-jin19 added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jul 21, 2021
3AceShowHand pushed a commit to 3AceShowHand/docs-cn that referenced this pull request Jul 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/engine Indicates that the Issue or PR belongs to the area of TP storage or Cloud storage. sig/docs Indicates that the Issue or PR belongs to the docs SIG. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants