Skip to content

Rewrite compliance page descriptions (next trees)#2723

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

Rewrite compliance page descriptions (next trees)#2723
ctauchen merged 2 commits into
tigera:mainfrom
ctauchen:descriptions-compliance

Conversation

@ctauchen
Copy link
Copy Markdown
Collaborator

Summary

Audit and rewrite frontmatter descriptions for the compliance bucket across the unversioned (next) trees of Calico Enterprise and Calico Cloud.

Scope:

  • calico-enterprise/compliance/ — 8 files
  • calico-cloud/compliance/ — 8 files

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

Each new description names its canonical product (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, #2718, #2719, #2720 — self-hosted/in-cluster framing for Calico Enterprise, SaaS / Calico-Cloud-connected-cluster framing for Calico Cloud.

Pre-fix violations (same 16 files)

  • 0 descriptions over 200 chars
  • 4 descriptions started with the forbidden word Enable (the two enable-compliance.mdx pages and the two encrypt-cluster-pod-traffic.mdx pages)
  • 2 cross-product duplicate descriptions on encrypt-cluster-pod-traffic.mdx that also incorrectly read "Calico Enterprise clusters" in the Calico Cloud tree
  • 14 of 16 missing a canonical product name (all but the two encrypt-cluster-pod-traffic.mdx pages, which named the wrong product on the CC side)
  • 6 cross-product duplicates (every CE/CC pair under compliance/ other than enable-compliance.mdx and encrypt-cluster-pod-traffic.mdx shared identical strings)

Verification

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

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

Vale --output=line line-2 issues on changed files: none.

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

Misfiled pages (flagged, not moved)

The compliance/ directory contains several pages that are not actually compliance content. Descriptions still accurately describe each page's real topic, but a future restructure should likely relocate them:

  • configure-http-proxy.mdx — outbound HTTP proxy configuration for the Tigera Operator
  • encrypt-cluster-pod-traffic.mdx — WireGuard transport encryption (data in transit, not regulatory compliance)
  • istio/about-istio-ambient.mdx and istio/deploy-istio-ambient.mdx — Istio Ambient Mode service mesh (tech preview)

These exist in both calico-enterprise/compliance/ and calico-cloud/compliance/.

Test plan

  • Confirm exactly 16 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)

Copilot AI review requested due to automatic review settings May 12, 2026 18:40
@ctauchen ctauchen requested a review from a team as a code owner May 12, 2026 18:40
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

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

Name Link
🔨 Latest commit 3f51969
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6a04a6fee7634b00082923a2
😎 Deploy Preview https://deploy-preview-2723--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 3f51969
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6a04a6fe2d6ba40008495e45
😎 Deploy Preview https://deploy-preview-2723--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: 94 (🟢 up 26 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (🟢 up 9 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 audits and rewrites the description frontmatter for the compliance sections in the unversioned (next) documentation trees for Calico Enterprise and Calico Cloud, aligning the meta descriptions with the established cross-product disambiguation approach used in prior description-rewrite PRs.

Changes:

  • Replaced the description: line in 8 compliance pages under calico-enterprise/compliance/.
  • Replaced the description: line in 8 compliance pages under calico-cloud/compliance/.
  • Updated descriptions to be product-specific (CE vs CC framing) and consistent with the content on each page (spot-checked key technical references like Elasticsearch, FelixConfiguration, web console, and Istio Ambient terminology).

Reviewed changes

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

Show a summary per file
File Description
calico-enterprise/compliance/index.mdx Updates CE compliance landing-page meta description to CE-specific framing and feature summary.
calico-enterprise/compliance/overview.mdx Updates CE compliance report overview meta description (includes Elasticsearch context).
calico-enterprise/compliance/enable-compliance.mdx Updates CE “enable compliance” meta description to avoid forbidden wording and name CE components.
calico-enterprise/compliance/compliance-reports-cis.mdx Updates CE CIS reports meta description with CE-specific phrasing.
calico-enterprise/compliance/encrypt-cluster-pod-traffic.mdx Updates CE WireGuard meta description; references FelixConfiguration consistently with page content.
calico-enterprise/compliance/configure-http-proxy.mdx Updates CE outbound proxy meta description; matches Installation CR / Tigera Operator content.
calico-enterprise/compliance/istio/about-istio-ambient.mdx Updates CE Istio Ambient overview meta description with CE cluster framing.
calico-enterprise/compliance/istio/deploy-istio-ambient.mdx Updates CE Istio Ambient deployment meta description with CE cluster framing.
calico-cloud/compliance/index.mdx Updates CC compliance landing-page meta description to connected-cluster / SaaS framing.
calico-cloud/compliance/overview.mdx Updates CC compliance report overview meta description referencing the CC web console.
calico-cloud/compliance/enable-compliance.mdx Updates CC “enable compliance” meta description with connected-cluster framing.
calico-cloud/compliance/compliance-reports-cis.mdx Updates CC CIS reports meta description with CC web-console framing.
calico-cloud/compliance/encrypt-cluster-pod-traffic.mdx Updates CC WireGuard meta description; references FelixConfiguration consistently with page content.
calico-cloud/compliance/configure-http-proxy.mdx Updates CC outbound proxy meta description; matches Installation CR / Tigera Operator content.
calico-cloud/compliance/istio/about-istio-ambient.mdx Updates CC Istio Ambient overview meta description with connected-cluster framing.
calico-cloud/compliance/istio/deploy-istio-ambient.mdx Updates CC Istio Ambient deployment meta description with connected-cluster framing.

ctauchen and others added 2 commits May 13, 2026 17:28
Audit and rewrite frontmatter descriptions for the compliance bucket
across the unversioned (next) trees of Calico Enterprise and Calico
Cloud. Each new description names its canonical product, stays under
200 characters, avoids the forbidden words enable/disable/teaching,
contains no colons, and is unique across products.

Next-only on purpose. Versioned mirrors will be applied separately.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
24 mirror writes:
- calico-enterprise_versioned_docs/version-3.23-1/compliance/ (8)
- calico-enterprise_versioned_docs/version-3.22-2/compliance/ (8)
- calico-cloud_versioned_docs/version-22-2/compliance/ (8)

No drift either way. Vale clean on description lines.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ctauchen ctauchen force-pushed the descriptions-compliance branch from 8faa7bf to 3f51969 Compare May 13, 2026 16:29
@ctauchen ctauchen merged commit e0c6e05 into tigera:main May 13, 2026
10 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