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

Fix documentation for --lock-timeout #16021

Merged
merged 2 commits into from
May 30, 2024

Conversation

GuptaManan100
Copy link
Member

Description

This PR fixes the documentation for --lock-timeout flag after we noticed it was incorrect.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented May 29, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels May 29, 2024
@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels May 29, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 29, 2024
Copy link

codecov bot commented May 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.24%. Comparing base (0c2856e) to head (cbe8a9d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16021      +/-   ##
==========================================
- Coverage   68.24%   68.24%   -0.01%     
==========================================
  Files        1541     1541              
  Lines      197117   197115       -2     
==========================================
- Hits       134530   134525       -5     
- Misses      62587    62590       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @GuptaManan100 !

go/flags/endtoend/vtbackup.txt Outdated Show resolved Hide resolved
Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You already have 2 approvals :) I do think the suggested changes should be made. We want help text and docs to be as clear as possible.

changelog/20.0/20.0.0/summary.md Outdated Show resolved Hide resolved
changelog/20.0/20.0.0/summary.md Outdated Show resolved Hide resolved
@deepthi deepthi marked this pull request as draft May 29, 2024 19:47
@deepthi
Copy link
Member

deepthi commented May 29, 2024

Moving back to draft until feedback can be addressed.

Signed-off-by: Manan Gupta <[email protected]>
@GuptaManan100 GuptaManan100 marked this pull request as ready for review May 30, 2024 13:59
@GuptaManan100 GuptaManan100 merged commit 8c97857 into vitessio:main May 30, 2024
93 checks passed
@GuptaManan100 GuptaManan100 deleted the fix-get-locktimeout-docs branch May 30, 2024 13:59
@deepthi
Copy link
Member

deepthi commented May 31, 2024

@GuptaManan100 don't we need to update the website docs for this as well? similar to #15919 (comment)
Also see #15919 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants