4.6.1 Docs Release (#1492)

* user-permissions plugin: document how to add Patreon as an Oauth provider

* add server webhooks populateRelations config variable

* Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md

Co-authored-by: Pierre Wizla <[email protected]>

* Auto stash before merge of "dev/webhook-populated-relations" and "origin/dev/webhook-populated-relations"

* add 4.6.1 migration guide

* Update docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md

Co-authored-by: Pierre Noël <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.5.1-to-4.6.1.md

Co-authored-by: Pierre Noël <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.5.1-to-4.6.1.md

Co-authored-by: Pierre Noël <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.5.1-to-4.6.1.md

Co-authored-by: Pierre Noël <[email protected]>

* improve explanation of webhooks populate relations usage

* Update filtering-locale-publication.md (#1441)

for this pull
strapi/strapi#15046

* Fix deployment instructions for Azure CLI

# Change 1: Update Node runtime argument of ```az webapp create```

Running the docs as-is produces an error:
```... Linux Runtime 'node|10.14' is not supported.Run 'az webapp list-runtimes --os-type linux' to cross check```

The correct parameter today is

```bash
--runtime "node|14-lts"
```

# Change 2: Update IP address block arguments of ```az mysql server firewall-rule create```

Running the docs as-is produces an error:
```... the following arguments are required: --start-ip-address, --end-ip-address```

Based on [the most recent docs](https://learn.microsoft.com/en-us/cli/azure/mysql/server/firewall-rule?view=azure-cli-latest), the correct parameters to define the allowed IP blocks are:

```bash
--start-ip-address 0.0.0.0
--end-ip-address 0.0.0.0
```

* Change Node 14 to Node 16

https://azure.microsoft.com/en-us/updates/community-support-for-node-14-lts-is-ending-on-30-april-2023/

* Update docs/developer-docs/latest/plugins/users-permissions.md

* Update docs/developer-docs/latest/plugins/users-permissions.md

* Fix broken links reported in issue #1423 (#1484)

* Fix broken links reported in issue #1423

* Fix BE custom. > middlewares link

* Update quick-start.md (#1478)

* Move sizeLimit one level above in upload provider (#1133)

* move sizeLimit one level above in upload provider

* add sizeLimit deprecation warning

* minor change

* minor change

* checkFileSize upload provider

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md

Co-authored-by: Pierre Wizla <[email protected]>

* Update docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.3.x-to-4.4.x.md

Co-authored-by: Pierre Wizla <[email protected]>

* move migration steps to 4.5.1 to 4.6.1

---------

Co-authored-by: Pierre Wizla <[email protected]>

* update localhost link

* Connect can not be used for media attributes (#1490)

* connect can not be used for meida attributes

* change warning to caution

---------

Co-authored-by: Tom Shortall <[email protected]>
Co-authored-by: Marc-Roig <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Pierre Noël <[email protected]>
Co-authored-by: Jorge Martin <[email protected]>
Co-authored-by: Antti <[email protected]>
Co-authored-by: Shaun Brown <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: katekosm <[email protected]>

Author: 9 people

docs/developer-docs/latest/developer-resources/database-apis-reference/rest/relations.md

@@ -41,6 +41,12 @@ You can also use the longhand syntax to [reorder relations](#relations-reorderin
 
 `connect` can be used in combination with [`disconnect`](#disconnect).
 
+:::caution
+
+`connect` can not be used for media attributes.
+
+:::
+
 <br />
 
 :::::: tabs card

docs/developer-docs/latest/development/providers.md

@@ -151,6 +151,11 @@ module.exports = {
       delete(file) {
         // delete the file in the provider
       },
+      checkFileSize(file, { sizeLimit }) {
+        // implement your own file size limit logic
+        // there is a default logic in place if this
+        // method is not implemented
+      },
     };
   },
 };

docs/developer-docs/latest/getting-started/quick-start.md

@@ -191,7 +191,7 @@ Now that we have created a basic data structure with 2 collection types, "Restau
 #### Create an entry for the "Restaurant" collection type
 
 1. Go to ![Content Manager icon](../assets/quick-start-guide/icons/content.svg) [Content Manager > Collection types - Restaurant](http://localhost:1337/admin/content-manager/collectionType/api::restaurant.restaurant) in the navigation.
-2. Click on **Add new entry**.
+2. Click on **Create new entry**.
 3. Type the name of your favorite local restaurant in the _Name_ field. Let's say it's `Biscotte Restaurant`.
 4. In the _Description_ field, write a few words about it. If you're lacking some inspiration, you can use `Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products, often local, organic when possible, and always produced by passionate producers.`
 5. Click **Save**.
@@ -204,7 +204,7 @@ The restaurant is now listed in the [Collection types - Restaurant](http://local
 
 Let's go to ![Content Manager icon](../assets/quick-start-guide/icons/content.svg) [Content Manager > Collection types - Category](http://localhost:1337/admin/content-manager/collectionType/api::category.category) and create 2 categories:
 
-1. Click on **Add new entry**.
+1. Click on **Create new entry**.
 2. Type `French Food` in the _Name_ field.
 3. Click **Save**.
 4. Go back to _Collection types - Category_, then click again on **Add new entry**.  

docs/developer-docs/latest/plugins/upload.md

@@ -135,7 +135,7 @@ export default [
 
 </code-group>
 
-In addition to the middleware configuration, you can pass the `sizeLimit`, which is an integer in bytes, in the `providerOptions` of the [plugin configuration](/developer-docs/latest/setup-deployment-guides/configurations/optional/plugins.md) in `./config/plugins.js`:
+In addition to the middleware configuration, you can pass the `sizeLimit`, which is an integer in bytes, in the [plugin configuration](/developer-docs/latest/setup-deployment-guides/configurations/optional/plugins.md) in `./config/plugins.js`:
 
 <code-group>
 
@@ -148,9 +148,7 @@ module.exports = {
   // ...
   upload: {
     config: {
-      providerOptions: {
-        sizeLimit: 250 * 1024 * 1024 // 256mb in bytes
-      }
+      sizeLimit: 250 * 1024 * 1024 // 256mb in bytes
     }
   }
 };

docs/developer-docs/latest/setup-deployment-guides/configurations/required/server.md

@@ -32,6 +32,7 @@ The `./config/server.js` file can include the following parameters:
 | `cron.tasks`                        | Declare [CRON jobs](/developer-docs/latest/setup-deployment-guides/configurations/optional/cronjobs.md) to be run at specific dates.                                                                                                                                                                                                                                        | object            |                     |
 | `dirs`                              | Path configuration of different directories Strapi uses.                                                                                                                                                                                                                                                                                                                    | object            |                     |
 | `dirs.public`                       | Customize the path of the public folder.                                                                                                                                                                                                                                                                                                                                    | string            | `./public`          |
+| `webhooks.populateRelations`        | For backward compatibility reasons, the default value is `true`, but the recommended value is `false` to avoid performance issues when having many relations. If you need populated relations in your webhook, we recommend doing a separate query in your webhook listener to fetch the entity only with the necessary data.                                               | boolean           | `true`              |
 
 ## Configurations
 
@@ -130,6 +131,7 @@ export default ({ env }) => ({
   },
 });
 ```
+
 </code-block>
 </code-group>
 

docs/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/azure.md

@@ -48,7 +48,7 @@ In this section we'll use the Azure Portal to create the required resources to h
 
    - _Name_ - `my-strapi-app`
    - _Publish_ - `Code`
-   - _Runtime stack_ - `Node 14 LTS`
+   - _Runtime stack_ - `Node 16 LTS`
    - _Operating System_ - `Linux`
    - _Region_ - Select an appropriate region
 
@@ -126,11 +126,11 @@ In this section, we'll use the [Azure CLI](https://docs.microsoft.com/cli/azure/
    az appservice plan create --resource-group $rgName --name $appPlanName --is-linux --number-of-workers 4 --sku S1 --location $location
    ```
 
-3. Create a Web App running Node.js 14.
+3. Create a Web App running Node.js 16.
 
    ```bash
    webAppName=my-strapi-app
-   az webapp create --resource-group $rgName --name $webAppName --plan $appPlanName --runtime "node|10.14"
+   az webapp create --resource-group $rgName --name $webAppName --plan $appPlanName --runtime "node|16-lts"
    ```
 
 4. Create a Storage Account.
@@ -162,7 +162,7 @@ In this section, we'll use the [Azure CLI](https://docs.microsoft.com/cli/azure/
    az mysql db create --resource-group $rgName --name $dbName --server-name $serverName
 
    # Allow Azure resources through the firewall
-   az mysql server firewall-rule create --resource-group $rgName --server-name $serverName --name AllowAllAzureIps --start-ip-range 0.0.0.0 --end-ip-range 0.0.0.0
+   az mysql server firewall-rule create --resource-group $rgName --server-name $serverName --name AllowAllAzureIps --start-ip-address 0.0.0.0 --end-ip-address 0.0.0.0
    ```
 
 6. Add configuration values to the Web App.

docs/developer-docs/latest/update-migration-guides/migration-guides.md

@@ -22,6 +22,7 @@ Migrations are necessary when upgrades to Strapi include breaking changes. The m
 - [Migration guide from 4.3.6 to 4.3.8](migration-guides/v4/migration-guide-4.3.6-to-4.3.8.md)
 - [Migration guide from 4.4.3 to 4.4.5](migration-guides/v4/migration-guide-4.4.3-to-4.4.5.md)
 - [Migration guide from 4.4.5 to 4.5.1](migration-guides/v4/migration-guide-4.4.5-to-4.5.1.md)
+- [Migration guide from 4.5.1+ to 4.6.1](migration-guides/v4/migration-guide-4.5.1-to-4.6.1.md)
 
 ## v3 to v4 migration guides
 

docs/developer-docs/latest/update-migration-guides/migration-guides/v4/code/backend/policies.md

@@ -121,7 +121,7 @@ In Strapi v4, depending on whether the policy is applied to REST or GraphQL (use
 
 - Both REST and GraphQL contexts have access to the `is`, `type`, and `state`.
 - The REST context have access to the destructed Koa context.
-- The GraphQL context has access to `parent`, `args`, `context` (which is the GraphQL Context), `info` & `http` (which contains the Koa context) (see [GraphQL customization](http://localhost:8080/developer-docs/latest/plugins/graphql.html#custom-configuration-for-resolvers) documentation).
+- The GraphQL context has access to `parent`, `args`, `context` (which is the GraphQL Context), `info` & `http` (which contains the Koa context) (see [GraphQL customization](/developer-docs/latest/plugins/graphql.md#custom-configuration-for-resolvers) documentation).
 
 You can use `policyContext.type`, which value is either `koa` for REST or `graphql` for the GraphQL plugin, to determine the type of context the policy uses.
 :::

docs/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.5.1-to-4.6.1.md

@@ -0,0 +1,132 @@
+---
+title: Migrate from 4.5.1+ to 4.6.1 - Strapi Developer Docs
+description: Learn how you can migrate your Strapi application from 4.5.1+ to 4.6.1.
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.5.1-to-4.6.1.html
+---
+
+# v4.5.1+ to v4.6.1 migration guide
+
+The Strapi v4.5.1+ to v4.6.1 migration guide upgrades v4.5.1+ to v4.6.1. We introduced a configuration for webhooks to receive populated relations. Also, this migration guide is needed for all users who were limiting media size for the local upload provider.
+
+The migration guide consists of:
+
+- Upgrading the application dependencies
+- Changing the webhooks configuration (optional)
+- Updating the local upload provider `sizeLimit`
+- Reinitializing the application
+
+## Upgrading the application dependencies to 4.6.1
+
+:::prerequisites
+Stop the server before starting the upgrade.
+:::
+
+1. Upgrade all of the Strapi packages in `package.json` to `4.6.1`:
+
+   ```json
+   // path: package.json
+
+   {
+     // ...
+     "dependencies": {
+       "@strapi/strapi": "4.6.1",
+       "@strapi/plugin-users-permissions": "4.6.1",
+       "@strapi/plugin-i18n": "4.6.1"
+       // ...
+     }
+   }
+   ```
+
+2. Save the edited `package.json` file.
+
+3. Run either `yarn` or `npm install` to install the new version.
+
+::: tip
+If the operation doesn't work, try removing your `yarn.lock` or `package-lock.json`. If that doesn't help, remove the `node_modules` folder as well and try again.
+:::
+
+## Changing the webhooks configuration (optional)
+
+By default, and for backward compatibility reasons, webhooks will receive the entity with its relations populated again. We do recommend to disable this behavior if you were not using it, as it may cause performance issues when having many relations. If you need populated relations in your webhook, we recommend doing a separate query in your webhook listener to fetch the entity only with the necessary data.
+
+If you want to change this behavior, you can do so by editing the `./config/server.js` file (or `./config/server.ts` if you are using TypeScript) and add the following configuration:
+
+```jsx
+'use strict';
+
+module.exports = ({ env }) => ({
+  host: env('HOST', '0.0.0.0'),
+  port: env.int('PORT', 1337),
+  url: 'http://localhost:1337',
+  webhooks: {
+    // Add this to not receive populated relations in webhooks
+    populateRelations: false,
+  },
+});
+```
+
+With this, you will no longer receive populated relations in webhooks, and **response times on the Content Manager will be shorter**.
+
+You can see more of the available configuration options in the [server configuration documentation](/developer-docs/latest/setup-deployment-guides/configurations/required/server.md).
+
+## Updating the sizeLimit provider configuration
+
+This step is only required if you were using the [`sizeLimit` configuration](/developer-docs/latest/plugins/upload.md#max-file-size) for your upload provider.
+
+:::caution
+The documentation required the `sizeLimit` to be in bytes, but it was actually in kilobytes. This is now fixed, and the limit will be interpreted as bytes.
+
+If you, for some reason, were limiting the file size to kilobytes, you should update the value to be in bytes.
+:::
+
+We recommend to move the `sizeLimit` outside the provider options like the following, as it will be deprecated in the next major version.
+<code-group>
+
+<code-block title="JAVASCRIPT">
+
+```js
+// path: ./config/plugins.js
+
+module.exports = {
+  // ...
+  upload: {
+    config: {
+      sizeLimit: 250 * 1024 * 1024 // Now
+      providerOptions: {
+        sizeLimit: 250 * 1024 * 1024 // Before
+      }
+    }
+  }
+};
+```
+
+</code-block>
+
+<code-block title="TYPESCRIPT">
+
+```js
+// path: ./config/plugins.ts
+
+export default {
+  // ...
+  upload: {
+    config: {
+      sizeLimit: 250 * 1024 * 1024 // Now
+      providerOptions: {
+        sizeLimit: 250 * 1024 * 1024 // Before
+      }
+    }
+  }
+};
+```
+
+</code-block>
+
+</code-group>
+
+To change the script:
+
+1. In the `./config/plugins.js` file, identify the upload configuration if you have one.
+2. (_optional_) If you have a `sizeLimit`, move it one level above `providerOptions`.
+
+!!!include(developer-docs/latest/update-migration-guides/migration-guides/v4/snippets/Rebuild-and-start-snippet.md)!!!