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.

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

Update steps to release versioned docs #3897

Merged
merged 2 commits into from
Jun 28, 2021

Conversation

kavirajk
Copy link
Collaborator

@kavirajk kavirajk commented Jun 24, 2021

What this PR does / why we need it:
Update steps to release versioned docs. (Need to be automated)

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

Which issue(s) this PR fixes:
Fixes #3317

Special notes for your reviewer:

Checklist

  • Documentation added
  • Tests updated

This makes versioned docs in consistent with Grafana.
More details:
grafana/website#4970
grafana/website#4970

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
@kavirajk kavirajk changed the title Update steps to release versioned docs. Update steps to release versioned docs Jun 24, 2021
Copy link
Contributor

@dannykopping dannykopping left a comment

Choose a reason for hiding this comment

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

❤️ thank you Kavi! This is great!

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?

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
@sandeepsukhani sandeepsukhani merged commit f00a235 into main Jun 28, 2021
@sandeepsukhani sandeepsukhani deleted the loki-release-doc-version-update branch June 28, 2021 08:35
owen-d pushed a commit to owen-d/loki that referenced this pull request Jun 29, 2021
* Update steps to release versioned docs.

This makes versioned docs in consistent with Grafana.
More details:
grafana/website#4970
grafana/website#4970

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

* Add step to update `latest_version`

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Fix the meaning of "latest" docs in Loki
3 participants