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): Improve the helm's NOTES.txt #12744

Merged
merged 11 commits into from
May 3, 2024

Conversation

cyriltovena
Copy link
Contributor

What this PR does / why we need it:

This PR improves the NOTES.txt shown after installation of the helm chart.

It's a start, but at least covers sending and retrieving logs from the cluster using curl and Grafana.

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

@cyriltovena cyriltovena requested a review from a team as a code owner April 23, 2024 08:50
@cyriltovena cyriltovena changed the title helm(docs): Improve the helm's NOTES.txt docs(helm): Improve the helm's NOTES.txt Apr 23, 2024
production/helm/loki/templates/NOTES.txt Outdated Show resolved Hide resolved
production/helm/loki/templates/NOTES.txt Show resolved Hide resolved
production/helm/loki/templates/NOTES.txt Outdated Show resolved Hide resolved
production/helm/loki/templates/NOTES.txt Outdated Show resolved Hide resolved
production/helm/loki/templates/NOTES.txt Outdated Show resolved Hide resolved
@cyriltovena cyriltovena enabled auto-merge (squash) May 3, 2024 08:19
Copy link
Contributor

@MichelHollands MichelHollands left a comment

Choose a reason for hiding this comment

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

LGTM

@cyriltovena cyriltovena merged commit 74b28ad into grafana:main May 3, 2024
61 checks passed
shantanualsi pushed a commit that referenced this pull request May 6, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
mraboosk pushed a commit to mraboosk/loki that referenced this pull request Oct 7, 2024
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants