Skip to content

Improve release documentation #14001

@frouioui

Description

@frouioui

Description

There are several items that look off in the release documentation that we would like to fix:

  • The name Release Cutover is misleading in the https://github.com/vitessio/vitess/blob/main/doc/internal/release/README.md file. We should change it to make it more clear that Release Cutover is the entire documentation related to how we release vitess.
  • The instruction around updating the release notes on main should be placed in the Release section instead of the Pre-Release.
  • There are some format issue with Markdown in the Update the website documentation. section.
  • The way we generate release notes has changed since we started using milestones to generate them, that change should be reflected in the docs.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions