[Notifier] Added Notifier guide #13025
Merged
Conversation
This file contains 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
This was referenced Feb 2, 2020
Closed
Closed
wouterj
force-pushed
the
pull-12678
branch
2 times, most recently
from
d8a4ff6
to
5f9d04a
Compare
OskarStark
reviewed
Feb 2, 2020
|
Thanks for your quick review @OskarStark! And sorry for the number of spelling errors, I rushed this PR a bit :) |
|
No problem, glad you find time to make this first big step 👍🏻 |
savvasal
approved these changes
Feb 4, 2020
norkunas
reviewed
Feb 4, 2020
OskarStark
requested changes
Feb 5, 2020
This merges the work of symfony#12678, symfony#12846, symfony#12963 and finishes the main Notifier guide.
Co-Authored-By: Savvas Alexandrou <savvas.alexandrou@gmail.com>
OskarStark
approved these changes
Feb 5, 2020
|
Amazing work. Thanks to all contributors 👍 🎉 |
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
fabpot
reviewed
Feb 8, 2020
| Nexmo ``symfony/nexmo-notifier`` ``nexmo://KEY:SECRET@default?from=FROM`` | ||
| ======= =========================== ======================================== | ||
|
|
||
| To enable a texter, add the add the correct DSN in your ``.env`` file and |
There was a problem hiding this comment.
Fixed in latest PR ✌🏻 Thanks for the hint
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Apr 21, 2020
This PR was merged into the 5.1-dev branch. Discussion ---------- [Notifier] Add Free Mobile notifier | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Implements symfony/symfony-docs#13025 (review) | License | MIT | Doc PR | Will document if accepted (see **Usage** below) ## Add a new notifier (SMS) with the French Free Mobile provider. It is a **special notifier** as it **only send the SMS to the self user**, but I think it can be **useful for notification alerting purposes** (the way I use it already, and plan to use it with the component) --- **Provider doc:** (🇫🇷 sorry) https://mobile.free.fr/moncompte/index.php?page=options <img width="716" alt="1" src="https://user-images.githubusercontent.com/13205768/74357784-b55c3500-4dc0-11ea-95ba-19ded062e800.png"> <img width="431" alt="2" src="https://user-images.githubusercontent.com/13205768/74357786-b7be8f00-4dc0-11ea-837e-b922c20e9a2e.png"> --- **Usage:** ``` // .env file FREEMOBILE_DSN=freemobile://LOGIN:PASSWORD@default?phone=PHONE ``` where: - `LOGIN` is your Free Mobile login - `PASSWORD` is the token displayed in the config panel - `PHONE` is your Free Mobile phone number ```yaml // config/packages/notifiers.yaml file framework: notifier: texter_transports: freemobile: '%env(FREEMOBILE_DSN)%' ``` Then you can then use it like documented here https://symfony.com/doc/current/notifier/texters.html ℹ️ As this is a special notifier, the `PHONE` provided inside the DSN mut be the same used [here](https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Notifier/Message/SmsMessage.php#L31) for `$phone` value --- Voilà! Commits ------- 1b8709e Add Free Mobile notifier
symfony-splitter
pushed a commit
to symfony/notifier
that referenced
this pull request
Apr 21, 2020
This PR was merged into the 5.1-dev branch. Discussion ---------- [Notifier] Add Free Mobile notifier | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Implements symfony/symfony-docs#13025 (review) | License | MIT | Doc PR | Will document if accepted (see **Usage** below) ## Add a new notifier (SMS) with the French Free Mobile provider. It is a **special notifier** as it **only send the SMS to the self user**, but I think it can be **useful for notification alerting purposes** (the way I use it already, and plan to use it with the component) --- **Provider doc:** (🇫🇷 sorry) https://mobile.free.fr/moncompte/index.php?page=options <img width="716" alt="1" src="https://user-images.githubusercontent.com/13205768/74357784-b55c3500-4dc0-11ea-95ba-19ded062e800.png"> <img width="431" alt="2" src="https://user-images.githubusercontent.com/13205768/74357786-b7be8f00-4dc0-11ea-837e-b922c20e9a2e.png"> --- **Usage:** ``` // .env file FREEMOBILE_DSN=freemobile://LOGIN:PASSWORD@default?phone=PHONE ``` where: - `LOGIN` is your Free Mobile login - `PASSWORD` is the token displayed in the config panel - `PHONE` is your Free Mobile phone number ```yaml // config/packages/notifiers.yaml file framework: notifier: texter_transports: freemobile: '%env(FREEMOBILE_DSN)%' ``` Then you can then use it like documented here https://symfony.com/doc/current/notifier/texters.html ℹ️ As this is a special notifier, the `PHONE` provided inside the DSN mut be the same used [here](https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Notifier/Message/SmsMessage.php#L31) for `$phone` value --- Voilà! Commits ------- 1b8709ee72 Add Free Mobile notifier
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.
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.