Rewrite compliance page descriptions (next trees)#2723
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
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 undercalico-enterprise/compliance/. - Replaced the
description:line in 8 compliance pages undercalico-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. |
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>
8faa7bf to
3f51969
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
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 filescalico-cloud/compliance/— 8 filesTotal: 16 files, 1 line each (description frontmatter only).
Each new description names its canonical product (
Calico EnterpriseorCalico Cloud), stays under 200 characters, avoids the forbidden wordsenable/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)
Enable(the twoenable-compliance.mdxpages and the twoencrypt-cluster-pod-traffic.mdxpages)encrypt-cluster-pod-traffic.mdxthat also incorrectly read "Calico Enterprise clusters" in the Calico Cloud treeencrypt-cluster-pod-traffic.mdxpages, which named the wrong product on the CC side)compliance/other thanenable-compliance.mdxandencrypt-cluster-pod-traffic.mdxshared identical strings)Verification
Diff is exactly 16 files changed, 16 insertions, 16 deletions — only the description line per file:
Vale
--output=lineline-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 Operatorencrypt-cluster-pod-traffic.mdx— WireGuard transport encryption (data in transit, not regulatory compliance)istio/about-istio-ambient.mdxandistio/deploy-istio-ambient.mdx— Istio Ambient Mode service mesh (tech preview)These exist in both
calico-enterprise/compliance/andcalico-cloud/compliance/.Test plan
enable,disable,teaching) and no colons