Skip to content

Rewrite image-assurance, tutorials, users descriptions (CC next)#2719

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

Rewrite image-assurance, tutorials, users descriptions (CC next)#2719
ctauchen merged 2 commits into
tigera:mainfrom
ctauchen:descriptions-cloud-assorted

Conversation

@ctauchen
Copy link
Copy Markdown
Collaborator

Summary

Rewrites the description frontmatter field on every page in three Calico Cloud-only trees, all under calico-cloud/. 42 files, 1 line changed per file (frontmatter only).

Tree Files
calico-cloud/image-assurance/ 11
calico-cloud/tutorials/ 27
calico-cloud/users/ 4
Total 42

Next-only on purpose, Calico Cloud only — no versioned-mirror plans for OSS/CE. (calico-cloud_versioned_docs/version-22-2/ mirrors will follow in a separate, mechanical PR once all the next-tree descriptions are merged.)

What every new description follows

  1. Names Calico Cloud (canonical product name) in every description.
  2. Maximum 200 characters (max in this diff: 171; min: 132).
  3. Lead-in matches content type per the docs-frontmatter-description skill — Step-by-step tutorial for ... for tutorials, Reference ... for primers and indexes that act like reference, action-led for how-to pages.
  4. No enable, disable, or teaching.
  5. No colons in the value (YAML-safe).
  6. Unique within these 42 files. Cross-product collision is not possible — Image Assurance, the tutorial set, and the user/role pages are Calico Cloud-only features.

Within-bucket disambiguation (tutorials)

The 27 tutorials cluster into five sub-themes — Kubernetes-tutorials, training primers, enterprise-security, applications, and Calico Cloud features. Each page within a sub-theme is varied along one or more of:

  • Specific feature being demonstrated (Service Graph vs. network sets vs. Mylo vs. projects vs. console tour).
  • Scope (cluster-wide global default deny vs. namespace isolation vs. platform-tier vs. global egress).
  • Audience (Reference primer for ... for the training/ pages that explicitly say they are not product-specific, vs. Step-by-step tutorial for ... for product-flow pages).
  • Outcome (block ingress vs. restrict egress vs. visualize traffic).

Pre-fix violations found

  • 2 pages with empty description fields (tutorials/index.mdx, users/index.mdx).
  • 2 pages with sentence-fragment descriptions (kubernetes-tutorials/index.mdx = "Kubernetes tutorials and demos", calico-cloud-features/projects.mdx = "About projects").
  • 1 page with a typo (creating-jira-issues-for-scan-results.mdx had "Creating Jira Issues for you scan results").
  • 1 page with an HTML entity in the description (create-custom-role-for-entra-id-group.mdx had Entra ID, which renders correctly in body content but is awkward in a meta description).
  • ~38 of 42 pages did not name Calico Cloud in the description.
  • 0 pages had the forbidden words enable / disable / teaching.

Verification

Run from repo root on this branch:

# Forbidden words (expect empty)
grep -nEri "^description:.*\b(enable|disable|teaching)\b" \
  calico-cloud/image-assurance calico-cloud/tutorials calico-cloud/users

# Canonical product-name presence (expect empty)
grep -L "^description:.*Calico Cloud" \
  calico-cloud/image-assurance/**/*.mdx \
  calico-cloud/tutorials/**/*.mdx \
  calico-cloud/users/**/*.mdx

Vale was run against the changed files; no new line-2 (frontmatter description) issues were introduced.

Test plan

  • Run the forbidden-word grep above and confirm empty.
  • Spot-check 5 random rewrites in the diff against page bodies for accuracy.
  • Confirm the 27 tutorial descriptions read as distinguishable when listed side-by-side.
  • Schedule the versioned-mirror PR and llms.txt regeneration as follow-ups.

🤖 Generated with Claude Code

@ctauchen ctauchen requested a review from a team as a code owner May 12, 2026 16:25
Copilot AI review requested due to automatic review settings 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 a0ecc8a
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6a04a74580db8d000827a093
😎 Deploy Preview https://deploy-preview-2719--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 a0ecc8a
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6a04a7459929fd00080a71c4
😎 Deploy Preview https://deploy-preview-2719--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: 63 (🔴 down 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 description frontmatter across Calico Cloud “next” docs pages in three Cloud-only sections (image-assurance/, tutorials/, and users/) to provide consistent, product-specific meta descriptions.

Changes:

  • Rewrote/added description frontmatter in 11 Image Assurance pages.
  • Rewrote/added description frontmatter in 27 Tutorials pages (including indexes and training primers).
  • Rewrote/added description frontmatter in 4 Users & permissions pages (including the section index).

Reviewed changes

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

