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.

Sign up for GitHub

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

Jump to bottom

Documented the legacy healthcheck and tabletgateway and added summary to 14's summary #10567

Merged
merged 2 commits into from
Jun 22, 2022
Merged

Documented the legacy healthcheck and tabletgateway and added summary to 14's summary #10567

merged 2 commits into from
Jun 22, 2022

Conversation

frouioui
Copy link
Member

Description

This PR documents the changes made by #9500 and #10254 on the legacy healthcheck and tabletgateway.

Additionally, this PR includes a new section to the summary that summarizes the different sections of the document.

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

@frouioui
Documented the legacy healthcheck and tabletgateway and added summary…
2bd2f71 
… to 14_summary

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui added Backport me! Component: General Changes throughout the code base Type: Release labels Jun 22, 2022
@frouioui
Revert unwanted change in 14_summary
19f3957 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui mentioned this pull request Jun 22, 2022
Closed
43 tasks
@github-actions
Copy link
Contributor

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive.
  • If a workflow is added or modified, each items in Jobs should be named in order to mark it as required. If the workflow should be required, the GitHub Admin should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.

@frouioui frouioui merged commit 4c8198f into vitessio:main Jun 22, 2022
@frouioui frouioui deleted the release-notes-summary-legacy-healthcheck branch June 22, 2022 14:43
frouioui added a commit to planetscale/vitess that referenced this pull request Jun 22, 2022
@frouioui
Documented the legacy healthcheck and tabletgateway and added summary…
df94d69 
… to 14's summary (vitessio#10567)

* Documented the legacy healthcheck and tabletgateway and added summary to 14_summary

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Revert unwanted change in 14_summary

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
@frouioui frouioui mentioned this pull request Jun 22, 2022
Merged
3 tasks
frouioui added a commit that referenced this pull request Jun 28, 2022
@frouioui @deepthi
@systay @mattlord
[14.0] Update and prepare the v14.0.0 summary (#10569)
ae53e60 
* Documented the legacy healthcheck and tabletgateway and added summary to 14's summary (#10567)

* Documented the legacy healthcheck and tabletgateway and added summary to 14_summary

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Revert unwanted change in 14_summary

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Updated the 14_summary fixed typo and remove unwanted content

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* release notes: fix repititions, inaccuracies and some other minor edits

Signed-off-by: deepthi <deepthi@planetscale.com>

* edit VTOrc durability section

Signed-off-by: deepthi <deepthi@planetscale.com>

* docs: added details to the release summary

Signed-off-by: Andres Taylor <andres@planetscale.com>

* Added more details to the insert select example

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* More consistent capitalization of components name

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Update the release notes summary

Signed-off-by: Matt Lord <mattalord@gmail.com>

* Tweaks to VDiff2 notes

Signed-off-by: Matt Lord <mattalord@gmail.com>

Co-authored-by: deepthi <deepthi@planetscale.com>
Co-authored-by: Andres Taylor <andres@planetscale.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@systay systay systay approved these changes

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@mattlord mattlord Awaiting requested review from mattlord

Assignees
No one assigned
Labels
Component: General Changes throughout the code base Type: Release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@frouioui @systay