Skip to content

Rewrite networking page descriptions (next trees)#2710

Open
ctauchen wants to merge 1 commit intotigera:mainfrom
ctauchen:descriptions-networking
Open

Rewrite networking page descriptions (next trees)#2710
ctauchen wants to merge 1 commit intotigera:mainfrom
ctauchen:descriptions-networking

Conversation

@ctauchen
Copy link
Copy Markdown
Collaborator

@ctauchen ctauchen commented May 8, 2026

Summary

Rewrites the description frontmatter on every page in the networking book across the three unversioned (next-release) source trees — 137 files, 1-line replacement each. Same rule set as #2696 and #2697.

Tree Files
calico/networking/ 50
calico-enterprise/networking/ 46
calico-cloud/networking/ 41
Total 137

This PR is next-only on purpose — landing on the unversioned source first so the descriptions can get review without being pre-mirrored to versioned snapshots that would all need amending if anything changes. After review, I will mirror to the published latest-version snapshots in a follow-up.

What every new description follows

  1. Names exactly one canonical product (Calico Open Source, Calico Enterprise, Calico Cloud).
  2. ≤ 200 characters.
  3. Action-led on procedural pages; noun-led on reference, requirements, troubleshooting, and overview pages per the docs-frontmatter-description skill's content-type rules.
  4. No enable, disable, or teaching.
  5. Unique across products.
  6. Vale-clean on line 2 (frontmatter description line).

What was wrong before

Pre-fix snapshot of the same files:

  • 0 forbidden-word hits — none in this bucket pre-fix.
  • 0 descriptions over 200 chars — none in this bucket pre-fix.
  • 123 of 137 missing a canonical product name — descriptions used the $[prodname] template variable (which Docusaurus does not interpolate inside frontmatter) or the bare word "Calico", instead of the canonical product names. Rewrites use the explicit canonical product everywhere.
  • 37 cross-product literal duplicates — features that exist in all three products (BGP peering, MTU tuning, VXLAN/IP-in-IP, IPAM, IPPools, egress gateways, ingress gateways, KubeVirt, training, dual ToR, etc.) had identical descriptions across product directories. Now disambiguated by product-specific context: Calico Cloud's "connected clusters" framing, Calico Enterprise's cluster / management-UI framing, Calico Open Source's resource-only framing.

Verification

Run from repo root on this branch:

grep -nEri "^description:.*\b(enable|disable|teaching)\b" \
  calico/networking calico-enterprise/networking calico-cloud/networking

Length, canonical-name presence, and cross-product-uniqueness checks are equivalent one-liners over the same three directories. All four return empty post-fix.

Test plan

  • Run the forbidden-word grep above and confirm empty.
  • Spot-check a handful of cross-product triples (e.g., configuring/bgp.mdx, configuring/mtu.mdx, ipam/ippools.mdx, egress/index.mdx) for distinguishability.
  • Spot-check 5 random rewrites against page bodies for accuracy.
  • After review, mirror to latest-version snapshots (calico_versioned_docs/version-3.32/networking/, calico-enterprise_versioned_docs/version-3.23-1/networking/, calico-enterprise_versioned_docs/version-3.22-2/networking/, calico-cloud_versioned_docs/version-22-2/networking/).

@ctauchen
Rewrite networking page descriptions in next trees
db56f4b 
Audit and rewrite frontmatter descriptions for the networking buckets in
the unversioned (next) trees of all three products: calico/networking
(50 files), calico-enterprise/networking (46 files), and
calico-cloud/networking (41 files).

Each new description names its canonical product (Calico Open Source,
Calico Enterprise, or Calico Cloud), stays under 200 characters, avoids
the forbidden words enable/disable/teaching, contains no colons, and is
unique across products. Cross-product disambiguation framing follows the
pattern from tigera#2696 and tigera#2697 — Calico Open Source descriptions stay
resource- and CLI-led, Calico Enterprise descriptions reference the
cluster and management UI, Calico Cloud descriptions emphasize
connected clusters.

Pre-fix snapshot of the same files: 0 descriptions over 200 chars,
0 forbidden words, 123 of 137 missing a canonical product name, and
37 cross-product duplicate descriptions.

Next-only on purpose; versioned mirrors will be applied in a follow-up
after review.
Copilot AI review requested due to automatic review settings May 8, 2026 16:05
@ctauchen ctauchen requested a review from a team as a code owner May 8, 2026 16:05
@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026 •
edited
Loading

✅ Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit db56f4b
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/69fe09c0f7038500088e574d
😎 Deploy Preview https://deploy-preview-2710--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026 •
edited
Loading

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit db56f4b
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/69fe09c08cdd3f0008424b1d
😎 Deploy Preview https://deploy-preview-2710--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 64 (🔴 down 23 from production)
Accessibility: 98 (no change from production)
Best Practices: 83 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI reviewed May 8, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a 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 rewrites the description frontmatter across all pages in the networking docs book for the three unversioned (“next”) product trees (Calico Open Source / Calico Enterprise / Calico Cloud) to use canonical product names, keep descriptions concise, and avoid cross-product duplicates.