Show a summary per file
File Description
calico-cloud/image-assurance/index.mdx Updated section index meta description for Image Assurance.
calico-cloud/image-assurance/creating-jira-issues-for-scan-results.mdx Updated meta description for Jira issue creation workflow.
calico-cloud/image-assurance/exclude-vulnerabilities-from-scan-results.mdx Updated meta description for excluding vulnerabilities.
calico-cloud/image-assurance/install-the-admission-controller.mdx Updated meta description for admission controller install/config.
calico-cloud/image-assurance/set-up-alerts.mdx Updated meta description for Image Assurance alerting.
calico-cloud/image-assurance/understanding-scan-results.mdx Updated meta description for interpreting scan results.
calico-cloud/image-assurance/scanners/index.mdx Updated scanners index meta description.
calico-cloud/image-assurance/scanners/overview.mdx Updated meta description for scanner option comparison.
calico-cloud/image-assurance/scanners/cluster-scanner.mdx Updated meta description for cluster scanner page.
calico-cloud/image-assurance/scanners/registry-scanner.mdx Updated meta description for registry scanner page.
calico-cloud/image-assurance/scanners/pipeline-scanner.mdx Updated meta description for pipeline/CLI scanner page.
calico-cloud/tutorials/index.mdx Added/updated tutorials landing page meta description.
calico-cloud/tutorials/applications/index.mdx Updated applications tutorials index meta description.
calico-cloud/tutorials/applications/egress-controls.mdx Updated meta description for egress controls tutorial.
calico-cloud/tutorials/applications/ingress-microservices.mdx Updated meta description for ingress microservices tutorial.
calico-cloud/tutorials/calico-cloud-features/index.mdx Updated Calico Cloud features tutorials index meta description.
calico-cloud/tutorials/calico-cloud-features/tour.mdx Updated meta description for web console tour tutorial.
calico-cloud/tutorials/calico-cloud-features/service-graph.mdx Updated meta description for Service Graph tutorial.
calico-cloud/tutorials/calico-cloud-features/networksets.mdx Updated meta description for network sets tutorial.
calico-cloud/tutorials/calico-cloud-features/projects.mdx Updated meta description for projects tutorial.
calico-cloud/tutorials/calico-cloud-features/mylo-ai.mdx Updated meta description for Mylo AI tutorial.
calico-cloud/tutorials/enterprise-security/index.mdx Updated enterprise security tutorials index meta description.
calico-cloud/tutorials/enterprise-security/namespace-isolation.mdx Updated meta description for namespace isolation tutorial.
calico-cloud/tutorials/enterprise-security/global-egress.mdx Updated meta description for global egress tutorial.
calico-cloud/tutorials/enterprise-security/default-deny.mdx Updated meta description for global default-deny tutorial.
calico-cloud/tutorials/enterprise-security/platform.mdx Updated meta description for platform-tier controls tutorial.
calico-cloud/tutorials/kubernetes-tutorials/index.mdx Updated Kubernetes tutorials index meta description.
calico-cloud/tutorials/kubernetes-tutorials/kubernetes-demo.mdx Updated meta description for stars demo tutorial.
calico-cloud/tutorials/kubernetes-tutorials/kubernetes-network-policy.mdx Updated meta description for Kubernetes network policy concepts tutorial.
calico-cloud/tutorials/kubernetes-tutorials/kubernetes-policy-basic.mdx Updated meta description for basic policy tutorial.
calico-cloud/tutorials/kubernetes-tutorials/kubernetes-policy-advanced.mdx Updated meta description for advanced policy tutorial.
calico-cloud/tutorials/training/index.mdx Updated training primers index meta description.
calico-cloud/tutorials/training/about-networking.mdx Updated meta description for networking primer.
calico-cloud/tutorials/training/about-network-policy.mdx Updated meta description for network policy primer.
calico-cloud/tutorials/training/about-kubernetes-services.mdx Updated meta description for services primer.
calico-cloud/tutorials/training/about-kubernetes-networking.mdx Updated meta description for Kubernetes networking model primer.
calico-cloud/tutorials/training/about-kubernetes-ingress.mdx Updated meta description for ingress primer.
calico-cloud/tutorials/training/about-kubernetes-egress.mdx Updated meta description for egress primer.
calico-cloud/users/index.mdx Added/updated users section index meta description.
calico-cloud/users/user-management.mdx Updated meta description for roles/auth options reference.
calico-cloud/users/create-and-assign-custom-roles.mdx Updated meta description for custom roles creation/assignment.
calico-cloud/users/create-custom-role-for-entra-id-group.mdx Updated meta description for Entra ID group role binding.

ctauchen and others added 2 commits May 13, 2026 17:30
Rewrites the `description` frontmatter field on all 42 unversioned
Calico Cloud pages under image-assurance/, tutorials/, and users/.
Each new description names "Calico Cloud", stays under 200 characters,
avoids forbidden words (enable, disable, teaching), and uses the
content-type lead-in from the docs-frontmatter-description skill
(Step-by-step tutorial for ..., Reference ..., or action-led how-to).
Tutorials are disambiguated from each other by feature, scenario,
or outcome.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
42 mirror writes to calico-cloud_versioned_docs/version-22-2/:
- image-assurance/ (11)
- tutorials/ (27)
- users/ (4)

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-cloud-assorted branch from 2e747fa to a0ecc8a Compare May 13, 2026 16:30
@ctauchen ctauchen merged commit a95d622 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