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

Build both Mimir docs sources in deploy preview #10580

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Feb 4, 2025

Signed-off-by: Jack Baldry [email protected]

What this PR does

This change to the workflow builds both the Mimir docs and the Mimir Helm chart docs in a single deploy preview and posts the links to both back on the PR.

Checklist

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

@jdbaldry jdbaldry force-pushed the jdb/2025-02-build-both-mimir-docs branch 2 times, most recently from 5cbffff to 4b0b4db Compare February 4, 2025 17:34
@jdbaldry jdbaldry force-pushed the jdb/2025-02-build-both-mimir-docs branch from 4b0b4db to c100456 Compare February 25, 2025 06:27
Signed-off-by: Jack Baldry <[email protected]>
(cherry picked from commit d0c61ea)
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry marked this pull request as ready for review February 25, 2025 06:41
@jdbaldry jdbaldry requested review from tacole02 and a team as code owners February 25, 2025 06:41
Copy link
Contributor

@robbymilo robbymilo left a comment

Choose a reason for hiding this comment

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

Sweet!

@jdbaldry
Copy link
Member Author

Thanks for the reviews, a mimir maintainer can merge this whenever they want the feature

Comment on lines +25 to +28
"relative_prefix": "/docs/mimir/v2.15.x/",
"repo": "mimir",
"source_directory": "docs/sources/mimir",
"website_directory": "content/docs/mimir/v2.15.x"
Copy link
Contributor

Choose a reason for hiding this comment

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

Does Mimir release shepherds need to keep these values in-sync with current active releases? If yes, can we add a note about that in the RELEASE.md.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I think so because I can't add steps in to the workflow because its using a reusable workflow rather than calling an action.

I went to update the RELEASE file but I wasn't sure where to put things.

I don't see anything about updating the variables in https://github.com/grafana/mimir/blob/jdb%2F2025-02-build-both-mimir-docs/docs/sources/helm-charts/mimir-distributed/_index.md?plain=1#L10-L12 which is an associated release task. Do you have any ideas where I should put it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants