Skip to content

Rewrite threat-defense page descriptions (next trees)#2722

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

Rewrite threat-defense page descriptions (next trees)#2722
ctauchen merged 2 commits into
tigera:mainfrom
ctauchen:descriptions-threat

Conversation

@ctauchen
Copy link
Copy Markdown
Collaborator

Summary

Rewrites the description frontmatter on every page in the threat-defense book across the two unversioned (next-release) source trees that have one — 19 files, 1-line replacement each. Same rule set as #2696, #2697, #2708, #2709, #2710, #2711, #2718, #2719, #2720.

Tree Files
calico-enterprise/threat/ 9
calico-cloud/threat/ 10
Total 19

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.

What every new description follows

  1. Names exactly one canonical product (Calico Enterprise or Calico Cloud). Calico Open Source has no threat-defense book.
  2. ≤ 200 characters.
  3. Action-led on procedural pages, tutorial-led on the WAF-with-ingress-gateway guides, noun-led on overview and dashboard 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 19 files:

  • 0 forbidden-word hits in descriptions (enable/disable/teaching).
  • 0 descriptions over 200 chars.
  • 0 colons in description values.
  • 7 cross-product literal duplicates — feeds, DPI, security-event management, webhooks, WAF, ingress-gateway WAF, and Tor-VPN pages all shared identical descriptions across the two product trees. Now disambiguated by deployment context — Calico Enterprise's self-hosted cluster framing vs. Calico Cloud's connected-cluster and managed-feed framing.
  • Several fragmentsDeploy WAF with ingress gateways, Threat detection for containerized workloads, Configure Calico to use with Layer 7 Web Application Firewall, Monitor live traffic for malicious activities are short, non-canonical, or omit the product name entirely. Rewrites use complete sentences with the canonical product name and Threat covers anomaly detection, container threat detection, IDS, threat-intel feeds, alerts, and malware detection.

Verification

Run from repo root on this branch:

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

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

Test plan

  • Run the forbidden-word grep above and confirm empty.
  • Spot-check cross-product pairs (*/threat/suspicious-ips.mdx, */threat/web-application-firewall.mdx, */threat/tor-vpn-feed-and-dashboard.mdx, */threat/deeppacketinspection.mdx) for distinguishability.
  • Spot-check 5 random rewrites against page bodies for accuracy.
  • After review, mirror to latest-version snapshots in a follow-up PR.

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

netlify Bot commented May 12, 2026

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

Name Link
🔨 Latest commit db07a93
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6a04a5e59eb54a00084a8703
😎 Deploy Preview https://deploy-preview-2722--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!

Name Link
🔨 Latest commit db07a93
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6a04d87d021be08bd15a5234
😎 Deploy Preview https://deploy-preview-2722--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: 66 (🔴 down 19 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

Updates the description frontmatter (meta descriptions) for the Threat defense documentation in the unversioned (“next”) Calico Enterprise and Calico Cloud trees to improve clarity, include canonical product naming, and reduce cross-product duplication.

