DOCS-3033: Improve openings of CC resource reference pages - #3012
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
A couple of small but user-visible terminology/capitalization inconsistencies remain in the updated docs (notably CalicoNodeStatus “kubernetes apiserver” and BGPFilter “case-sensitive aliases”).
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates Calico Cloud resource reference documentation (unversioned “next” and version 23-2) to improve the opening paragraphs for multiple resource pages, aligning with prior Enterprise cleanups, and adds an existing (previously unreachable via nav) policy recommendations reference page to Calico Cloud sidebars.
Changes:
- Refines introductory text for several Calico Cloud resource reference pages (next + v23-2) for clarity and consistency.
- Adds
reference/resources/policyrecommendationsto both Calico Cloud sidebars so the page is reachable from navigation.
File summaries
| File | Description |
|---|---|
| sidebars-calico-cloud.js | Adds the Policy Recommendations resource reference page to the Calico Cloud “Resources” sidebar. |
| calico-cloud/reference/resources/tier.mdx | Fixes punctuation in the opening paragraph to properly introduce the example list. |
| calico-cloud/reference/resources/stagedkubernetesnetworkpolicy.mdx | Capitalizes “Kubernetes” in the opening sentence for consistency. |
| calico-cloud/reference/resources/networkset.mdx | Improves resource-name formatting and clarifies namespaced phrasing in the intro. |
| calico-cloud/reference/resources/ipamconfig.mdx | Expands “IPAM” on first use in the opening sentence. |
| calico-cloud/reference/resources/globalnetworkset.mdx | Improves resource-name formatting in the opening sentence. |
| calico-cloud/reference/resources/caliconodestatus.mdx | Reworks the opening to better explain usage and adjusts “Notes” heading/wording. |
| calico-cloud/reference/resources/blockaffinity.mdx | Clarifies what a BlockAffinity represents and that it’s typically managed automatically. |
| calico-cloud/reference/resources/bgppeer.mdx | Expands “BGP” on first use and improves clarity in the intro. |
| calico-cloud/reference/resources/bgpfilter.mdx | Normalizes the heading casing and improves the intro wording and linking. |
| calico-cloud/reference/resources/bgpconfig.mdx | Expands “BGP” on first use and improves the intro wording. |
| calico-cloud_versioned_sidebars/version-23-2-sidebars.json | Adds the Policy Recommendations resource reference page to the v23-2 Calico Cloud sidebar. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/tier.mdx | Mirrors the tier intro punctuation fix for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/stagedkubernetesnetworkpolicy.mdx | Mirrors the “Kubernetes” capitalization fix for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/networkset.mdx | Mirrors the NetworkSet intro improvements for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/ipamconfig.mdx | Mirrors the IPAM expansion in the opening sentence for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/globalnetworkset.mdx | Mirrors the GlobalNetworkSet intro formatting improvement for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/caliconodestatus.mdx | Mirrors the CalicoNodeStatus intro and notes wording changes for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/blockaffinity.mdx | Mirrors the BlockAffinity intro clarification for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/bgppeer.mdx | Mirrors the BGPPeer intro clarity improvements for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/bgpfilter.mdx | Mirrors the BGPFilter heading/intro wording changes for v23-2. |
| calico-cloud_versioned_docs/version-23-2/reference/resources/bgpconfig.mdx | Mirrors the BGPConfiguration intro wording improvements for v23-2. |
Review details
- Files reviewed: 22/22 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+7
to
+9
| A Border Gateway Protocol (BGP) filter resource (`BGPFilter`) represents a way to control | ||
| routes imported by and exported to BGP peers | ||
| specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`). |
| ## 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. |
Comment on lines
+7
to
+9
| A Border Gateway Protocol (BGP) filter resource (`BGPFilter`) represents a way to control | ||
| routes imported by and exported to BGP peers | ||
| specified by a [BGP peer resource](bgppeer.mdx) (`BGPPeer`). |
| ## 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) and DOCS-3032 (#3011) opening cleanups to the Calico Cloud resource reference pages, in next and version 23-2. Text changes match the Enterprise PR exactly.
Also adds the existing policyrecommendations page to both Calico Cloud sidebars. It is listed in the Calico Enterprise sidebars but was omitted from Calico Cloud, leaving the page unreachable from the nav.
https://tigera.atlassian.net/browse/DOCS-3033
Representative changed pages on the deploy preview: