From df6f4d28558b570fabf52df03bf96f93701a34eb Mon Sep 17 00:00:00 2001 From: derrickmehaffy Date: Mon, 3 Jan 2022 11:29:13 -0700 Subject: [PATCH 1/5] Add warning to email doc to use full provider name --- docs/developer-docs/latest/plugins/email.md | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/developer-docs/latest/plugins/email.md b/docs/developer-docs/latest/plugins/email.md index 4238b8a71b..9b231cf689 100644 --- a/docs/developer-docs/latest/plugins/email.md +++ b/docs/developer-docs/latest/plugins/email.md @@ -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`. +:::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'` ::: Here is an example of a configuration made for the provider [@strapi/provider-email-sendgrid](https://www.npmjs.com/package/@strapi/provider-email-sendgrid). @@ -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` From 4b7c8b9655e27fd8018d692e52a13362d5087e27 Mon Sep 17 00:00:00 2001 From: derrickmehaffy Date: Mon, 3 Jan 2022 11:31:12 -0700 Subject: [PATCH 2/5] lets use an email provider not upload --- docs/developer-docs/latest/plugins/email.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-docs/latest/plugins/email.md b/docs/developer-docs/latest/plugins/email.md index 9b231cf689..5b81b287b0 100644 --- a/docs/developer-docs/latest/plugins/email.md +++ b/docs/developer-docs/latest/plugins/email.md @@ -101,7 +101,7 @@ 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 -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'` +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-email-mandrill'` ::: Here is an example of a configuration made for the provider [@strapi/provider-email-sendgrid](https://www.npmjs.com/package/@strapi/provider-email-sendgrid). From a2bf97a797b323c81110ad0521485a1bbd944410 Mon Sep 17 00:00:00 2001 From: DMehaffy Date: Tue, 4 Jan 2022 09:32:27 -0700 Subject: [PATCH 3/5] Update docs/developer-docs/latest/plugins/email.md Co-authored-by: Pierre Wizla --- docs/developer-docs/latest/plugins/email.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-docs/latest/plugins/email.md b/docs/developer-docs/latest/plugins/email.md index 5b81b287b0..966f26432c 100644 --- a/docs/developer-docs/latest/plugins/email.md +++ b/docs/developer-docs/latest/plugins/email.md @@ -100,7 +100,7 @@ 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 +::: note 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-email-mandrill'` ::: From 713521269564127eb89b58e0abecfdcc74396b8c Mon Sep 17 00:00:00 2001 From: DMehaffy Date: Tue, 4 Jan 2022 09:32:35 -0700 Subject: [PATCH 4/5] Update docs/developer-docs/latest/plugins/email.md Co-authored-by: Pierre Wizla --- docs/developer-docs/latest/plugins/email.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer-docs/latest/plugins/email.md b/docs/developer-docs/latest/plugins/email.md index 966f26432c..9885fe6347 100644 --- a/docs/developer-docs/latest/plugins/email.md +++ b/docs/developer-docs/latest/plugins/email.md @@ -101,7 +101,7 @@ 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. ::: note -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-email-mandrill'` +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). From f2f7459066d17e72e750c9592128cdf9bfda7631 Mon Sep 17 00:00:00 2001 From: derrickmehaffy Date: Tue, 4 Jan 2022 09:34:34 -0700 Subject: [PATCH 5/5] fix upload providers too --- docs/developer-docs/latest/plugins/upload.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-docs/latest/plugins/upload.md b/docs/developer-docs/latest/plugins/upload.md index 7f6e7b4509..d12990bd94 100644 --- a/docs/developer-docs/latest/plugins/upload.md +++ b/docs/developer-docs/latest/plugins/upload.md @@ -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