Email + Upload Plugins and Providers pages #992
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
pwizla
added
pr: new content
Co-authored-by: Shaun Brown <[email protected]>
pwizla
requested changes
Jul 12, 2022
There was a problem hiding this comment.
Thanks for the work!
I added a few inline suggestions.
Also, I think we should take these points into consideration:
- "Using providers" does not seem to be consistent with the other section names. I'd suggest "Providers". In this case, we should update the file name and the corresponding links.
- Some links are broken. Please run
yarn check-linkslocally and fix errors. Some links actually give 404s, some don't (the script is sometimes confused if you use.htmlinstead of.md, as it's verifying raw markdown files, not the outputted HTML). I think it's important to make sure that the output ofcheck-linksis fine (i.e. "Checking passed") as we might automate this in the future and deployments would fail if errors are found. Also, it would be best to switch to absolute links (starting with/user-docsor/developer-docs) as it's more maintainable — if we move files, relative links (e.g.../../my-link) will return 404s. - We should add a link to the Sentry documentation to the Strapi plugins introduction.
. Let me know if you need any help with this 🤗
| | `emailOptions` | Object that contains email options (`to`, `from`, `replyTo`, `cc`, `bcc`) except `subject`, `text` and `html` | object | `{}` | | ||
| | `emailTemplate` | Object that contains `subject`, `text` and `html` as [lodash string templates](https://lodash.com/docs/4.17.15#template) | object | `{}` | | ||
| | `data` | Object that contains the data used to compile the templates | object | `{}` | | ||
| The `sendTemplatedEmail()` is used to compose emails from a template. The function compiles the email from the available properties and then sends the email. To use the `sendTemplatedEmail()` function, define the `emailTemplate` object and add the function to a controller or service. The function calls the `emailTemplate` object, and can optionally call the `emailOptions` and `data` objects: |
There was a problem hiding this comment.
I'd recommend "The sendTemplatedEmail() function" or simply "sendTemplatedEmail()" to stay consistent with the rest of the documentation. WDYT?
Co-authored-by: Pierre Wizla <[email protected]>
stb13579
reviewed
Jul 12, 2022
@pwizla All points addressed except for this one since I wasn't sure about adding the Sentry logo to the PluginLinks component |
|
Thanks, @gpene, we'll handle the Sentry logo thing together. FYI I've updated the target branch to |
This was referenced Jul 13, 2022
pwizla
approved these changes
Jul 13, 2022
pwizla
added a commit
that referenced
this pull request
Jul 13, 2022
* Update error-handling.md (#988) camel case → lower camel case * Bump to version 4.2.3 * Add warning callout for enum values (#984) * Add warning callout for enum values * Update wording to be more specific (dev feedback) Co-authored-by: Jean-Sébastien Herbaux <[email protected]> * Downgrade callout from danger to caution Co-authored-by: Jean-Sébastien Herbaux <[email protected]> * update link to public roadmap (#990) * update link to public roadmap From Product Board to Canny * Update wording "our" → "the" Co-authored-by: Pierre Wizla <[email protected]> * Email + Upload Plugins and Providers pages (#992) * fixed code snippets and added ts config * added new introduction * revised wording * add tabs card * Add code snippets for providers * Reorg doc structure * adds Using Providers page * fix tabs * rework text * start programmatic use section * Rework the email template section * various changes * Add code example for lifecycle hook in admin panel * add temp links to new providers page * delete configure the plugin * change wording about SendMail * finalize intro topics * remove unused content * Cleanup code examples and remove troubleshooting section * comment out last section for now * fix grammar * add html tags to table * small content edit * Adding Sentry plugin doc * fix tables * fix controller code example * updated some language * update lifecycle hook section * improve spelling an grammar * improve misc things * improve the introduction * update table and misc improvements * improved lifecycle hook text * Fix email plugin caps * fix * Add missing closing </ul> that prevented VuePress rendering * add bullet points * remove unnecessary fragment * rework intro * Update based on feedback * Update upload.md * improved various parts * add call out and fix titles * misc improvements * simplify wording * fix code block file paths and header levels * fixed various parts * update node engines * add spaces to empty object braces * trim content * shorten send func disc * feedback updates * add optional to table * Add send function properties table * updated send function table * add spacing * Update docs/developer-docs/latest/plugins/email.md Co-authored-by: Pierre Wizla <[email protected]> * updated minor wording + delint * add space * feedback revisions * modify `send` properties table * feedback * feedback * revisions * fix links in admin panel config file * delint * minor fixes * Update docs/developer-docs/latest/development/using-providers.md Co-authored-by: Shaun Brown <[email protected]> * Update docs/developer-docs/latest/plugins/email.md Co-authored-by: Pierre Wizla <[email protected]> * Update docs/developer-docs/latest/plugins/email.md * Feedback * title fix * add table * Add Sentry to PluginLinks component Co-authored-by: Shaun Brown <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> Co-authored-by: Shaun Brown <[email protected]> Co-authored-by: Pierre Wizla <[email protected]> * Fix - → — * Update Email example to include missing path * Fix broken link * Fix another broken link * Update cross-link for compliance with style guide Co-authored-by: Adegbola Stephen <[email protected]> Co-authored-by: Jean-Sébastien Herbaux <[email protected]> Co-authored-by: Victor Coisne <[email protected]> Co-authored-by: Gabriel <[email protected]> Co-authored-by: Shaun Brown <[email protected]> Co-authored-by: Shaun Brown <[email protected]>
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.
@pwizla / @StrapiShaun All 4 pending branches merged here for final link checks, edits, etc.