Skip to content

Conversation

@Lohith625
Copy link
Contributor


Was generative AI tooling used to co-author this PR?
  • Yes

Generated-by: ChatGPT following the guidelines


Summary

Improve the discoverability of Human-in-the-Loop (HITL) operators in the Standard provider documentation.

What is changed

  • Added a dedicated HITL operators documentation page under the Standard provider operators docs
  • Briefly explains what Human-in-the-Loop (HITL) operators are and their intended use cases
  • Lists the available HITL operators provided by the Standard provider
  • Added links to:
    • The existing Python API reference for detailed operator documentation
    • The HITL tutorial for end-to-end usage examples

Why this is needed

Currently, HITL operators are only visible through the generated Python API documentation, which makes them difficult to discover for users browsing the Standard provider operator docs.

This change aligns HITL operators with how other operators are documented and improves overall documentation clarity and usability.

closes #60614

@Lohith625
Copy link
Contributor Author

Lohith625 commented Jan 17, 2026

Note on spelling wordlist update

During CI, the documentation spellcheck step failed due to the terms HITL / hitl being flagged as unknown words.
To address this, I added these terms to docs/spelling_wordlist.txt so the spellcheck passes cleanly and consistently across builds.

If this addition is unnecessary or if there is a preferred alternative (for example, different casing or quoting), I’m very happy to adjust and learn from the feedback.

@shahar1 shahar1 added the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Jan 17, 2026
@shahar1
Copy link
Contributor

shahar1 commented Jan 17, 2026

Note on spelling wordlist update

During CI, the documentation spellcheck step failed due to the terms HITL / hitl being flagged as unknown words. To address this, I added these terms to docs/spelling_wordlist.txt so the spellcheck passes cleanly and consistently across builds.

If this addition is unnecessary or if there is a preferred alternative (for example, different casing or quoting), I’m very happy to adjust and learn from the feedback.

I see no issue having them there, they are indeed commonly used.

@shahar1 shahar1 merged commit c32b668 into apache:main Jan 17, 2026
70 checks passed
@shahar1 shahar1 changed the title docs:add HITL operators to standard provider index Add HITL operators to standard provider index docs Jan 17, 2026
github-actions bot pushed a commit that referenced this pull request Jan 17, 2026
(cherry picked from commit c32b668)

Co-authored-by: Lohith M <152604836+Lohith625@users.noreply.github.com>
@github-actions
Copy link

Backport successfully created: v3-1-test

Status Branch Result
v3-1-test PR Link

jason810496 pushed a commit to jason810496/airflow that referenced this pull request Jan 22, 2026
ephraimbuddy pushed a commit that referenced this pull request Jan 28, 2026
… (#60702)

(cherry picked from commit c32b668)

Co-authored-by: Lohith M <152604836+Lohith625@users.noreply.github.com>
shreyas-dev pushed a commit to shreyas-dev/airflow that referenced this pull request Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providers backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation provider:standard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HITL Operator Docs

2 participants