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

Jump to bottom

docs: Update Kubernetes terminology in operations pages #12235

Merged
merged 4 commits into from
Mar 18, 2024
Merged

docs: Update Kubernetes terminology in operations pages #12235

merged 4 commits into from
Mar 18, 2024

Conversation

edsoncelio
Copy link
Contributor

@edsoncelio edsoncelio commented Mar 16, 2024 •
edited
Loading

What this PR does / why we need it:
Update docs to use the correct Kubernetes terminology.
https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/#kubernetes-objects

Which issue(s) this PR fixes:
Fixes #11944

Special notes for your reviewer:
Command to check using vale:

vale --filter='.Name =="Grafana.Kubernetes"' docs/sources/operations/

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • CHANGELOG.md updated
    • If the change is worth mentioning in the release notes, add add-to-release-notes label
  • 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

@edsoncelio edsoncelio requested a review from a team as a code owner March 16, 2024 18:57
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Mar 16, 2024
@edsoncelio edsoncelio marked this pull request as draft March 16, 2024 18:58
@pull-request-size pull-request-size bot added size/M and removed size/S labels Mar 16, 2024
@edsoncelio edsoncelio changed the title docs: Update Kubernetes terminology in operations/troubleshooting docs: Update Kubernetes terminology in operations pages Mar 16, 2024
@edsoncelio edsoncelio marked this pull request as ready for review March 16, 2024 19:03
jdbaldry
jdbaldry approved these changes Mar 18, 2024
View reviewed changes
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

Special notes for your reviewer:
Command to check using vale:

vale --filter='.Name =="Grafana.Kubernetes"' docs/sources/operations/

❤️

@edsoncelio edsoncelio force-pushed the update_k8s_terminology_operations_troubleshooting branch from a772349 to ddf7712 Compare March 18, 2024 13:06
@edsoncelio
Copy link
Contributor Author

FYI @jdbaldry: I've done a rebase to update with main branch :)

jdbaldry
jdbaldry reviewed Mar 18, 2024
View reviewed changes
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

I've approved the CI for the updated history and thrown out a couple of suggestions whilst we are here making these changes. Thanks again!

docs/sources/operations/storage/wal.md Outdated Show resolved Hide resolved
docs/sources/operations/storage/wal.md Outdated Show resolved Hide resolved
docs/sources/operations/storage/wal.md Outdated Show resolved Hide resolved
JStickler
JStickler approved these changes Mar 18, 2024
View reviewed changes
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.

@JStickler JStickler merged commit 0bf894b into grafana:main Mar 18, 2024
12 checks passed
grafanabot pushed a commit that referenced this pull request Mar 18, 2024
@edsoncelio @grafana-delivery-bot
docs: Update Kubernetes terminology in operations pages (#12235)
e360d2d 
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
(cherry picked from commit 0bf894b)
@grafanabot grafanabot mentioned this pull request Mar 18, 2024
Merged
8 tasks
edsoncelio added a commit to edsoncelio/loki that referenced this pull request Mar 22, 2024
@edsoncelio @JStickler @jdbaldry
docs: Update Kubernetes terminology in operations pages (grafana#12235)
b897510 
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
rhnasc pushed a commit to inloco/loki that referenced this pull request Apr 12, 2024
@edsoncelio @JStickler
@jdbaldry @rhnasc
docs: Update Kubernetes terminology in operations pages (grafana#12235)
98c1340 
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jdbaldry jdbaldry jdbaldry approved these changes

@JStickler JStickler JStickler approved these changes

Assignees
No one assigned
Labels
backport release-2.9.x size/M type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use correct Kubernetes terminology throughout documentation
3 participants
@edsoncelio @JStickler @jdbaldry