Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add admin docs for the windmill integration #12153

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from
Draft

Add admin docs for the windmill integration #12153

wants to merge 11 commits into from
+427 −0

Conversation

marcelklehr
Copy link
Member

@marcelklehr marcelklehr commented Sep 2, 2024 •
edited
Loading

🖼️ Screenshots

Screenshots

image
image

julien-nc
julien-nc requested changes Sep 6, 2024
View reviewed changes
Copy link
Member

@julien-nc julien-nc left a comment

Choose a reason for hiding this comment

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

Noice!

It would be nice to have a small additional paragraph about the "runs" page in Windmill with a screenshot.

admin_manual/windmill_workflows/index.rst Outdated Show resolved Hide resolved
admin_manual/webhook_listeners/index.rst Outdated Show resolved Hide resolved
admin_manual/windmill_workflows/index.rst Outdated Show resolved Hide resolved
admin_manual/windmill_workflows/index.rst Outdated Show resolved Hide resolved
admin_manual/windmill_workflows/index.rst Outdated Show resolved Hide resolved
admin_manual/windmill_workflows/index.rst Outdated Show resolved Hide resolved
admin_manual/windmill_workflows/index.rst Outdated
Comment on lines 58 to 60
Windmill allows using so-called approval steps, which are essentially asynchronous scripts that wait for the call to an additional webhook URL. The most prominent use case for this are approval workflows where you get automated input from somewhere which needs to be approved by a human. Once the human approves or disapproves by triggering the webhook URL the workflow will resume.

Using the scripts provided for Nextcloud, you can send approval links to the humans in charge of approving via Nextcloud Talk or a simple notification in Nextcloud. Of course, you may also use any of the other scripts for sending messages available in the Windmill hub.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe this needs more details like mentioning the approve_links app, talk about the branching if the approval is rejected (once we have tested it properly).

marcelklehr and others added 6 commits September 6, 2024 13:26
julien-nc
julien-nc requested changes Sep 11, 2024
View reviewed changes
Copy link
Member

@julien-nc julien-nc left a comment

Choose a reason for hiding this comment

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

Thanks for the changes!
A few more:

  • mention that the worker is needed for instant webhooks. occ background-job:worker "OCA\\WebhookListeners\\BackgroundJobs\\WebhookCall"
  • inline comment about approval

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bigcat88 bigcat88 Awaiting requested review from bigcat88

@come-nc come-nc Awaiting requested review from come-nc

@julien-nc julien-nc Awaiting requested review from julien-nc

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@marcelklehr @julien-nc