-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
docs: Helm: Don't show defaults for loki
section
#12747
Conversation
This PR must be merged before a backport PR will be created. |
@DylanGuedes, please update the other files listed in the checklist. For Helm chart changes bump the Helm chart version in |
these are unnecessary tbh. I'm not releasing a new helm version just with just this change and we don't want to add a docs change to the changelog. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[docs team] LGTM, might be helpful to add a link to values.yaml
.
"useTestSchema": false | ||
} | ||
<td><pre lang=""> | ||
See values.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See values.yaml | |
See [values.yaml](https://github.com/grafana/loki/blob/main/production/helm/loki/values.yaml) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that reference.md
file is always regenerated. We'd have to instead add the link it on values.yaml
in such a way that the generated reference.md
would generate the desired link.
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-12747-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 1933f0e5e9dcdad36d4020b6c9e312a42451d9c2 When the conflicts are resolved, stage and commit the changes:
If you have the GitHub CLI installed: # Push the branch to GitHub:
git push --set-upstream origin backport-12747-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 12747 --json body --template 'Backport 1933f0e5e9dcdad36d4020b6c9e312a42451d9c2 from #12747{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title "chore: [release-3.0.x] docs: Helm: Don't show defaults for `loki` section" --body-file - --label "size/L" --label "area/helm" --label "type/docs" --label "backport" --base release-3.0.x --milestone release-3.0.x --web Or, if you don't have the GitHub CLI installed (we recommend you install it!): # Push the branch to GitHub:
git push --set-upstream origin backport-12747-to-release-3.0.x
# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-12747-to-release-3.0.x`.
# Remove the local backport branch
git switch main
git branch -D backport-12747-to-release-3.0.x |
What this PR does / why we need it:
Don't show defaults for
loki
section since it is too wide.Which issue(s) this PR fixes:
Fixes #12738
Special notes for your reviewer:
Checklist
CONTRIBUTING.md
guide (required)docs/sources/setup/upgrade/_index.md
production/helm/loki/Chart.yaml
and updateproduction/helm/loki/CHANGELOG.md
andproduction/helm/loki/README.md
. Example PRdeprecated-config.yaml
anddeleted-config.yaml
files respectively in thetools/deprecated-config-checker
directory. Example PR