Changes:

  • Replace description: frontmatter on 137 networking pages across calico/, calico-enterprise/, and calico-cloud/ next trees.
  • Standardize descriptions to explicitly name the canonical product and follow consistent content-type phrasing rules.
  • Reduce cross-product duplication by tailoring descriptions to product-specific framing.

Reviewed changes

Copilot reviewed 137 out of 137 changed files in this pull request and generated no comments.

Show a summary per file
File Description
calico/networking/index.mdx Rewrite frontmatter description for networking index page.
calico/networking/determine-best-networking.mdx Rewrite frontmatter description.
calico/networking/configuring/add-maglev-load-balancing.mdx Rewrite frontmatter description.
calico/networking/configuring/advertise-service-ips.mdx Rewrite frontmatter description.
calico/networking/configuring/bgp-to-workload.mdx Rewrite frontmatter description.
calico/networking/configuring/bgp.mdx Rewrite frontmatter description.
calico/networking/configuring/index.mdx Rewrite frontmatter description.
calico/networking/configuring/mtu.mdx Rewrite frontmatter description.
calico/networking/configuring/node-local-dns-cache.mdx Rewrite frontmatter description.
calico/networking/configuring/pod-mac-address.mdx Rewrite frontmatter description.
calico/networking/configuring/qos-controls.mdx Rewrite frontmatter description.
calico/networking/configuring/sidecar-acceleration.mdx Rewrite frontmatter description.
calico/networking/configuring/use-ipvs.mdx Rewrite frontmatter description.
calico/networking/configuring/vxlan-ipip.mdx Rewrite frontmatter description.
calico/networking/configuring/workloads-outside-cluster.mdx Rewrite frontmatter description.
calico/networking/ingress-gateway/about-calico-ingress-gateway.mdx Rewrite frontmatter description.
calico/networking/ingress-gateway/create-ingress-gateway.mdx Rewrite frontmatter description.
calico/networking/ingress-gateway/customize-ingress-gateway.mdx Rewrite frontmatter description.
calico/networking/ingress-gateway/migrate-from-nginx.mdx Rewrite frontmatter description.
calico/networking/ingress-gateway/tutorial-ingress-gateway-canary.mdx Rewrite frontmatter description.
calico/networking/ipam/add-floating-ip.mdx Rewrite frontmatter description.
calico/networking/ipam/assign-ip-addresses-topology.mdx Rewrite frontmatter description.
calico/networking/ipam/change-block-size.mdx Rewrite frontmatter description.
calico/networking/ipam/get-started-ip-addresses.mdx Rewrite frontmatter description.
calico/networking/ipam/index.mdx Rewrite frontmatter description for IPAM index page.
calico/networking/ipam/ip-autodetection.mdx Rewrite frontmatter description.
calico/networking/ipam/ippools.mdx Rewrite frontmatter description.
calico/networking/ipam/ipv6-control-plane.mdx Rewrite frontmatter description.
calico/networking/ipam/ipv6.mdx Rewrite frontmatter description.
calico/networking/ipam/legacy-firewalls.mdx Rewrite frontmatter description.
calico/networking/ipam/migrate-pools.mdx Rewrite frontmatter description.
calico/networking/ipam/service-loadbalancer.mdx Rewrite frontmatter description.
calico/networking/ipam/use-specific-ip.mdx Rewrite frontmatter description.
calico/networking/kubevirt/index.mdx Rewrite frontmatter description.
calico/networking/kubevirt/kubevirt-networking.mdx Rewrite frontmatter description.
calico/networking/kubevirt/live-migration-bgp.mdx Rewrite frontmatter description.
calico/networking/openstack/configuration.mdx Rewrite frontmatter description.
calico/networking/openstack/connectivity.mdx Rewrite frontmatter description.
calico/networking/openstack/dev-machine-setup.mdx Rewrite frontmatter description.
calico/networking/openstack/floating-ips.mdx Rewrite frontmatter description.
calico/networking/openstack/host-routes.mdx Rewrite frontmatter description.
calico/networking/openstack/index.mdx Rewrite frontmatter description for OpenStack index page.
calico/networking/openstack/ipv6.mdx Rewrite frontmatter description.
calico/networking/openstack/kuryr.mdx Rewrite frontmatter description.
calico/networking/openstack/labels.mdx Rewrite frontmatter description.
calico/networking/openstack/live-migration.mdx Rewrite frontmatter description.
calico/networking/openstack/multiple-regions.mdx Rewrite frontmatter description.
calico/networking/openstack/neutron-api.mdx Rewrite frontmatter description.
calico/networking/openstack/semantics.mdx Rewrite frontmatter description.
calico/networking/openstack/service-ips.mdx Rewrite frontmatter description.
calico-enterprise/networking/index.mdx Rewrite frontmatter description for networking index page.
calico-enterprise/networking/determine-best-networking.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/add-maglev-load-balancing.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/advertise-service-ips.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/bgp-to-workload.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/bgp.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/custom-bgp-config.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/dual-tor.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/index.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/mark-lb-node-for-maintenance.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/mtu.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/multiple-networks.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/node-local-dns-cache.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/pod-mac-address.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/qos-controls.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/vxlan-ipip.mdx Rewrite frontmatter description.
calico-enterprise/networking/configuring/workloads-outside-cluster.mdx Rewrite frontmatter description.
calico-enterprise/networking/egress/egress-gateway-aws.mdx Rewrite frontmatter description.
calico-enterprise/networking/egress/egress-gateway-azure.mdx Rewrite frontmatter description.
calico-enterprise/networking/egress/egress-gateway-maintenance.mdx Rewrite frontmatter description.
calico-enterprise/networking/egress/egress-gateway-on-prem.mdx Rewrite frontmatter description.
calico-enterprise/networking/egress/external-network.mdx Rewrite frontmatter description.
calico-enterprise/networking/egress/index.mdx Rewrite frontmatter description for egress index page.
calico-enterprise/networking/egress/troubleshoot.mdx Rewrite frontmatter description.
calico-enterprise/networking/ingress-gateway/about-calico-ingress-gateway.mdx Rewrite frontmatter description.
calico-enterprise/networking/ingress-gateway/create-ingress-gateway.mdx Rewrite frontmatter description.
calico-enterprise/networking/ingress-gateway/customize-ingress-gateway.mdx Rewrite frontmatter description.
calico-enterprise/networking/ingress-gateway/tutorial-ingress-gateway-canary.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/assign-ip-addresses-topology.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/change-block-size.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/get-started-ip-addresses.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/index.mdx Rewrite frontmatter description for IPAM index page.
calico-enterprise/networking/ipam/initial-ippool.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/ip-autodetection.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/ippools.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/ipv6.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/legacy-firewalls.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/migrate-pools.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/service-loadbalancer.mdx Rewrite frontmatter description.
calico-enterprise/networking/ipam/use-specific-ip.mdx Rewrite frontmatter description.
calico-enterprise/networking/kubevirt/index.mdx Rewrite frontmatter description.
calico-enterprise/networking/kubevirt/kubevirt-networking.mdx Rewrite frontmatter description.
calico-enterprise/networking/kubevirt/live-migration-bgp.mdx Rewrite frontmatter description.
calico-enterprise/networking/training/about-kubernetes-networking.mdx Rewrite frontmatter description.
calico-enterprise/networking/training/about-networking.mdx Rewrite frontmatter description.
calico-enterprise/networking/training/index.mdx Rewrite frontmatter description for training index page.
calico-cloud/networking/index.mdx Rewrite frontmatter description for networking index page.
calico-cloud/networking/configuring/add-maglev-load-balancing.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/advertise-service-ips.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/bgp-to-workload.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/bgp.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/custom-bgp-config.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/dual-tor.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/index.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/mark-lb-node-for-maintenance.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/mtu.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/multiple-networks.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/node-local-dns-cache.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/pod-mac-address.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/qos-controls.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/vxlan-ipip.mdx Rewrite frontmatter description.
calico-cloud/networking/configuring/workloads-outside-cluster.mdx Rewrite frontmatter description.
calico-cloud/networking/egress/egress-gateway-aws.mdx Rewrite frontmatter description.
calico-cloud/networking/egress/egress-gateway-azure.mdx Rewrite frontmatter description.
calico-cloud/networking/egress/egress-gateway-maintenance.mdx Rewrite frontmatter description.
calico-cloud/networking/egress/egress-gateway-on-prem.mdx Rewrite frontmatter description.
calico-cloud/networking/egress/external-network.mdx Rewrite frontmatter description.
calico-cloud/networking/egress/index.mdx Rewrite frontmatter description for egress index page.
calico-cloud/networking/egress/troubleshoot.mdx Rewrite frontmatter description.
calico-cloud/networking/ingress-gateway/about-calico-ingress-gateway.mdx Rewrite frontmatter description.
calico-cloud/networking/ingress-gateway/create-ingress-gateway.mdx Rewrite frontmatter description.
calico-cloud/networking/ingress-gateway/customize-ingress-gateway.mdx Rewrite frontmatter description.
calico-cloud/networking/ingress-gateway/tutorial-ingress-gateway-canary.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/assign-ip-addresses-topology.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/change-block-size.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/get-started-ip-addresses.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/index.mdx Rewrite frontmatter description for IPAM index page.
calico-cloud/networking/ipam/initial-ippool.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/ip-autodetection.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/ipv6.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/legacy-firewalls.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/migrate-pools.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/service-loadbalancer.mdx Rewrite frontmatter description.
calico-cloud/networking/ipam/use-specific-ip.mdx Rewrite frontmatter description.
calico-cloud/networking/training/about-kubernetes-networking.mdx Rewrite frontmatter description.
calico-cloud/networking/training/about-networking.mdx Rewrite frontmatter description.
calico-cloud/networking/training/index.mdx Rewrite frontmatter description for training index page.

@ctauchen ctauchen mentioned this pull request May 8, 2026
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ctauchen