Merge branch 'main' into dev/quick-start-guide

Author: pwizla

docs/.vuepress/config.js

@@ -321,6 +321,14 @@ const sidebar = {
           '/user-docs/latest/users-roles-permissions/managing-administrators',
           'Managing administrator accounts',
         ],
+        [
+          '/user-docs/latest/users-roles-permissions/configuring-end-users-roles',
+          'Configuring end-users roles',
+        ],
+        [
+          '/user-docs/latest/users-roles-permissions/managing-end-users',
+          'Managing end-users accounts',
+        ],
       ],
     },
     {
@@ -340,6 +348,7 @@ const sidebar = {
       title: 'General settings',
       children: [
         ['/user-docs/latest/settings/managing-global-settings', 'Managing global settings'],
+        ['/user-docs/latest/settings/configuring-users-permissions-plugin-settings', 'Configuring Users & Permissions plugin settings'],
       ],
     },
   ],

docs/developer-docs/latest/developer-resources/cli/CLI.md

@@ -345,6 +345,20 @@ strapi generate:plugin <name>
 
 Please refer to the [local plugins](/developer-docs/latest/development/local-plugins-customization.md) section to know more.
 
+## strapi generate:template
+
+Create a template from the current strapi project
+
+```bash
+strapi generate:template <path>
+```
+
+- **strapi generate:template &#60;path&#62;**<br/>
+  Generates a Strapi template at `<path>`
+
+  Example: `strapi generate:template ../strapi-template-name` will copy the required files and folders to a `template` directory inside `../strapi-template-name`
+
+
 ## strapi install
 
 Install a plugin in the project.

docs/developer-docs/latest/guides/registering-a-field-in-admin.md

@@ -394,7 +394,7 @@ At this point we have simply created a new plugin which is mounted in our projec
 Since the goal of our plugin is to override the current WYSIWYG we don't want it to be displayed in the administration panel but we need it to register our new **Field**.
 In order to do so, we will simply **modify** the front-end entry point of our plugin.
 
-This file is already present. Please replace the content of this file wit the following:
+This file is already present. Please replace the content of this file with the following:
 
 **Path —** `./plugins/wysiwyg/admin/src/index.js`
 

docs/developer-docs/latest/setup-deployment-guides/installation/cli.md

@@ -13,7 +13,7 @@ Fast-track local install for getting Strapi running on your computer.
 
 #### Node.js
 
