From e666c3bb58f7c93603734adad7b4c87e0d283715 Mon Sep 17 00:00:00 2001 From: Bridget Kromhout Date: Tue, 1 Jun 2021 10:33:30 -0500 Subject: [PATCH] Update the docs site for a release. (#3471) * Update the docs site for a release. Signed-off-by: Bridget Kromhout * Apply suggestions from code review Signed-off-by: Bridget Kromhout Co-authored-by: Jon Huhn Co-authored-by: Jon Huhn --- docs/release_guide.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/release_guide.md b/docs/release_guide.md index 6f03f1363f..3515d5f7ab 100644 --- a/docs/release_guide.md +++ b/docs/release_guide.md @@ -24,6 +24,7 @@ Once an RC has been found to be stable, cut a release tagged `vX.Y.Z` using the - [Update release branch with patches and versioning changes](#update-release-branch-with-patches-and-versioning-changes) - [Create and push a Git tag](#create-and-push-a-git-tag) - [Add release notes](#add-release-notes) + - [Update docs site](#update-docs-site) - [Announce the new release](#announce-the-new-release) - [Make version changes on main branch](#make-version-changes-on-main-branch) - [Make version changes on docs.openservicemesh.io](#make-version-changes-on-docsopenservicemeshio) @@ -97,6 +98,20 @@ upload the packaged binaries and checksums as release assets, build and push Doc In the description section of the new release, add information about feature additions, bug fixes, and any other administrative tasks completed on the repository. +## Update docs site + +In the docs site's main branch, edit the file [https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md) to update any version references in the manual demo. + + - [This demo of OSM v0.8.4 requires:](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L13) + - [Download the 64-bit GNU/Linux or macOS binary of OSM v0.8.4:](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L30) + - [release=v0.8.4](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L33) + - [Download the 64-bit Windows OSM v0.8.4 binary via Powershell:](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L40) + - [wget https://github.com/openservicemesh/osm/releases/download/v0.8.4/osm-v0.8.4-windows-amd64.zip -o osm.zip](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L42) + - [image: openservicemesh/bookbuyer:v0.8.4](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L199) + - [image: openservicemesh/bookthief:v0.8.4](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L231) + - [image: openservicemesh/bookstore:v0.8.4](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L283) + - [image: openservicemesh/bookwarehouse:v0.8.4](https://github.com/openservicemesh/osm-docs/blame/main/content/docs/install/manual_demo.md#L339) + ## Announce the new release Make an announcement on the [mailing list](https://groups.google.com/g/openservicemesh) and [Slack channel](https://cloud-native.slack.com/archives/C018794NV1C).