Rewrite multicluster page descriptions (next trees)#2721
Merged
Conversation
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the description frontmatter across the Calico Enterprise and Calico Cloud next/unversioned multicluster documentation to provide product-specific, action-oriented, non-duplicative page descriptions.
Changes:
- Rewrites
description:frontmatter in 20 multicluster docs pages (15 CE, 5 CC). - Disambiguates Calico Enterprise vs Calico Cloud descriptions using self-managed vs SaaS framing.
- Removes prior cross-product duplicate description strings for overlapping pages (for example
aws,index,kubeconfig,overview,services-controller).
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| calico-enterprise/multicluster/index.mdx | Updates CE multicluster landing-page meta description. |
| calico-enterprise/multicluster/fine-tune-deployment.mdx | Refines production hardening page meta description. |
| calico-enterprise/multicluster/change-cluster-type.mdx | Updates cluster-role conversion page meta description. |
| calico-enterprise/multicluster/set-up-multi-cluster-management/index.mdx | Updates CE multi-cluster management section index meta description. |
| calico-enterprise/multicluster/set-up-multi-cluster-management/standard-install/index.mdx | Updates standard-install section index meta description. |
| calico-enterprise/multicluster/set-up-multi-cluster-management/standard-install/create-a-management-cluster.mdx | Updates management-cluster creation page meta description. |
| calico-enterprise/multicluster/set-up-multi-cluster-management/standard-install/create-a-managed-cluster.mdx | Updates managed-cluster registration page meta description. |
| calico-enterprise/multicluster/set-up-multi-cluster-management/helm-install/index.mdx | Updates Helm-install section index meta description. |
| calico-enterprise/multicluster/set-up-multi-cluster-management/helm-install/create-a-management-cluster-helm.mdx | Updates Helm management-cluster page meta description. |
| calico-enterprise/multicluster/set-up-multi-cluster-management/helm-install/create-a-managed-cluster-helm.mdx | Updates Helm managed-cluster page meta description. |
| calico-enterprise/multicluster/federation/index.mdx | Updates CE federation section index meta description. |
| calico-enterprise/multicluster/federation/overview.mdx | Updates CE cluster-mesh overview meta description. |
| calico-enterprise/multicluster/federation/kubeconfig.mdx | Updates CE cluster-mesh setup meta description. |
| calico-enterprise/multicluster/federation/services-controller.mdx | Updates CE federated services page meta description. |
| calico-enterprise/multicluster/federation/aws.mdx | Updates CE AWS example page meta description. |
| calico-cloud/multicluster/index.mdx | Updates CC multicluster landing-page meta description. |
| calico-cloud/multicluster/overview.mdx | Updates CC cluster-mesh overview meta description. |
| calico-cloud/multicluster/kubeconfig.mdx | Updates CC cluster-mesh setup meta description. |
| calico-cloud/multicluster/services-controller.mdx | Updates CC federated services page meta description. |
| calico-cloud/multicluster/aws.mdx | Updates CC AWS example page meta description. |
Comment on lines
1
to
3
| --- | ||
| description: A sample configuration of Calico Enterprise federated endpoint identity and federated services for an AWS cluster. | ||
| description: Sample Calico Cloud cluster mesh configuration that peers an on-premises cluster with an AWS VPC cluster using BGP, NLB, and the Federated Services Controller. | ||
| --- |
Collaborator
Author
There was a problem hiding this comment.
yes update the body for this one
Comment on lines
1
to
3
| --- | ||
| description: Configure a federated service for cross-cluster service discovery for local clusters. | ||
| description: Configure a Calico Cloud federated service with the Tigera Federated Services Controller to surface endpoints from connected clusters in the SaaS plane. | ||
| --- |
Comment on lines
1
to
3
| --- | ||
| description: Configure a federated service for cross-cluster service discovery for local clusters. | ||
| description: Configure a Calico Enterprise federated service with the Tigera Federated Services Controller to consolidate endpoints across a cluster mesh. | ||
| --- |
Rewrites the description frontmatter on every page in the multicluster book across the two unversioned next-release source trees -- 20 files, 1-line replacement each. Same rule set as the prior sibling PRs. calico-enterprise/multicluster/ -- 15 files calico-cloud/multicluster/ -- 5 files CE framing: self-managed management cluster, in-cluster federation controller. CC framing: Calico Cloud SaaS management plane connecting to managed/connected clusters.
- calico-cloud/multicluster/aws.mdx body: replaced "Calico Enterprise configuration" → "Calico Cloud configuration" and "Calico Enterprise Federated Services Controller" → "Calico Cloud Federated Services Controller" per @ctauchen's review comment. - Mirrored all next-tree multicluster descriptions to: - calico-enterprise_versioned_docs/version-3.23-1/multicluster/ (15) - calico-enterprise_versioned_docs/version-3.22-2/multicluster/ (15) - calico-cloud_versioned_docs/version-22-2/multicluster/ (5) 35 mirror writes plus 1 body edit on the aws page. No drift either way. The two Copilot comments on services-controller.mdx note a mismatch between description ("Federated Services Controller" plural) and one body sentence ("Federated Service Controller" singular). The plural matches the API resource name (FederatedServicesController) and the rest of the page body, so the description is left as-is; the body inconsistency is pre-existing and out of scope here. Vale clean on description lines. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
ctauchen
force-pushed
the
descriptions-multicluster
branch
from
ccfc363 to
7e5afe4
Compare
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.
Summary
Rewrites the
descriptionfrontmatter on every page in the multicluster book across the two unversioned (next-release) source trees -- 20 files, 1-line replacement each. Same rule set as #2696, #2697, #2708, #2709, #2710, #2711, #2718, #2719, #2720.calico-enterprise/multicluster/calico-cloud/multicluster/Calico Open Source has no multicluster book, so this PR is CE + CC only.
Next-only on purpose. Landing on unversioned source first so descriptions can get review without pre-mirroring to versioned snapshots that would all need amending if anything changes. Mirror to published latest-version snapshots in a follow-up.
CE vs CC disambiguation
The pre-fix state had 5 literal cross-product duplicates --
aws.mdx,index.mdx,kubeconfig.mdx,overview.mdx, andservices-controller.mdxshared identical descriptions between the CE federation directory and the CC multicluster directory.Rewrites disambiguate by deployment model:
What every new description follows
Calico Enterprise,Calico Cloud).docs-frontmatter-descriptionskill's content-type rules.enable,disable, orteaching.GKE's), nowalks through, noallowlist(ing), andTigera Operatorcapitalized correctly.Pre-fix violations across the 20 files
enable/disable/teaching).walks through, possessive, orallowlisthits.calico-enterprise/multicluster/federation/*andcalico-cloud/multicluster/*(aws, index, kubeconfig, overview, services-controller).kubeconfigsplural) -- rephrased toper-cluster kubeconfig credentials.Verification
Run from repo root on this branch:
Length, canonical-name presence, and cross-product-uniqueness checks are equivalent one-liners over the same two directories. All return empty post-fix.
Vale on changed files, filtered to line-2 issues, returns empty:
Test plan
aws,index,kubeconfig,overview,services-controller) for distinguishability.