Skip to content

[Webhook] Add new component documentation #17964

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

Closed
wants to merge 1 commit into from

Conversation

alexandre-daubois
Copy link
Member

@alexandre-daubois alexandre-daubois commented Feb 24, 2023

Fixes #18061

ℹ️ This is an early draft for the upcoming Webhook (and RemoteEvent) component to gather early-feedback, likely to be released with 6.3.

Would be great to release the component documentation on day one!

@carsonbot carsonbot added this to the 6.3 milestone Feb 24, 2023
@alexandre-daubois alexandre-daubois marked this pull request as draft February 24, 2023 08:07
@OskarStark OskarStark requested a review from fabpot February 24, 2023 08:51
@OskarStark OskarStark added the Waiting Code Merge Docs for features pending to be merged label Feb 24, 2023
@carsonbot carsonbot modified the milestones: 6.3, next Feb 24, 2023
@alexandre-daubois
Copy link
Member Author

Thank you @MrYamous!

@OskarStark OskarStark removed the Waiting Code Merge Docs for features pending to be merged label Mar 17, 2023
Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

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

Alex, thanks for working on this so early! Thankfully we'll have the docs ready before the 6.3 launch.

@alexandre-daubois alexandre-daubois marked this pull request as ready for review May 23, 2023 14:28
@carsonbot carsonbot modified the milestones: next, 6.3 May 23, 2023
@alexandre-daubois alexandre-daubois force-pushed the webhooks branch 2 times, most recently from f5cc1ce to 51a318f Compare May 23, 2023 14:30
@alexandre-daubois alexandre-daubois force-pushed the webhooks branch 2 times, most recently from 5a40fbc to d8b2348 Compare June 2, 2023 11:25
@alexandre-daubois
Copy link
Member Author

Applied your suggestions @94noni, thanks!

@norkunas
Copy link
Contributor

norkunas commented Jun 8, 2023

Probably would be good to list available request parsers, because wanted to try webhook component and then needed to find out what to configure under framework.webhook.routing.*.service key

@fcvoica
Copy link

fcvoica commented Jun 20, 2023

Hello @alexandre-daubois, I was looking to do something similar and I came across your PR. Is there something I can help you with?

@alexandre-daubois
Copy link
Member Author

@norkunas Well it seems it is developer's responsibility to create a request parser. Maybe you were talking about mentioning \Symfony\Component\Webhook\Client\RequestParser?

@fcvoica A little review is always appreciated to improve this upcoming doc if you want! 🙂

@norkunas
Copy link
Contributor

@alexandre-daubois I was talking about integrated ones like mailer.webhook.request_parser.mailgun


.. include:: /components/require_autoload.rst.inc

Basic Usage
Copy link

Choose a reason for hiding this comment

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

I'd add a small 'Configuration' section after this with a short description, and a small example:
`.. configuration-block::

.. code-block:: yaml

    # config/packages/framework.yaml
    framework:
        webhook:
            routing:
                email:
                    service: App\Webhook\MailerWebhookParser # custom parser id
                    secret: '%env(EXTERNAL_SERVICE_SECRET)%'` # this can be validated in the doPrase method

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know if we should add this in the component documentation or in the framework documentation? 🤔

Copy link

Choose a reason for hiding this comment

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

From what I've seen on other documentation pages, this is included in the component doc, not in the framework doc

Copy link
Member Author

Choose a reason for hiding this comment

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

Added 👍

@alexandre-daubois
Copy link
Member Author

Friendly ping @OskarStark @javiereguiluz, I did some updates to the page! Do you see anything to add/remove/update? 🙂

@OskarStark
Copy link
Contributor

Friendly ping @fabpot

@pboschma
Copy link

pboschma commented Sep 5, 2023

Anything planned yet? Since the component released, but there is no documentation yet,

@alexandre-daubois
Copy link
Member Author

It is on hold, see #18290 (comment) for the explanation 🙂

@welcoMattic
Copy link
Member

6.4 is coming in a few weeks and we still don't have the Webhook component documentation online. Is there any blocker @javiereguiluz @alexandre-daubois?

@ToshY
Copy link
Contributor

ToshY commented Dec 2, 2023

7.0 also released and the only "documentation" currently still available is this 6.3 blog post.

It is on hold, see #18290 (comment) for the explanation 🙂

Stating "discussing internally about a radically different approach" isn't an explanation for why there is still no documentation. We're already at 7.0 and there's still nothing. As a Symfony user I'm now left in the dark on how to use these new components.

If normal PRs adhere to contribution guidelines that state that documentation must be updated accordingly1, surely this must also be true for releasing new components as well...


So when can we expect these documentations to be available?

Footnotes

  1. https://symfony.com/doc/current/contributing/code/pull_requests.html#make-a-pull-request

@OskarStark
Copy link
Contributor

OskarStark commented Dec 9, 2023

Closing in favor of #19249

@OskarStark OskarStark closed this Dec 9, 2023
OskarStark added a commit that referenced this pull request Dec 12, 2023
…bination with Mailer (TimoBakx)

This PR was merged into the 6.3 branch.

Discussion
----------

[Webhook] Added component documentation for use in combination with Mailer

Replaces
* #17964

#SymfonyHackday

Commits
-------

a632c9b [Webhook] Added component documentation for use in combination with Mailer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.