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

Build both Mimir docs sources in deploy preview #10580

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

Build both Mimir docs sources in deploy preview #10580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
abc7121
Build both Mimir docs sources in deploy preview
jdbaldry Feb 4, 2025
c100456
Use Mimir version referenced in Helm charts documentation
jdbaldry Feb 4, 2025
9b53da3
Lint
jdbaldry Feb 25, 2025
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
27 changes: 20 additions & 7 deletions .github/workflows/deploy-pr-preview.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,28 @@ on:

jobs:
deploy-pr-preview:
if: ${{ ! github.event.pull_request.head.repo.fork }}
if: "!github.event.pull_request.head.repo.fork"
uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@main
with:
sha: ${{ github.event.pull_request.head.sha }}
branch: ${{ github.head_ref }}
event_number: ${{ github.event.number }}
title: ${{ github.event.pull_request.title }}
repo: mimir
source_directory: docs/sources/mimir
website_directory: content/docs/mimir/latest
relative_prefix: /docs/mimir/latest/
index_file: true
sha: ${{ github.event.pull_request.head.sha }}
sources: |
[
{
"index_file": null,
"relative_prefix": "/docs/mimir/v2.15.x/",
"repo": "mimir",
"source_directory": "docs/sources/mimir",
"website_directory": "content/docs/mimir/v2.15.x"
Comment on lines +25 to +28
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?

},
{
"index_file": "content/docs/helm-charts/mimir-distributed/_index.md",
"relative_prefix": "/docs/helm-charts/mimir-distributed/latest/",
"repo": "mimir",
"source_directory": "docs/sources/helm-charts/mimir-distributed",
"website_directory": "content/docs/helm-charts/mimir-distributed/latest"
}
]
title: ${{ github.event.pull_request.title }}
2 changes: 1 addition & 1 deletion docs/sources/mimir/configure/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ weight: 30

# Configure Grafana Mimir

Grafana Mimir's flexibility is achieved through configuration.
Tune the Grafana Mimir configuration to suit your environment.

{{< section menuTitle="true" >}}
Loading