Skip to content

Add warning to email doc to use full provider name #636

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jan 5, 2022
Merged

Add warning to email doc to use full provider name #636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df6f4d2
Add warning to email doc to use full provider name
derrickmehaffy Jan 3, 2022
4b7c8b9
lets use an email provider not upload
derrickmehaffy Jan 3, 2022
a2bf97a
Update docs/developer-docs/latest/plugins/email.md
derrickmehaffy Jan 4, 2022
7135212
Update docs/developer-docs/latest/plugins/email.md
derrickmehaffy Jan 4, 2022
f2f7459
fix upload providers too
derrickmehaffy Jan 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions docs/developer-docs/latest/plugins/email.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ yarn add @strapi/provider-email-sendgrid --save

After installing your provider you will need to add some settings in `./config/plugins.js`. If this file doesn't exists, you'll need to create it. Check the README of each provider to know what configuration settings the provider needs.

::: tip
Make sure you have the correct spelling of the configuration filename, it is written in plural (with a trailing 's'): `plugins.js`.
::: note
When using community providers, pass the full package name to the `provider` key (e.g. `provider: 'strapi-provider-email-mandrill'`). Only Strapi-maintained providers can use the shortcode format (e.g. `provider: 'sendmail'`).
:::

Here is an example of a configuration made for the provider [@strapi/provider-email-sendgrid](https://www.npmjs.com/package/@strapi/provider-email-sendgrid).
Expand Down Expand Up @@ -155,17 +155,6 @@ module.exports = {
};
```

It is important that your provider's `package.json` includes the following object:

```json
{
// ...
"strapi": {
"isProvider": true
}
}
```

In the `send` function you will have access to:

- `providerOptions` that contains configurations written in `plugins.js`
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-docs/latest/plugins/upload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,8 +406,8 @@ module.exports = ({ env })=>({

To enable the provider, create or edit the file at `./config/plugins.js`

:::tip
When using community providers, you need to pass the full package name to the `provider` key, only Strapi maintained providers can use the short-code eg: `provider: 'strapi-provider-upload-google-cloud-storage'`
::: note
When using community providers, pass the full package name to the `provider` key (e.g. `provider: 'strapi-provider-upload-google-cloud-storage'`). Only Strapi-maintained providers can use the shortcode format (e.g. `provider: 'aws-s3'`).
:::

```js
Expand Down