Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
Update the docs site for a release. (#3471)
Browse files Browse the repository at this point in the history
* Update the docs site for a release.

Signed-off-by: Bridget Kromhout <[email protected]>

* Apply suggestions from code review

Signed-off-by: Bridget Kromhout <[email protected]>

Co-authored-by: Jon Huhn <[email protected]>

Co-authored-by: Jon Huhn <[email protected]>
  • Loading branch information
bridgetkromhout and nojnhuh authored Jun 1, 2021
1 parent 83c2a38 commit e666c3b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/release_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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).
Expand Down

0 comments on commit e666c3b

Please sign in to comment.