Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update steps to release versioned docs #3897

Merged
merged 2 commits into from
Jun 28, 2021
Merged

Update steps to release versioned docs #3897

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d97414
Update steps to release versioned docs.
kavirajk Jun 24, 2021
a867b27
Add step to update `latest_version`
kavirajk Jun 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/sources/maintaining/release.md
View file
Open in desktop
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`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jvrplmlmn perhaps we can build this into our RelEng work in rt?

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.