-Strapi only requires [Node.js](https://nodejs.org). Strapi only supports **LTS versions** of Node.js, the current recommended version to run Strapi is **Node LTS v14**. Other versions of of Node.js may not be compatible with the latest release of Strapi.
+Strapi only requires [Node.js](https://nodejs.org). Strapi only supports **LTS versions** of Node.js, the current recommended version to run Strapi is **Node LTS v14**. Other versions of Node.js may not be compatible with the latest release of Strapi.
 
 This is everything you need to run Strapi on your local environment.
 

docs/developer-docs/latest/setup-deployment-guides/installation/templates.md

@@ -76,7 +76,29 @@ To create a Strapi template, you need to publish a public GitHub repository that
 
 First, a template's only concern should be to adapt Strapi to a use case. It should not deal with environment-specific configs, like databases, or upload and email providers. This is to make sure that templates stay maintainable, and to avoid conflicts with other CLI options like `--quickstart`.
 
-Second, a template must follow the following file structure.
+Second, a template must follow the file structure detailed below.
+
+You can create this file structure by hand or generate it via the [CLI](/documentation/developer-docs/latest/developer-resources/cli/CLI.html#strapi-generate-template)
+
+:::: tabs
+
+::: tab yarn
+
+```bash
+yarn strapi generate:template <path>
+```
+
+:::
+
+::: tab npx
+
+```bash
+npx strapi generate:template <path>
+```
+
+:::
+
+::::
 
 ### File structure
 
@@ -133,9 +155,7 @@ After reading the above rules, follow these steps to create your template:
 
 1. Create a standard Strapi app with `create-strapi-app`, using the `--quickstart` option.
 2. Customize your app to match the needs of your use case.
-3. Outside of Strapi, create a new directory for your template.
-4. Create a `template.json` file in your template directory.
+3. Generate your template using the [CLI](/documentation/developer-docs/latest/developer-resources/cli/CLI.html#strapi-generate-template) by running `strapi generate:template <path>`
+4. Navigate to this path to see your generated template
 5. If you have modified your app's `package.json`, include these changes (and _only_ these changes) in `template.json` in a `package` property. Otherwise, leave it as an empty object.
-6. Create a `/template` subdirectory.
-7. Think of all the files you have modified in your app, and copy them to the `/template` directory
-8. Publish the root template project on GitHub. Make sure that the repository is public, and that the code is on the `master` branch.
+6. Publish the root template project on GitHub. Make sure that the repository is public, and that the code is on the `master` branch.

docs/user-docs/latest/assets/plugins/icon_up-plugin.png

@@ -29,4 +29,24 @@ The Internationalization plugin impacts several parts of the admin panel. The ta
 |------------------|---------------------------------------------------------------------------------------------------------|
 | Settings         | <ul><li>Addition of a new "Internationalization" setting sub-section, from which to add, edit or delete locales available for the application (see [Configuring Internationalization locales](../settings/managing-global-settings.md#configuring-internationalization-locales)). <br> 👉 Path reminder: *General > Settings > Global Settings > Internationalization* </li> <br> <li>Addition of new permissions for administator roles: access to content-types, as well as possible actions on the content-types, can be defined depending on the locale (see [Configuring role's permissions](/user-docs/latest/users-roles-permissions/configuring-administrator-roles.md#configuring-role-s-permissions)). <br> 👉 Path reminder: *General > Settings > Administration panel*</li></ul> |
 | Content-Types Builder | <ul><li>Addition of a new setting at content-type level, to allow or not localisation/translation of the content-type (see [Creating a new content-type](/user-docs/latest/content-types-builder/creating-new-content-type.md#creating-a-new-content-type)).</li> <li>Addition of a new setting at field level, to allow or not localisation/translation of the content-type (see [Configuring fields for content types](/user-docs/latest/content-types-builder/configuring-fields-content-type.md#regular-fields)).</li></ul> |
-| Content Manager | <ul><li>Addition of new *Locales* filter in collection types list view, to manage entries per locale (see [Introduction to the Content Manager](/user-docs/latest/content-manager/introduction-to-content-manager.md#collection-types)).</li> <li>Addition of new options in content-types edit view, to translate content and manage it per locale (see [Translating content](/user-docs/latest/content-manager/translating-content.md)).</li></ul> |
+| Content Manager | <ul><li>Addition of new *Locales* filter in collection types list view, to manage entries per locale (see [Introduction to the Content Manager](/user-docs/latest/content-manager/introduction-to-content-manager.md#collection-types)).</li> <li>Addition of new options in content-types edit view, to translate content and manage it per locale (see [Translating content](/user-docs/latest/content-manager/translating-content.md)).</li></ul> |
+
+
+### <img width="28" src="../assets/plugins/icon_up-plugin.png"> Users & Permissions plugin
+
+The Users & Permissions plugin is installed by default on all Strapi applications.
+
+This plugin allows to manage end-users, who consume the content that is created and managed with a Strapi application and displayed on a front-end application (e.g. website, mobile application, connected device etc.). With the Users & Permissions plugin, it is possible to:
+
+- manage end-users accounts, based on a "User" collection type available through the plugin,
+- define the available end-users roles and their related permissions,
+- manage available providers to enable end-users to login through third-party providers,
+- configure available email templates aimed at the end-users (e.g. password reset, email address confirmation).
+
+The Users & Permissions plugin impacts several parts of the admin panel. The table below lists all the additional options and settings that are added to a Strapi application once the plugin has been installed.
+
+| Section impacted | Options and settings                                                                                    |
+|------------------|---------------------------------------------------------------------------------------------------------|
+| Settings         | <ul>Addition of a "Users & Permissions plugin" setting section, which contains 4 sub-sections: Roles (see [Configuring end-users roles](../users-roles-permissions/configuring-end-users-roles.md)), Providers, Email Templates, and Advanced Settings (see [Configuring Users & Permissions plugin](../settings/configuring-users-permissions-plugin-settings.md)). <br> 👉 Path reminder: *General > Settings > Users & Permissions plugin* </ul> |
+| Content-Types Builder | <ul>Creation of 3 default collection types: "User", "Role" and "Permission". They respectively allow to manage the end-users, the end-users roles and their permissions. These collection types cannot be deleted and their composing fields cannot be edited, but addition of new fields is possible. Out of the 3, only the "User" collection type is then available via the Content Manager.</ul> |
+| Content Manager | <ul>Addition of the default "User" collection type that allows to manage end-user accounts (see [Managing end-users accounts](../users-roles-permissions/managing-end-users.md)). <ul><li>By default, the following fields are available: Username, Email, Password, as well as Confirmed and Blocked as boolean fields.</li> <li>The "User" collection type has a relation established with the "Role" collection type. All end-user accounts must indeed be attributed a role: by default, the end-user is attributed the end-user role set as default, but that role can be changed via the end-users entries directly in the Content Manager.</li></ul> </ul> |

docs/user-docs/latest/assets/settings/up_email-templates.png

@@ -0,0 +1,69 @@
+---
+title: Users & Permissions plugin settings - Strapi User Guide
+description: Instructions to configure the Users & Permissions plugin
+---
+
+# Configuring Users & Permissions plugin settings
+
+The Users & Permissions plugin is managed from the *Users & Permissions plugin* settings section, accessible from *General > Settings* in the main navigation of the admin panel. This settings section allows to configure the available providers, email templates and the advanced settings of the plugin. It also allows to define the end-users roles and their related permissions (see [Configuring end-users roles](../users-roles-permissions/configuring-end-users-roles.md)).
+
+## Configuring providers
+
+The Users & Permissions plugin allows to enable and configure providers, for end-users to login via a third-party provider to access the content of a font-end application through the Strapi application API. By default, a list of providers is available including one, "Email", enabled by default for all Strapi applications with the Users & Permissions plugin installed.
+
+![Providers interface](../assets/settings/up_providers.png)
+
+To enable and configure a provider:
+
+1. Go to the *Users & Permissions plugin > Providers* sub-section of the settings interface.
+2. Click on the provider to enable and configure.
+3. In the provider edition window, click on the **ON** button of the *Enable* option.
+4. Fill in the provider's configurations. Each provider has its own specific set of configurations, detailed in our developer documentation (see [Setting up the provider](https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#setting-up-the-provider-examples)).
+5. Click on the **Save** button.
+
+::: tip NOTE
+Other providers that are not proposed by default by Strapi can be added manually through the code of your Strapi application (see [Developer documentation](https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#adding-a-new-provider-to-your-project)).
+:::
+
+## Configuring email templates
+
+The Users & Permissions plugin uses 2 email templates, "Email address confirmation" and "Reset password", that are sent to end-users:
+
+- if their account must be confirmed to be activated,
+- if they need to reset the password of their Strapi account.
+
+![Email templates interface](../assets/settings/up_email-templates.png)
+
+To configure and edit email templates:
+
+1. Go to the *Users & Permissions plugin > Email templates* sub-section of the settings interface.
+2. Click on the name of the email template to configure and edit.
+3. Configure the email template:
+
+| Setting name   | Instructions                                                                                     |
+| -------------- | -------------------------------------------------------------------------------------------------|
+| Shipper name   | Indicate the name of the shipper of the email.                                                   |
+| Shipper email  | Indicate the email address of the shipper of the email.                                          |
+| Response email | (optional) Indicate the email address to which responses emails from the end-users will be sent. |
+| Subject        | Write the subject of the email. Variables can be used (see [Developer documentation](https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#templating-emails)).             |
+
+4. Edit the content of the email in the "Message" textbox. Email templates content is in HTML and uses variables (see [Developer documentation](https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#templating-emails)).
+5. Click on the **Save** button.
+
+## Configuring advanced settings
+
+All settings related to the Users & Permissions plugin are managed from the *Advanced Settings* sub-section, including the choice of a default role for end-users, the enablement of sign-ups and email confirmation, as well as the choice of landing page for resetting a password.
+
+![Advanced settings interface](../assets/settings/up_settings.png)
+
+1. Go to the *Users & Permissions plugin > Advanced settings* sub-section of the settings interface.
+2. Configure the settings:
+
+| Setting name                         | Instructions                                                                                                                                                       |
+| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Default role for authenticated users | Click the drop-down list to choose the default role for new end-users.                                                                                             |
+| One account per email address        | Click on the **ON** button to limit to 1 the number of end-user accounts with the same email address. Click on **OFF** to disable this limitation and allow several end-users accounts to be associated with the same email addess (e.g. `[email protected]` can be used when logging in via several different providers). |
+| Enable sign-ups                      | Click on the **ON** button to enable end-users sign-ups. Click on **OFF** to prevent end-users registration to your front-end application(s).                      |
+| Reset password page                  | Indicate the URL of the reset password page for your front-end application(s).                                                                                     |
+| Enable email confirmation            | Click on the **ON** button to enable end-users account confirmation by sending them a confirmation email. Click on **OFF** to disable account confirmation.        |
+| Redirection url                      | Indicate the URL of the page where end-users should be redirected after confirming their Strapi account.                                                           |