Changes:

  • Rewrites description: frontmatter across 19 Threat defense pages in calico-enterprise/threat/ and calico-cloud/threat/.
  • Adjusts descriptions to be more specific to each product’s deployment context (self-hosted Enterprise vs connected clusters/Cloud).

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
calico-enterprise/threat/index.mdx Updated Threat defense landing-page meta description.
calico-enterprise/threat/security-event-management.mdx Updated meta description for security event management page.
calico-enterprise/threat/suspicious-domains.mdx Updated meta description for suspicious domains page.
calico-enterprise/threat/suspicious-ips.mdx Updated meta description for suspicious IPs page.
calico-enterprise/threat/web-application-firewall.mdx Updated meta description for workload-based WAF page.
calico-enterprise/threat/deploying-waf-ingress-gateway.mdx Updated meta description for ingress-gateway WAF tutorial.
calico-enterprise/threat/deeppacketinspection.mdx Updated meta description for deep packet inspection page.
calico-enterprise/threat/configuring-webhooks.mdx Updated meta description for security-event webhooks page.
calico-enterprise/threat/tor-vpn-feed-and-dashboard.mdx Updated meta description for Tor/VPN feed + dashboard page.
calico-cloud/threat/index.mdx Updated Threat defense landing-page meta description.
calico-cloud/threat/security-event-management.mdx Updated meta description for security event management page.
calico-cloud/threat/container-threat-detection.mdx Updated meta description for container threat detection page.
calico-cloud/threat/suspicious-domains.mdx Updated meta description for suspicious domains page.
calico-cloud/threat/suspicious-ips.mdx Updated meta description for suspicious IPs page.
calico-cloud/threat/web-application-firewall.mdx Updated meta description for workload-based WAF page.
calico-cloud/threat/deploying-waf-ingress-gateway.mdx Updated meta description for ingress-gateway WAF tutorial.
calico-cloud/threat/deeppacketinspection.mdx Updated meta description for deep packet inspection page.
calico-cloud/threat/configuring-webhooks.mdx Updated meta description for security-event webhooks page.
calico-cloud/threat/tor-vpn-feed-and-dashboard.mdx Updated meta description for Tor/VPN feed + dashboard page.

@@ -1,5 +1,5 @@
---
description: Detect and analyze malicious anonymization activity using Tor-VPN feeds.
description: Detect anonymization activity in Calico Cloud connected clusters with managed Tor bulk exit and X4B VPN feeds, and investigate findings in the Tor-VPN dashboard.
Comment thread calico-cloud/threat/suspicious-ips.mdx Outdated
@@ -1,5 +1,5 @@
---
description: Add threat intelligence feeds to trace network flows of suspicious IP addresses, and optionally block traffic to them.
description: Use managed threat-intelligence feeds in Calico Cloud to alert on flows to suspicious IP addresses and optionally block them with a dynamic deny-list policy.
@@ -1,5 +1,5 @@
---
description: Add threat intelligence feeds to trace DNS queries that involve suspicious domains.
description: Use managed threat-intelligence feeds in Calico Cloud to detect DNS queries to suspicious domains and surface impacted pods in the anomaly dashboard.
Comment thread calico-enterprise/threat/index.mdx Outdated
@@ -1,5 +1,5 @@
---
description: Trace, analyze, and block malicious threats using intelligent feeds and alerts.
description: Detect, analyze, and block threats in your Calico Enterprise cluster with intrusion detection, threat-intel feeds, deep packet inspection, and a workload-based WAF.
Comment thread calico-cloud/threat/index.mdx Outdated
@@ -1,5 +1,5 @@
---
description: Trace, analyze, and block malicious threats using intelligent feeds and alerts.
description: Detect and respond to threats in Calico Cloud connected clusters with container threat detection, managed threat-intel feed updates, deep packet inspection, and WAF.
ctauchen and others added 2 commits May 13, 2026 17:22
5 review comments addressed:
- tor-vpn-feed-and-dashboard.mdx (CC): replaced "managed Tor bulk
  exit and X4B VPN feeds" with the actual install path the page
  documents ("Tor bulk exit and X4B VPN feeds, ... in the Tor-VPN
  dashboard in the web console").
- suspicious-ips.mdx and suspicious-domains.mdx (CC): removed the
  "managed threat-intelligence feeds" framing since the pages
  describe adding feeds via kubectl apply, not managed feeds.
- threat/index.mdx (CE and CC): spelled out "threat-intel" as
  "threat intelligence" for consistency with sibling pages.

Then mirrored the full next-tree threat descriptions to the four
versioned snapshots:
- calico-enterprise_versioned_docs/version-3.23-1/threat/ (9)
- calico-enterprise_versioned_docs/version-3.22-2/threat/ (9)
- calico-cloud_versioned_docs/version-22-2/threat/ (10)

28 mirror writes plus 5 next-tree fixes = 33 file changes. No drift.

Vale clean on description lines across all 5 dirs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ctauchen ctauchen force-pushed the descriptions-threat branch from 80139c3 to db07a93 Compare May 13, 2026 16:25
@ctauchen ctauchen merged commit 5f614cd 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