Skip to content

Documentation for Human-in-the-loop operator #52206

Closed

Description

@Lee-W

Body

AIP-90

Add use cases and instruction on how to use this new feature.

Committer

  • I acknowledge that I am a maintainer/committer of the Apache Airflow project.

Activity

  1. added this to the Airflow 3.1.0 milestone on Jun 25, 2025
  2. added theissue type on Jun 25, 2025
  3. added
    kind:metaHigh-level information important to the community
    on Jun 25, 2025
  4. changed the title [-]Documentation for Human-in-the-loope operators[/-] [+]Documentation for Human-in-the-loope operator[/+] on Jun 25, 2025
  5. Jasperora commented on Jun 29, 2025

    @Jasperora
    Contributor

    I am interested in this feature. May I help with it?

  6. Lee-W commented on Jun 29, 2025

    @Lee-W
    MemberAuthor

    Sure thing :)

  7. moved this from Backlog to Ready in AIP-90 - Human in the loopon Jun 29, 2025
  8. changed the title [-]Documentation for Human-in-the-loope operator[/-] [+]Documentation for Human-in-the-loop operator[/+] on Jul 2, 2025
  9. Lee-W commented on Jul 11, 2025

    @Lee-W
    MemberAuthor

    @Jasperora #52868 has now been merged, giving us a clearer understanding of its potential uses. Please take a moment to browse the PR and familiarize yourself with it. The description in the PR will help you comprehend its purpose, along with the example provided in the description #52868 (comment).

    You DO NOT need to understand all the details of it but how to use it.

    I expect I'll do some of the documentation work in #52207.

    However, mine won't address the UI aspect (#52094). It would be great if you could collaborate with @guan404ming to explore ways to help users easily understand what this is, how to use it, and the benefits they can gain from it. I believe the paragraph in https://cwiki.apache.org/confluence/display/AIRFLOW/AIP-90+Human+in+the+loop would also be quite helpful.

    cc @jason810496 since I've shared this in the last airflow meetup, it would be nice if you could kindly take a look and help @guan404ming and @Jasperora . Thanks a lots!

  10. Jasperora commented on Jul 22, 2025

    @Jasperora
    Contributor

    Hi @Lee-W, I'm planning to add the documentation in airflow-core/docs/tutorial folder.
    Besides, I'm considering adding markers such as# [START howto_hitl_branch_operator] in providers/standard/src/airflow/providers/standard/example_dags/example_hitl_operator.py. to help with the documentation.

    Would you recommend doing so?
    I'd appreciate your advice before proceeding. Thanks!

  11. Lee-W commented on Jul 22, 2025

    @Lee-W
    MemberAuthor

    Sounds awesome

  12. Jasperora commented on Jul 24, 2025

    @Jasperora
    Contributor

    Hi @Lee-W, I created a draft PR to introduce HITL through the example. I'll collaborate with @guan404ming to add UI part doc into it.

  13. moved this from Ready to In review in AIP-90 - Human in the loopon Jul 28, 2025
  14. moved this from In review to In progress in AIP-90 - Human in the loopon Jul 28, 2025
  15. Lee-W commented on Jul 29, 2025

    @Lee-W
    MemberAuthor

    The #53694 provides a good illustration on how to use these operators. We can merge this first. After #53035 is also merged, we'll work on the doc for UI part. Then I think we can close this issue. Thanks @Jasperora !

  16. Lee-W commented on Aug 5, 2025

    @Lee-W
    MemberAuthor

    Hey @Jasperora, as #53035 has merged, would you like to create a new PR for more detailed usage? 🙂 In #54128, I also added a few examples. Might be helpful as well

  17. Jasperora commented on Aug 5, 2025

    @Jasperora
    Contributor

    Sure!

  18. phanikumv commented on Aug 18, 2025

    @phanikumv
    Contributor

    Waiting for the shared links functionality to be merged, so that we can start on this ticket.

  19. moved this from In progress to In review in AIP-90 - Human in the loopon Aug 19, 2025
  20. moved this from In review to Done in AIP-90 - Human in the loopon Aug 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions