Tutorial: Notifications #190
Merged
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
Loads of proof reading and re-wording
ghost
requested a review
from 
iMattPro
approved these changes
May 6, 2020
paul999
reviewed
May 8, 2020
| ============================ | ||
| The first thing is to determine a name for the type of notification we will create. | ||
| For the purposes of this tutorial we will name it ''sample''. All extensions should always | ||
| use their vendor and name as prefixes, so the notification type name we'll be using is: ``vendor.extension.notification.type.sample``. |
There was a problem hiding this comment.
Maybe use acme.demo as name like in https://area51.phpbb.com/docs/dev/3.1.x/extensions/tutorial_key_concepts.html
There was a problem hiding this comment.
As far as I am aware, we are trying to move away from acme/demo to vendor/extension. So it's truly clear what is being meant, cause while most of us might know that acme is used as a 'fictional extension writer', it isn't really clear for everyone. While it should be 'obvious to anyone looking at it, even for the first time'.
Perhaps @VSEphpbb can way in.
There was a problem hiding this comment.
I don't like using acme demo. It's been my experience some people don't know what the heck we're talking about when we use it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 is a tutorial for the extensions documentation.
Might become a bit large, but that is to cover all bases.
As I've seen quite a few questions in regards to notifications; creating a notification type and how to manage (send, update, mark, delete) them. And I've lately also seen a few extensions with notifications that could use a tutorial :P
First few sections are finished, mostly focused on creating a notification type and all the available functions within. Already creating the PR so people (read: @VSEphpbb) can already have a look.
Still to-do: