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

Update garbage collection docs (#4552) #5055

Merged
merged 1 commit into from
Mar 24, 2021

Conversation

ti-srebot
Copy link
Contributor

@ti-srebot ti-srebot commented Mar 17, 2021

cherry-pick #4552 to release-5.0
You can switch your code base to this Pull Request by using git-extras:

# In docs repo:
git pr https://github.com/pingcap/docs/pull/5055

After apply modifications, you can push your change to this PR via:

git push [email protected]:ti-srebot/docs.git pr/5055:release-5.0-ca331fb386d4

First-time contributors' checklist

What is changed, added or deleted? (Required)

This updates the docs for pingcap/tidb#21988 (now merged).

21988 still allows the previous methods for updating, but because these changes are not validated, they should not be recommended. Incorrect configuration can lead to strange behaviors.

Partially address #4549 (for backup page mentioned, there are still other pages that need readability improvements)

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

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

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

@ti-srebot ti-srebot mentioned this pull request Mar 17, 2021
11 tasks
@ti-srebot ti-srebot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. type/cherry-pick-for-release-5.0 This PR is cherry-picked to release-5.0 from a source PR. labels Mar 17, 2021
@ti-srebot
Copy link
Contributor Author

@morgo you're already a collaborator in bot's repo.

@yikeke
Copy link
Contributor

yikeke commented Mar 17, 2021

Do we need to merge this PR after 5.0 GA is released? @morgo

@morgo
Copy link
Contributor

morgo commented Mar 17, 2021

I don't quite understand how the docs branching is being done for 5.0. I thought since tidb created release-5.0 from master last week (abandoning release-5.0-rc) that docs would need to do similar, and recreate the release-5.0 branch.

It looks like PRs are being held (for example: #5007 ), but I think it's fine to merge and say a change is effective since 5.0 even when 5.0 is not yet released? I have noticed we do this with point releases too (not merge docs related to a 4.0.11 feature until 4.0.11 is released). It increases merge conflicts/management pains to keep the PRs open.

@yikeke
Copy link
Contributor

yikeke commented Mar 17, 2021

I don't quite understand how the docs branching is being done for 5.0. I thought since tidb created release-5.0 from master last week (abandoning release-5.0-rc) that docs would need to do similar, and recreate the release-5.0 branch.

I'd like to transfer this conversation to Slack if you don't mind. I've shared the docs branching plan with you there. We can continue our discussion there.

It looks like PRs are being held (for example: #5007 ), but I think it's fine to merge and say a change is effective since 5.0 even when 5.0 is not yet released? I have noticed we do this with point releases too (not merge docs related to a 4.0.11 feature until 4.0.11 is released). It increases merge conflicts/management pains to keep the PRs open.

merge and say a change is effective since 5.0 even when 5.0 is not yet released this one is hard to do. Two reasons: 1. for example #5007, there are small changes in several documents. We can't write a notice for every small change. 2. We want to reduce as many version-specific descriptions as possible on master, so we try to avoid a statement like "a change is effective since 5.0". Again, this problem is related to the docs release strategy, we can discuss it in detail on Slack.

@bb7133
Copy link
Member

bb7133 commented Mar 22, 2021

Please get me involved, what is the proper time to merge it?

@yikeke
Copy link
Contributor

yikeke commented Mar 24, 2021

Now is the time to merge. We have aborted the auto-deployment for the release-5.0 branch.

@ti-chi-bot
Copy link
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • yikeke

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 writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 24, 2021
@yikeke
Copy link
Contributor

yikeke commented Mar 24, 2021

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: 1837c72

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 24, 2021
@ti-chi-bot ti-chi-bot merged commit 661d4a7 into pingcap:release-5.0 Mar 24, 2021
@yikeke yikeke added the v5.0 This PR/issue applies to TiDB v5.0. label Mar 24, 2021
@TomShawn TomShawn deleted the release-5.0-ca331fb386d4 branch March 25, 2021 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. type/cherry-pick-for-release-5.0 This PR is cherry-picked to release-5.0 from a source PR. v5.0 This PR/issue applies to TiDB v5.0.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants