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.

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

Add admin docs for the windmill integration #12153

Merged
merged 11 commits into from
Sep 24, 2024
Merged

Conversation

marcelklehr
Copy link
Member

@marcelklehr marcelklehr commented Sep 2, 2024

🖼️ Screenshots

Screenshots

image
image

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
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).

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

@marcelklehr marcelklehr marked this pull request as ready for review September 24, 2024 09:33
@marcelklehr marcelklehr merged commit 877484c into master Sep 24, 2024
13 of 14 checks passed
@marcelklehr marcelklehr deleted the feat/admin/windmill branch September 24, 2024 13:44

If you would like to enforce multiple criteria, you can simply pass multiple properties ``{ "event.tableId": 42, "event.rowId": 3 }``

You can also use additional comparison operators (``$eq, $ne, $gt, $gte, $lt, $lte, $in, $nin``) as well as logical operators (``$and, $or, $not, $nor``). For example use ``{ "time" : { "$lt": 1711971024 } }`` to accept only events prior to April 1st 2024 and ``{ "time" : { "$not": { "$lt": 1711971024 } } }`` to accept events after April 1st 2024.
Copy link
Member

Choose a reason for hiding this comment

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

@marcelklehr could you please try to find a workaround for the failing spell check? This line causes red CI for all new PRs. Thanks

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.

3 participants