Skip to content

Rewrite about/landing-page descriptions (next trees)#2718

Merged
ctauchen merged 2 commits into
tigera:mainfrom
ctauchen:descriptions-about
May 13, 2026
Merged

Rewrite about/landing-page descriptions (next trees)#2718
ctauchen merged 2 commits into
tigera:mainfrom
ctauchen:descriptions-about

Conversation

@ctauchen
Copy link
Copy Markdown
Collaborator

Summary

Audit and rewrite frontmatter descriptions for the about bucket plus small orphan landing pages that did not fit into the prior buckets, across the unversioned (next) trees of all three products.

Scope spans about + get-help + the CE installation index landing page:

  • calico/about/ — 11 files
  • calico/get-help/ — 1 file
  • calico-enterprise/about/ — 2 files
  • calico-enterprise/installation/install-calico-enterprise-mke-4k.mdx — 1 file
  • calico-cloud/about/ — 2 files
  • calico-cloud/get-help/ — 1 file

Total: 18 files, 1 line each (description frontmatter only).

Each new description names its canonical product exactly (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 follows the pattern from #2696, #2697, #2708, #2709, #2710, #2711 — open-source framing for Calico Open Source, self-managed/Tigera-supported framing for Calico Enterprise, Tigera-hosted/managed-SaaS framing for Calico Cloud.

Pre-fix violations (same 18 files)

  • 0 descriptions over 200 chars
  • 0 forbidden words
  • 18 of 18 missing a canonical product name
  • 4 cross-product duplicates from the boilerplate A brief description of Calico, deployment options, and features. and Compare Calico product editions to find the right one for your needs. strings appearing in all three products

Verification

Diff is exactly 18 files changed, 18 insertions, 18 deletions — only the description line per file:

git diff upstream/main | grep -E '^[+-]' | grep -v -E '^(\+\+\+|---)' | grep -v '^[+-]description:'
# (no output)

Next-only on purpose — versioned mirrors will be applied in a follow-up after review.

Test plan

  • Confirm exactly 18 files changed, 1 line per file (description frontmatter only)
  • Each description names the right canonical product for its tree
  • No descriptions over 200 characters
  • No forbidden words (enable, disable, teaching) and no colons
  • No cross-product duplicate descriptions
  • Vale lint clean on changed-file description lines (line 2)

Audit and rewrite frontmatter descriptions for the about bucket and
small orphan landing pages in the unversioned (next) trees: calico/about
(11 files), calico/get-help (1 file), calico-enterprise/about (2 files),
calico-enterprise/installation (1 CE installation index landing page),
calico-cloud/about (2 files), and calico-cloud/get-help (1 file).

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 earlier sibling PRs: Calico Open Source descriptions use
upstream/open-source framing, Calico Enterprise descriptions use
self-managed/Tigera-supported framing, and Calico Cloud descriptions use
Tigera-hosted/managed-SaaS framing.

Pre-fix snapshot of the same 18 files: 0 descriptions over 200 chars,
0 forbidden words, all 18 missing a canonical product name, and 4
cross-product duplicates from the boilerplate "A brief description of
Calico..." and "Compare Calico product editions..." strings.

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 12, 2026 16:25
@ctauchen ctauchen requested a review from a team as a code owner May 12, 2026 16:25
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

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

Name Link
🔨 Latest commit 4af9a2b
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6a04975478610100087fb224
😎 Deploy Preview https://deploy-preview-2718--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 12, 2026

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 4af9a2b
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6a049754bd274b0008649618
😎 Deploy Preview https://deploy-preview-2718--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: 72 (🟢 up 5 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.

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 updates the frontmatter description metadata across the unversioned (“next”) documentation trees for Calico Open Source, Calico Enterprise, and Calico Cloud, focused on the about/ and get-help/ areas plus one CE installation landing page. The goal is to make descriptions product-specific, unique across products, and more descriptive for SEO/snippets while keeping the change scope to a single line per file.

Changes:

  • Rewrites description: frontmatter on 18 pages to include the canonical product name and more specific page intent.
  • Removes cross-product boilerplate duplication on “about” and “product editions” landing pages by differentiating wording per product.
  • Updates support/help page descriptions to reflect the correct support channels per product (community vs Tigera support portal/in-console).

Reviewed changes

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

Show a summary per file
File Description
calico/get-help/support.mdx Updates OSS support-page meta description to reflect community channels and repos.
calico/about/training-resources.mdx Refines OSS training/resources meta description to match the curated links on the page.
calico/about/kubernetes-training/index.mdx Updates OSS Kubernetes-training index description to be product-specific and topic-scoped.
calico/about/kubernetes-training/about-networking.mdx Replaces generic description with a networking-fundamentals summary for OSS learners.
calico/about/kubernetes-training/about-network-policy.mdx Updates OSS network-policy training description to reflect Kubernetes vs Calico API comparison.
calico/about/kubernetes-training/about-kubernetes-services.mdx Updates OSS services training description with service types + policy interaction framing.
calico/about/kubernetes-training/about-kubernetes-ingress.mdx Updates OSS ingress training description with ingress/controller + policy interaction framing.
calico/about/kubernetes-training/about-kubernetes-egress.mdx Updates OSS egress training description with NAT/restriction/egress gateway framing.
calico/about/kubernetes-training/about-k8s-networking.mdx Updates OSS Kubernetes-network-model training description (services/DNS/NAT/dual-stack).
calico/about/kubernetes-training/about-ebpf.mdx Updates OSS eBPF training description to describe the eBPF data plane benefits.
calico/about/index.mdx Rewrites OSS about-landing description to be explicitly “Calico Open Source” and upstream-focused.
calico/about/calico-product-editions.mdx Updates OSS editions-comparison description to name all products and clarify comparison scope.
calico-enterprise/installation/install-calico-enterprise-mke-4k.mdx Rewrites CE MKE 4k install landing description to be action-led and operator/provisioning specific.
calico-enterprise/about/index.mdx Rewrites CE about-landing description with self-managed / Tigera-supported positioning.
calico-enterprise/about/calico-product-editions.mdx Updates CE editions-comparison description to be CE-centered and feature-category scoped.
calico-cloud/get-help/support.mdx Updates Cloud support-page description to reference Tigera support portal, console help, status, policy.
calico-cloud/about/index.mdx Rewrites Cloud about-landing description with Tigera-hosted managed SaaS / connected-clusters framing.
calico-cloud/about/calico-product-editions.mdx Updates Cloud editions-comparison description to be Cloud-centered and SaaS-management scoped.

Applies the next-tree descriptions to all four versioned snapshots:
- calico_versioned_docs/version-3.32/about/ (11) + get-help/ (1)
- calico-enterprise_versioned_docs/version-3.23-1/about/ (2) + installation/ (1)
- calico-enterprise_versioned_docs/version-3.22-2/about/ (2) + installation/ (1)
- calico-cloud_versioned_docs/version-22-2/about/ (2) + get-help/ (1)

21 mirror writes total. No drift in either direction.

Vale clean on description lines.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ctauchen ctauchen merged commit 57e7a8c into tigera:main May 13, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants