DOCS-3032: Improve openings of CE resource reference pages - #3011
Merged
Conversation
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The updated caliconodestatus.mdx note now conflicts with the unchanged caution block terminology/grammar (“kubernetes apiserver”, etc.), introducing a new internal inconsistency across all touched versions.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Applies the DOCS-3029 “opening cleanup” wording updates to Calico Enterprise resource reference pages, both in next (unversioned) and in versions 3.21-2 through 3.24-2, to improve readability and consistency across the CE docs set.
Changes:
- Improves and standardizes first-paragraph openings (grammar fixes, sentence casing, backticks for resource kinds).
- Expands acronyms (BGP, IPAM) at first paragraph-level usage on relevant pages.
- Adjusts heading level in
caliconodestatus.mdxand clarifies notes about operational impact.
File summaries
| File | Description |
|---|---|
| calico-enterprise/reference/resources/tier.mdx | Fixes punctuation to properly introduce example list. |
| calico-enterprise/reference/resources/stagedkubernetesnetworkpolicy.mdx | Capitalizes “Kubernetes” in opening sentence. |
| calico-enterprise/reference/resources/networkset.mdx | Adds backticks for resource kind and fixes grammar in namespacing sentence. |
| calico-enterprise/reference/resources/ipamconfig.mdx | Expands IPAM at first mention in opening. |
| calico-enterprise/reference/resources/globalnetworkset.mdx | Adds backticks for resource kind in opening. |
| calico-enterprise/reference/resources/caliconodestatus.mdx | Rewrites opening, expands BGP, fixes heading level. |
| calico-enterprise/reference/resources/blockaffinity.mdx | Clarifies what BlockAffinity represents and that it is auto-managed. |
| calico-enterprise/reference/resources/bgppeer.mdx | Expands BGP and improves opening clarity/terminology. |
| calico-enterprise/reference/resources/bgpfilter.mdx | Sentence-cases heading; expands BGP; improves opening and link. |
| calico-enterprise/reference/resources/bgpconfig.mdx | Expands BGP and tightens opening sentence. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/tier.mdx | Fixes punctuation to properly introduce example list. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/stagedkubernetesnetworkpolicy.mdx | Capitalizes “Kubernetes” in opening sentence. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/networkset.mdx | Adds backticks for resource kind and fixes grammar in namespacing sentence. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/ipamconfig.mdx | Expands IPAM at first mention in opening. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/globalnetworkset.mdx | Adds backticks for resource kind in opening. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/caliconodestatus.mdx | Rewrites opening, expands BGP, fixes heading level. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/blockaffinity.mdx | Clarifies what BlockAffinity represents and that it is auto-managed. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgppeer.mdx | Expands BGP and improves opening clarity/terminology. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpfilter.mdx | Sentence-cases heading; expands BGP; improves opening and link. |
| calico-enterprise_versioned_docs/version-3.24-2/reference/resources/bgpconfig.mdx | Expands BGP and tightens opening sentence. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/tier.mdx | Fixes punctuation to properly introduce example list. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/stagedkubernetesnetworkpolicy.mdx | Capitalizes “Kubernetes” in opening sentence. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/networkset.mdx | Adds backticks for resource kind and fixes grammar in namespacing sentence. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/ipamconfig.mdx | Expands IPAM at first mention in opening. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/globalnetworkset.mdx | Adds backticks for resource kind in opening. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/caliconodestatus.mdx | Rewrites opening, expands BGP, fixes heading level. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/blockaffinity.mdx | Clarifies what BlockAffinity represents and that it is auto-managed. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgppeer.mdx | Expands BGP and improves opening clarity/terminology. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpfilter.mdx | Sentence-cases heading; expands BGP; improves opening and link. |
| calico-enterprise_versioned_docs/version-3.23-2/reference/resources/bgpconfig.mdx | Expands BGP and tightens opening sentence. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/tier.mdx | Fixes punctuation to properly introduce example list. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/stagedkubernetesnetworkpolicy.mdx | Capitalizes “Kubernetes” in opening sentence. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/networkset.mdx | Adds backticks for resource kind and fixes grammar in namespacing sentence. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/ipamconfig.mdx | Expands IPAM at first mention in opening. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/globalnetworkset.mdx | Adds backticks for resource kind in opening. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/caliconodestatus.mdx | Rewrites opening, expands BGP, fixes heading level. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/blockaffinity.mdx | Clarifies what BlockAffinity represents and that it is auto-managed. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgppeer.mdx | Expands BGP and improves opening clarity/terminology. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpfilter.mdx | Sentence-cases heading; expands BGP; improves opening and link. |
| calico-enterprise_versioned_docs/version-3.22-2/reference/resources/bgpconfig.mdx | Expands BGP and tightens opening sentence. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/tier.mdx | Fixes punctuation to properly introduce example list. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/stagedkubernetesnetworkpolicy.mdx | Capitalizes “Kubernetes” in opening sentence. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/networkset.mdx | Adds backticks for resource kind and fixes grammar in namespacing sentence. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/ipamconfig.mdx | Expands IPAM at first mention in opening. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/globalnetworkset.mdx | Adds backticks for resource kind in opening. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/caliconodestatus.mdx | Rewrites opening, expands BGP, fixes heading level. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/blockaffinity.mdx | Clarifies what BlockAffinity represents and that it is auto-managed. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgppeer.mdx | Expands BGP and improves opening clarity/terminology. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpfilter.mdx | Sentence-cases heading; expands BGP; improves opening and link. |
| calico-enterprise_versioned_docs/version-3.21-2/reference/resources/bgpconfig.mdx | Expands BGP and tightens opening sentence. |
Review details
- Files reviewed: 50/50 changed files
- Comments generated: 5
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## Notes | ||
|
|
||
| The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. | ||
| Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. |
| ## Notes | ||
|
|
||
| The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. | ||
| Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. |
| ## Notes | ||
|
|
||
| The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. | ||
| Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. |
| ## Notes | ||
|
|
||
| The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. | ||
| Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. |
| ## Notes | ||
|
|
||
| The updating of `CalicoNodeStatus` will have a small performance impact on CPU/Memory usage of the node as well as adding load to kubernetes apiserver. | ||
| Updating `CalicoNodeStatus` has a small performance impact on CPU and memory usage of the node, and adds load to the Kubernetes API server. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Applies the DOCS-3029 (#3010) opening cleanups to the Calico Enterprise resource reference pages, in next and in versions 3.21-2 through 3.24-2. Text changes match the OSS PR exactly; the networkset alias fix does not apply because the CE page never had the misplaced sentence.
https://tigera.atlassian.net/browse/DOCS-3032
Representative changed pages on the deploy preview: