-
Notifications
You must be signed in to change notification settings - Fork 14.8k
Add glossary tooltips for resource terms #49852
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
Add glossary tooltips for resource terms #49852
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
Pull Request Overview
This PR enhances glossary entries across several documentation files by adding glossary tooltips and revising descriptions to improve clarity and consistency. Key changes include:
- Inserting glossary tooltips to clarify terms such as "resource", "API object", and "infrastructure resource."
- Revising textual descriptions for improved precision in several glossary entries.
- Updating examples and wording to align with the current documentation style.
Reviewed Changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
content/en/docs/reference/glossary/group-version-resource.md | Updated description and added tooltip for resource. |
content/en/docs/reference/glossary/limitrange.md | Revised constraints description with tooltip enhancements. |
content/en/docs/reference/glossary/customresourcedefinition.md | Modified description to reference API objects with tooltip updates. |
content/en/docs/reference/glossary/endpoint.md | Adjusted wording for legacy API resource tooltip usage. |
content/en/docs/reference/glossary/cgroup.md | Added tooltip for resource isolation phrasing. |
content/en/docs/reference/glossary/name.md | Added tooltip to clarify resource references in URLs. |
content/en/docs/reference/glossary/network-policy.md | Updated explanation with tooltip references for selectors and network policies. |
content/en/docs/reference/glossary/finalizer.md | Revised finalizer description with tooltip for API resources. |
content/en/docs/reference/glossary/cadvisor.md | Updated description with tooltip for infrastructure resource usage. |
content/en/docs/reference/glossary/ephemeral-container.md | Enhanced diagnostics guidance with tooltip augmentation. |
content/en/docs/reference/glossary/event.md | Streamlined event description with updated tooltip for object. |
content/en/docs/reference/glossary/horizontal-pod-autoscaler.md | Updated scaling description with tooltip emphasis on resource utilization. |
content/en/docs/reference/glossary/mixed-version-proxy.md | Refined wording to include a tooltip for API resource requests. |
content/en/docs/reference/glossary/kube-scheduler.md | Inserted tooltip for resource requirements clarity. |
content/en/docs/reference/glossary/disruption.md | Adjusted disruption description with tooltip for API resources. |
content/en/docs/reference/glossary/device-plugin.md | Enhanced description with a tooltip for infrastructure resources. |
content/en/docs/reference/glossary/api-group.md | Improved API group description with updated glossary tooltip references. |
content/en/docs/reference/glossary/helm-chart.md | Changed wording from resources to configurations for improved clarity. |
content/en/docs/reference/glossary/namespace.md | Updated namespace explanation with clearer examples and tooltip enhancements. |
content/en/docs/reference/glossary/container-env-variables.md | Revised description to clarify the nature of the details provided. |
Help people reading glossary entries understand what those entries mean by the term "resource".
4e8fb56
to
74bb265
Compare
/close See PR #50342 |
@sftim: Closed this PR. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Help people reading glossary entries understand what those entries mean by the term resource.
preview