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 typo for --cells flag help description in ApplyRoutingRules #14721

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

iheanyi
Copy link
Contributor

@iheanyi iheanyi commented Dec 7, 2023

Description

While reading through the documentation for ApplyRoutingRules, I noticed this typo in the flag. This pull request fixes that.

Related Issue(s)

N/A

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

N/A

While reading through the documentation for `ApplyRoutingRules`, I noticed this typo in the flag. This pull request fixes that.

Signed-off-by: Iheanyi Ekechukwu <[email protected]>
Copy link
Contributor

vitess-bot bot commented Dec 7, 2023

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 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 Dec 7, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 7, 2023
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, @iheanyi !

@mattlord mattlord added Type: Internal Cleanup Component: vtctldclient Backport to: release-17.0 and 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 Backport to: release-17.0 labels Dec 7, 2023
@ajm188 ajm188 merged commit e5a8380 into vitessio:main Dec 7, 2023
120 of 125 checks passed
vitess-bot pushed a commit that referenced this pull request Dec 7, 2023
vitess-bot pushed a commit that referenced this pull request Dec 7, 2023
frouioui pushed a commit that referenced this pull request Dec 8, 2023
…RoutingRules` (#14721) (#14723)

Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
frouioui pushed a commit that referenced this pull request Dec 8, 2023
…RoutingRules` (#14721) (#14722)

Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
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.

3 participants