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

docs: Helm: Don't show defaults for loki section #12747

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Conversation

DylanGuedes
Copy link
Contributor

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

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@DylanGuedes DylanGuedes requested a review from a team as a code owner April 23, 2024 10:25
@DylanGuedes DylanGuedes added type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories backport release-3.0.x labels Apr 23, 2024
@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

@JStickler
Copy link
Contributor

@DylanGuedes, please update the other files listed in the checklist. For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md.

@DylanGuedes
Copy link
Contributor Author

@DylanGuedes, please update the other files listed in the checklist. For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md.

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.

Copy link
Contributor

@JStickler JStickler left a 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
See values.yaml
See [values.yaml](https://github.com/grafana/loki/blob/main/production/helm/loki/values.yaml)

Copy link
Contributor Author

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.

@DylanGuedes DylanGuedes merged commit 1933f0e into main Apr 24, 2024
61 checks passed
@DylanGuedes DylanGuedes deleted the fix-helm-docs branch April 24, 2024 21:08
@grafanabot
Copy link
Collaborator

The backport to release-3.0.x failed:

The process '/usr/bin/git' failed with exit code 1

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:

git add . && git cherry-pick --continue

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/helm backport release-3.0.x backport-failed size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs feedback: /docs/sources/setup/install/helm/reference.md
4 participants