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

Remove specific Kubernetes version instructions and link to the Vites… #16610

Merged
merged 5 commits into from
Aug 26, 2024

Conversation

anshikavashistha
Copy link
Collaborator

To update the examples/operator/README.md file by removing the --kubernetes-version=v1.19.5 flag and adding a reference to the compatibility matrix in the official documentation.

  • Removed specific Kubernetes version instructions from examples/operator/README.md.
  • Added a link to the Vitess Operator Compatibility Matrix for up-to-date Kubernetes version information.
  • This change centralizes Kubernetes version recommendations and ensures users are directed to the most current documentation.
    Related Issue:#1022

…s Operator Compatibility Matrix

Removed specific Kubernetes version instructions from examples/operator/README.md.
Added a link to the Vitess Operator Compatibility Matrix for up-to-date Kubernetes version information.
This change centralizes Kubernetes version recommendations and ensures users are directed to the most current documentation.
Related Issue: [vitessio#1022](vitessio/website#1022)

Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com>
Copy link
Contributor

vitess-bot bot commented Aug 17, 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 Aug 17, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Aug 17, 2024
…s Operator Compatibility Matrix

Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com>
@mattlord mattlord added Type: Internal Cleanup Component: Documentation docs related issues/PRs 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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Aug 21, 2024
anshikavashistha and others added 2 commits August 21, 2024 23:20
Co-authored-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com>
Signed-off-by: Anshika Vashistha <93611566+anshikavashistha@users.noreply.github.com>
@anshikavashistha
Copy link
Collaborator Author

@GuptaManan100 @frouioui PTAL

Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.96%. Comparing base (0d6b768) to head (3808f0e).
Report is 20 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16610      +/-   ##
==========================================
+ Coverage   68.83%   68.96%   +0.13%     
==========================================
  Files        1558     1562       +4     
  Lines      200042   200760     +718     
==========================================
+ Hits       137693   138458     +765     
+ Misses      62349    62302      -47     

☔ 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, @anshikavashistha !

Signed-off-by: anshikavashistha <93611566+anshikavashistha@users.noreply.github.com>
@mattlord mattlord merged commit fa60438 into vitessio:main Aug 26, 2024
129 checks passed
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