[Notifier] add doc #12846
Closed
[Notifier] add doc #12846
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| The Notifier Component | ||
| ==================== | ||
|
|
||
| The Notifier component helps sending emails. |
There was a problem hiding this comment.
Suggested change
| The Notifier component helps sending emails. | |
| The Notifier component helps sending notifications (emails, Slack, SMS). |
| ----- | ||
|
|
||
| The Notifier component has notify you when something goes wrong:: |
There was a problem hiding this comment.
Suggested change
| The Notifier component has notify you when something goes wrong:: | |
| The Notifier component can notify someone(s) when something occurs:: |
it can be you or someone else, that the devops or whomever
also, not only when goes wrong, it can be something good happening :)
|
|
||
| The Notifier component has notify you when something goes wrong:: | ||
|
|
||
| use Symfony\Bridge\Twig\Mime\NotificationEmail; |
There was a problem hiding this comment.
generaly the doc use to put such code in context, inside a controller or a service for example
can you reproduce the same? i think it will be very usefull :)
| } | ||
| {% endblock %} | ||
| {% block lines %} | ||
| This is an automated email for the MyApp application. |
There was a problem hiding this comment.
Suggested change
| This is an automated email for the MyApp application. | |
| This is a notification email for the MyApp application. |
| * @Route("/checkout/thankyou") | ||
| */ | ||
| public function thankyou(Texter $texter /* ... */) { | ||
| $sms = new SmsMessage('+1415999888', 'Revenue has just increased by 1€ per year!'); |
There was a problem hiding this comment.
need the use refering to this SmsMessage
| SMS | ||
| --------- | ||
|
|
||
| Sending SMS Messages the easy way:: |
There was a problem hiding this comment.
SMS stands for Short Message Service
so Short Message Service Messages seems weird, what about
Suggested change
| Sending SMS Messages the easy way:: | |
| Sending SMS notifications the easy way:: |
?
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 2, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
|
Hi @andreybolonin! Thanks for creating the component docs! We're trying to focus on the Symfony framework users first. So I've taken your commit, merged them with the work of other contributors, and moved all information to a new "Notifier" guide in #13025. As a result, this PR is now included in the new PR so I'm going to close this one. Thanks for your time! |
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 2, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 2, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 2, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 2, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 3, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 3, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 5, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
wouterj
added a commit
to wouterj/symfony-docs
that referenced
this pull request
Feb 5, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
OskarStark
added a commit
that referenced
this pull request
Feb 6, 2020
…onin, savvasal, wouterj) This PR was merged into the 5.0 branch. Discussion ---------- [Notifier] Added Notifier guide This PR merges the work of our doc hero's @TheGarious, @andreybolonin and @savvasal in #12678, #12846 and #12963 . Fixes #12430 and fixes #12552 The component has 2 different usages: Using the high-level Notifier abstraction and using the lower-level Chatter and Texter abstractions. I decided to only document the high-lever in the main guide and use sub guides for Chatter and Texter. This PR focuses on having the base documentation ready. Some features (monolog & messenger integration) are not documented. Let's create issues for those and do them after this PR is merged. Commits ------- 69f3330 Improved some grammar thanks to @savvasal 06f7009 Add Notifier component documentation 0179303 Reorder the use statements alphabetically b9d0d7f Slack notifier actions documentation 34f23d0 add notifier.rst 4810fbf WIP Notifer Page
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#12430