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

[cherry-pick]fix anchors for release notes and summary (#11578) #11590

Merged
merged 1 commit into from
Oct 27, 2022
Merged

[cherry-pick]fix anchors for release notes and summary (#11578) #11590

merged 1 commit into from
Oct 27, 2022

Conversation

rsajwani
Copy link
Contributor

@rsajwani rsajwani commented Oct 27, 2022 •
edited
Loading

bookmarks (anchor) for release notes and summary doc are broken. This PR will fix them.

Description

Cherry-pick #11578

Related Issue(s)

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

Deployment Notes

@rsajwani
fix anchors for release notes and summary (vitessio#11578)
32a286b 
* fix anchors for release notes and summary

Signed-off-by: Rameez Sajwani <[email protected]>

* adding # to link

Signed-off-by: Rameez Sajwani <[email protected]>

Signed-off-by: Rameez Sajwani <[email protected]>
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 27, 2022

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:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

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

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

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.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@rsajwani rsajwani self-assigned this Oct 27, 2022
@rsajwani rsajwani added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: General Changes throughout the code base labels Oct 27, 2022
@rsajwani rsajwani marked this pull request as ready for review October 27, 2022 15:27
mattlord
mattlord reviewed Oct 27, 2022
View reviewed changes
doc/releasenotes/15_0_0_release_notes.md
Comment on lines +21 to +24
- [vtctl GetSchema --table-schema-only](#vtctl-getschema--table-schema-only)
- [Support for Additional Compressors and Decompressors During Backup & Restore](#support-for-additional-compressors-and-decompressors-during-backup--restore)
- [Independent OLAP and OLTP Transactional Timeouts](#independant-olap-and-oltp-transactional-timeouts)
- [Support for Specifying Group Information in Calls to VTGate](#support-for-specifying-group-information-in-calls-to-vtgate)
Copy link
Contributor

Choose a reason for hiding this comment

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

These should be moved to their own sections or be placed under a Misc / Other section. They are not related to vdiff2.

doc/releasenotes/15_0_0_release_notes.md
- [Flags](#flags)
- [VTTablet Flag Deletions](#vttablet-flag-deletions)
- [Vindex Interface](#vindex-interface)
- **[Deprecations](#deprecations)**
Copy link
Contributor

Choose a reason for hiding this comment

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

If it's not too late, we could change this to deprecations and removals and also note the removal of all legacy sharding related code: #10278

mattlord
mattlord approved these changes Oct 27, 2022
View reviewed changes
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.

As discussed via Slack, my comments will be addressed in a follow-up PR.

@mattlord mattlord merged commit 1016137 into vitessio:main Oct 27, 2022
@mattlord mattlord deleted the cherrypick-11578 branch October 27, 2022 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattlord mattlord mattlord approved these changes

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

Assignees

@rsajwani rsajwani

Labels
Component: General Changes throughout the code base Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rsajwani @mattlord