From 19ebfd116731169c79b67cbaa2c072c34224bf6a Mon Sep 17 00:00:00 2001 From: Florent Poinsard Date: Thu, 4 Jan 2024 10:50:25 -0500 Subject: [PATCH 1/4] Modify the release instructions to properly clone Vitess when using the vtop examples Signed-off-by: Florent Poinsard --- doc/internal/release/how-to-release.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/internal/release/how-to-release.md b/doc/internal/release/how-to-release.md index fd5caa81e03..4957ff95990 100644 --- a/doc/internal/release/how-to-release.md +++ b/doc/internal/release/how-to-release.md @@ -87,6 +87,7 @@ That includes: > - There are two scripts in the website repository in `./tools/{ga|rc}_release.sh`, use them to update the website documentation. The scripts automate: > - For an RC, we need to create a new entry in the sidebar which represents the next version on `main` and mark the version we are releasing as RC. > - For a GA, we need to mark the version we are releasing as "Stable" and the next one as "Development". + > - Update [Install Operator](https://vitess.io/docs/get-started/operator/#install-the-operator): the snippet where we clone the vitess repository has to include `git checkout release-xx.0`. With `xx` being the major version we are releasing. - **Create a new GitHub Milestone** > - Our GitHub Milestones is a good representation of all our ongoing development cycles. We have a Milestone for `main` and for all release branches. > - After doing Code Freeze, we can create a new GitHub Milestone that matches the next development cycle. From 793b47bda41a8a540267b283f0026d26e4b39f5e Mon Sep 17 00:00:00 2001 From: Florent Poinsard Date: Thu, 4 Jan 2024 10:53:34 -0500 Subject: [PATCH 2/4] Remove whitespaces Signed-off-by: Florent Poinsard --- doc/internal/release/how-to-release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/internal/release/how-to-release.md b/doc/internal/release/how-to-release.md index 4957ff95990..c020a75be0c 100644 --- a/doc/internal/release/how-to-release.md +++ b/doc/internal/release/how-to-release.md @@ -87,7 +87,7 @@ That includes: > - There are two scripts in the website repository in `./tools/{ga|rc}_release.sh`, use them to update the website documentation. The scripts automate: > - For an RC, we need to create a new entry in the sidebar which represents the next version on `main` and mark the version we are releasing as RC. > - For a GA, we need to mark the version we are releasing as "Stable" and the next one as "Development". - > - Update [Install Operator](https://vitess.io/docs/get-started/operator/#install-the-operator): the snippet where we clone the vitess repository has to include `git checkout release-xx.0`. With `xx` being the major version we are releasing. + > - Update [Install Operator](https://vitess.io/docs/get-started/operator/#install-the-operator): the snippet where we clone the vitess repository has to include `git checkout release-xx.0`. With `xx` being the major version we are releasing. - **Create a new GitHub Milestone** > - Our GitHub Milestones is a good representation of all our ongoing development cycles. We have a Milestone for `main` and for all release branches. > - After doing Code Freeze, we can create a new GitHub Milestone that matches the next development cycle. From e6d74d763b24a7fca1ee1b4e1335beb3692bef45 Mon Sep 17 00:00:00 2001 From: Florent Poinsard Date: Thu, 4 Jan 2024 12:38:33 -0500 Subject: [PATCH 3/4] Update the release instructions with how to update the entire get started section of the docs Signed-off-by: Florent Poinsard --- doc/internal/release/how-to-release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/internal/release/how-to-release.md b/doc/internal/release/how-to-release.md index c020a75be0c..1875db2853f 100644 --- a/doc/internal/release/how-to-release.md +++ b/doc/internal/release/how-to-release.md @@ -83,11 +83,11 @@ That includes: > - There are several pages we want to update: > - [The releases page](https://vitess.io/docs/releases/): we must add the new release to the list with all its information and link. The links can be broken (404 error) while we are preparing for the release, this is fine. > - [The local install page](https://vitess.io/docs/get-started/local/): we must use the proper version increment for this guide and the proper SHA. The SHA will have to be modified once the Release Pull Request and the release is tagged is merged. + > - [The Vitess Operator for Kubernetes page](https://vitess.io/docs/get-started/operator/#install-the-operator), [the Local Install via source for Mac page](https://vitess.io/docs/get-started/local-mac/#install-vitess), [the Local Install via Docker page](https://vitess.io/docs/get-started/local-docker/#check-out-the-vitessiovitess-repository), and [the Vttestserver Docker Image page](https://vitess.io/docs/18.0/get-started/vttestserver-docker-image/#check-out-the-vitessiovitess-repository): we must checkout to the proper release branch after cloning Vitess. > - If we are doing a GA or RC release follow the instructions below: > - There are two scripts in the website repository in `./tools/{ga|rc}_release.sh`, use them to update the website documentation. The scripts automate: > - For an RC, we need to create a new entry in the sidebar which represents the next version on `main` and mark the version we are releasing as RC. > - For a GA, we need to mark the version we are releasing as "Stable" and the next one as "Development". - > - Update [Install Operator](https://vitess.io/docs/get-started/operator/#install-the-operator): the snippet where we clone the vitess repository has to include `git checkout release-xx.0`. With `xx` being the major version we are releasing. - **Create a new GitHub Milestone** > - Our GitHub Milestones is a good representation of all our ongoing development cycles. We have a Milestone for `main` and for all release branches. > - After doing Code Freeze, we can create a new GitHub Milestone that matches the next development cycle. From d1acad0650d43844338648c7b4c85992eeb9b671 Mon Sep 17 00:00:00 2001 From: Florent Poinsard Date: Thu, 4 Jan 2024 12:48:34 -0500 Subject: [PATCH 4/4] Review suggestion Signed-off-by: Florent Poinsard --- doc/internal/release/how-to-release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/internal/release/how-to-release.md b/doc/internal/release/how-to-release.md index 1875db2853f..08411f9c0ac 100644 --- a/doc/internal/release/how-to-release.md +++ b/doc/internal/release/how-to-release.md @@ -83,7 +83,7 @@ That includes: > - There are several pages we want to update: > - [The releases page](https://vitess.io/docs/releases/): we must add the new release to the list with all its information and link. The links can be broken (404 error) while we are preparing for the release, this is fine. > - [The local install page](https://vitess.io/docs/get-started/local/): we must use the proper version increment for this guide and the proper SHA. The SHA will have to be modified once the Release Pull Request and the release is tagged is merged. - > - [The Vitess Operator for Kubernetes page](https://vitess.io/docs/get-started/operator/#install-the-operator), [the Local Install via source for Mac page](https://vitess.io/docs/get-started/local-mac/#install-vitess), [the Local Install via Docker page](https://vitess.io/docs/get-started/local-docker/#check-out-the-vitessiovitess-repository), and [the Vttestserver Docker Image page](https://vitess.io/docs/18.0/get-started/vttestserver-docker-image/#check-out-the-vitessiovitess-repository): we must checkout to the proper release branch after cloning Vitess. + > - [The Vitess Operator for Kubernetes page](https://vitess.io/docs/get-started/operator/#install-the-operator), [the Local Install via source for Mac page](https://vitess.io/docs/get-started/local-mac/#install-vitess), [the Local Install via Docker page](https://vitess.io/docs/get-started/local-docker/#check-out-the-vitessiovitess-repository), and [the Vttestserver Docker Image page](https://vitess.io/docs/get-started/vttestserver-docker-image/#check-out-the-vitessiovitess-repository): we must checkout to the proper release branch after cloning Vitess. > - If we are doing a GA or RC release follow the instructions below: > - There are two scripts in the website repository in `./tools/{ga|rc}_release.sh`, use them to update the website documentation. The scripts automate: > - For an RC, we need to create a new entry in the sidebar which represents the next version on `main` and mark the version we are releasing as RC.