Skip to content

Commit

Permalink
Update steps to release versioned docs (#3897)
Browse files Browse the repository at this point in the history
* Update steps to release versioned docs.

This makes versioned docs in consistent with Grafana.
More details:
https://github.com/grafana/website/pull/4970
https://github.com/grafana/website/pull/4970

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Add step to update `latest_version`

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
  • Loading branch information
kavirajk committed Jun 28, 2021
1 parent 3c23ca6 commit f00a235
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/sources/maintaining/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,16 @@ Once the previous two steps are completed, you can publish your draft!

Loki docs are versioned. Follow the below steps to version Loki docs for this release.

>NOTE: Here $LOCAL_LOKI_PATH is your local path where Loki is checked out with correct $VERSION

1. Clone Grafana website [repo](https://github.com/grafana/website)
1. Create new branch `git checkout -b loki-v1.2.3` (replace `v1.2.3` with current release version)
1. Run `make project-doc-release`
1. It prompts for two things. `Project name` and `version`. Project name is `loki` and version is current release version.
1. Create new branch `git checkout -b $VERSION` (replace `$VERSION` with current release version. e.g: `v2.2.1`)
1. Run `mv content/docs/loki/next content/docs/loki/next.main`
1. Run `mkdir content/docs/loki/next`
1. Run `cp -R $LOCAL_LOKI_PATH/docs/sources/* content/docs/loki/next`
1. Run `scripts/docs-release.sh loki latest next`
1. Run `scripts/docs-release.sh loki $VERSION latest`
1. Run `mv content/docs/loki/next.main content/docs/loki/next`
1. Update `version_latest` to `$VERSION` in `content/docs/loki/_index.md`
1. Docs will be generated for this release.
1. Create PR and Merge it after approval.

0 comments on commit f00a235

Please sign in to comment.