Skip to content

DOCS-3082: Fix inaccuracies on the BlockAffinity reference - #3127

Merged
ctauchen merged 4 commits into
tigera:mainfrom
ctauchen:DOCS-3082-fact-check-blockaffinity
Oct 19, 2026
Merged

ctauchen merged 4 commits into
tigera:mainfrom
ctauchen:DOCS-3082-fact-check-blockaffinity

Conversation

@ctauchen

@ctauchen ctauchen commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes inaccuracies on the BlockAffinity reference page, found and verified with the calico-fact-check skill.

  • name: lowercase only, and no underscores.
  • state, node and cidr are marked Required.
  • node can also be load-balancer, for blocks in a LoadBalancer IP pool.
  • state also accepts an empty value (3.33 and next only).

Changes next, 3.33, 3.32 and 3.31. Each fix was reproduced on a kind cluster running that tree's release: v3.33.0 for next and 3.33, v3.32.2 for 3.32, v3.31.7 for 3.31. The 3.33 fixes were reproduced in both API server mode and native v3 CRD mode.

Not changed, for follow-up:

  • The spec type field is not documented. API server mode never returns it, and native v3 CRD mode shows it but does not enforce its values, so it needs a decision on whether to document it.
  • The projectcalico.org/v3 API is read-only for BlockAffinity. The intro could say so.

Previous attempt: #3077.

Preview the changed page:

Copilot AI lite review requested due to automatic review settings October 16, 2026 15:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The only remaining feedback is a minor documentation nit that does not block approval.

0 open findings

What changed in this PR

Updates BlockAffinity reference documentation for current, 3.33, 3.32, and 3.31 Calico releases.

Changes:

  • Corrects name restrictions.
  • Marks required fields.
  • Documents valid node and state values by release.
File Summary
calico/​reference/​resources/​blockaffinity.mdx Updates current BlockAffinity documentation.
calico_versioned_docs/​version-3.33/​reference/​resources/​blockaffinity.mdx Updates 3.33 documentation.
calico_versioned_docs/​version-3.32/​reference/​resources/​blockaffinity.mdx Updates 3.32 documentation.
calico_versioned_docs/​version-3.31/​reference/​resources/​blockaffinity.mdx Updates 3.31 documentation; a minor qualification nit remains.

🧠 Review effort: Lite


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@netlify

netlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2990c1b
🔍 Latest deploy log https://app.netlify.com/projects/tigera/deploys/6ad2494dce3729060a23d210
😎 Deploy Preview https://deploy-preview-3127--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: 84 (🟢 up 11 from production)
Accessibility: 98 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

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

Name Link
🔨 Latest commit 2990c1b
🔍 Latest deploy log https://app.netlify.com/projects/calico-docs-preview-next/deploys/6ad2494df7b4aae95a50ddd1
😎 Deploy Preview https://deploy-preview-3127--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@ctauchen
ctauchen marked this pull request as ready for review October 19, 2026 14:00
@ctauchen
ctauchen requested a review from a team as a code owner October 19, 2026 14:00

@ctauchen ctauchen left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ctauchen
ctauchen merged commit 799cf04 into tigera:main Oct 19, 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