Skip to content

Improve clarity of cluster-policies documentation#66447

Open
crobertson-astro wants to merge 1 commit intoapache:mainfrom
crobertson-astro:docs/improve-cluster-policies-clarity
Open

Improve clarity of cluster-policies documentation#66447
crobertson-astro wants to merge 1 commit intoapache:mainfrom
crobertson-astro:docs/improve-cluster-policies-clarity

Conversation

@crobertson-astro
Copy link
Copy Markdown

Rewrites airflow-core/docs/administration-and-deployment/cluster-policies.rst for better
readability and precision.

Changes:

  • Fix heading typo: "How do define" → "How to define"
  • Rewrite policy type descriptions to clearly distinguish dag_policy (load-time, all future instances) vs task_policy (load-time, task definition) vs task_instance_mutation_hook (runtime, single DagRun instance)
  • Simplify exception descriptions; remove informal parenthetical around import_error table note
  • Fix broken sentence in task policies section ("You could also implement to protect against" → complete sentence)
  • Improve multi-check guidance: explain the pattern of composing rules rather than "curating" them
  • Improve entrypoint plugin instructions: clearer uniqueness rule, remove informal "Once you have done that" phrasing
  • Move the "See also: local settings" cross-reference under list item 1 where it belongs
  • Tighten the priority_weight mutation-hook note

Was generative AI tooling used to co-author this PR?
  • Yes — Claude Code (Sonnet 4.6)

Generated-by: Claude Code (Sonnet 4.6) following the guidelines

Rewrites the cluster policies docs for better clarity:
- Fix heading typo ("How do define" → "How to define")
- Sharpen policy type descriptions to clarify dag_policy vs
  task_policy vs task_instance_mutation_hook distinctions
- Simplify exception descriptions; remove informal parenthetical
- Fix broken sentence in task policies section ("implement to protect")
- Improve multi-check guidance and entrypoint plugin instructions
@crobertson-astro crobertson-astro marked this pull request as ready for review May 5, 2026 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant