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

docs: update appinfo for webhook_listeners app #51214

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

pReya
Copy link

@pReya pReya commented Mar 3, 2025

Summary

I found this app in my Nextcloud and it was very annoying that the App description was so short/non existent. The language around "webhooks" can be very ambiguous (e.g. there are incoming and outgoing webhooks, and the term "listener" can also be misjudged as "listening for incoming webhook").

So I was very confused by the short description of this App. Therefore I looked at the code and created a more detailed App description that might help some people understand easier what this app can be used for.

Checklist

@pReya pReya requested review from come-nc and julien-nc as code owners March 3, 2025 20:57
pReya added 2 commits March 3, 2025 21:58
Signed-off-by: Moritz Stückler <[email protected]>
Signed-off-by: Moritz Stückler <[email protected]>
@AndyScherzinger AndyScherzinger added the 3. to review Waiting for reviews label Mar 4, 2025
Copy link
Contributor

@come-nc come-nc left a comment

Choose a reason for hiding this comment

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

Hey.

I get that you were annoyed but the name&shame on Mastodon is really not cool.

For context, this application was developped mainly as a dependency for https://github.com/nextcloud/flow

<summary>Nextcloud webhook support</summary>
<description>Nextcloud webhook support</description>
<name>Nextcloud Webhook Support</name>
<summary>Listen for internal Nextcloud events and call external webhooks</summary>
Copy link
Contributor

Choose a reason for hiding this comment

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

This is weirdly technical. But this app kind of is, so I’m unsure.

<description>Nextcloud webhook support</description>
<name>Nextcloud Webhook Support</name>
<summary>Listen for internal Nextcloud events and call external webhooks</summary>
<description># Description\nThis is an official Nextcloud app, which enables your Nextcloud to call webhooks, when certain Nextcloud events happen. This app does not have any (visible) user interface or settings. To configure your webhooks, you must use the [Rest API](https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/webhook_listeners-webhooks-create).</description>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<description># Description\nThis is an official Nextcloud app, which enables your Nextcloud to call webhooks, when certain Nextcloud events happen. This app does not have any (visible) user interface or settings. To configure your webhooks, you must use the [Rest API](https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/webhook_listeners-webhooks-create).</description>
<description>This app enables your Nextcloud to call webhooks, when certain events happen. This app does not have any (visible) user interface or settings. To configure your webhooks, you must use the [Rest API](https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html#/operations/webhook_listeners-webhooks-create).</description>

No need for a "description" header in the description.
Regarding "This is an official Nextcloud app", if I remember correctly we do not have such a notion. Some apps are maitaineds by us, some are not, but I do not think we want to put such a strong statement in a description. @jancborchardt might now?

@pReya
Copy link
Author

pReya commented Mar 4, 2025

Sorry @come-nc if my comment offended you. I've edited the toot and dialed it down. I did not want to name/shame individual developers or you. My criticism was supposed to go against Nextcloud in general and the priorities and processes within the project.

Thanks for giving the additional information about the reason why this app exists. I think this should also be part of the app description to explain, why a user might find this app in their Nextcloud (maybe because they're also using the Flow app).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3. to review Waiting for reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants