-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[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
Conversation
633ed95
to
9db16c5
Compare
9db16c5
to
9aa985e
Compare
Thank you @MrYamous! |
There was a problem hiding this 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.
9aa985e
to
f5cc1ce
Compare
f5cc1ce
to
51a318f
Compare
5a40fbc
to
d8b2348
Compare
Applied your suggestions @94noni, thanks! |
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 |
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 I was talking about integrated ones like |
|
||
.. include:: /components/require_autoload.rst.inc | ||
|
||
Basic Usage |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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? 🤔
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added 👍
d8b2348
to
f9763e7
Compare
f9763e7
to
d90312a
Compare
Friendly ping @OskarStark @javiereguiluz, I did some updates to the page! Do you see anything to add/remove/update? 🙂 |
Friendly ping @fabpot |
d90312a
to
738ca20
Compare
Anything planned yet? Since the component released, but there is no documentation yet, |
It is on hold, see #18290 (comment) for the explanation 🙂 |
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? |
7.0 also released and the only "documentation" currently still available is this 6.3 blog post.
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 |
Closing in favor of #19249 |
…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
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!