Update all documentation links in the code-base and readmes (#9643)

Signed-off-by: Derrick Mehaffy <derrickmehaffy@gmail.com>
2025-12-28 15:44:59 +00:00 · 2021-03-09 01:13:15 -07:00 · 2021-03-09 01:13:15 -07:00 · ba0637e26b
commit ba0637e26b
parent 54b82b948e
24 changed files with 33 additions and 33 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -71,7 +71,7 @@ _For users running on Apple Silicon M1, you may encounter errors thrown by `shar

 To facilitate the contribution, we have drastically reduced the amount of commands necessary to install the entire development environment.

-First of all, you need to check if you're using the [required versions of Node.js and npm](https://strapi.io/documentation/developer-docs/latest/installation/cli.html#step-1-make-sure-requirements-are-met).
+First of all, you need to check if you're using the [required versions of Node.js and npm](https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/deployment.html#recommended-requirements).

 Then, please follow the instructions below:

--- a/README.md
+++ b/README.md
@ -86,7 +86,7 @@ Enjoy 🎉

 ### 🖐 Requirements

-Complete installation requirements can be found in the documentation under <a href="https://strapi.io/documentation/developer-docs/latest/installation/cli.html#step-1-make-sure-requirements-are-met">Installation Requirements</a>.
+Complete installation requirements can be found in the documentation under <a href="https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/deployment.html#recommended-requirements">Installation Requirements</a>.

 **Supported operating systems**:

@ -144,7 +144,7 @@ For general help using Strapi, please refer to [the official Strapi documentatio

 ## Migration

-Follow our [migration guides](https://strapi.io/documentation/developer-docs/latest/migration-guide/#migrations-guides) on the documentation to keep your projects up-to-date.
+Follow our [migration guides](https://strapi.io/documentation/developer-docs/latest/update-migration-guides/migration-guides.html) on the documentation to keep your projects up-to-date.

 ## Roadmap

@ -154,8 +154,8 @@ Check out our [roadmap](https://portal.productboard.com/strapi) to get informed

 See our dedicated [repository](https://github.com/strapi/documentation) for the Strapi documentation, or view our documentation live:

- [Developer docs](https://strapi.io/documentation/developer-docs/latest)
- [User docs](https://strapi.io/documentation/user-docs/latest)
+- [Developer docs](https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html)
+- [User docs](https://strapi.io/documentation/user-docs/latest/getting-started/introduction.html)

 ## Try live demo

--- a/packages/strapi-admin/admin/src/app.js
+++ b/packages/strapi-admin/admin/src/app.js
@ -124,7 +124,7 @@ const remoteURL = (() => {
 const displayNotification = (message, status) => {
  console.warn(
    // Validate the text
-    'Deprecated: Will be deleted.\nPlease use strapi.notification.toggle(config).\nDocs : https://strapi.io/documentation/developer-docs/latest/plugin-development/frontend-development.html#strapi-notification'
+    'Deprecated: Will be deleted.\nPlease use strapi.notification.toggle(config).\nDocs : https://strapi.io/documentation/developer-docs/latest/development/local-plugins-customization.html#strapi-notification'
  );
  dispatch(showNotification(message, status));
 };
--- a/packages/strapi-admin/admin/src/components/Webhooks/EmptyList/index.js
+++ b/packages/strapi-admin/admin/src/components/Webhooks/EmptyList/index.js
@ -17,7 +17,7 @@ function EmptyList() {
      <p>{formatMessage({ id: 'Settings.webhooks.list.empty.title' })}</p>
      <p>{formatMessage({ id: 'Settings.webhooks.list.empty.description' })}</p>
      <a
-        href="https://strapi.io/documentation/developer-docs/latest/concepts/webhooks.html"
+        href="https://strapi.io/documentation/developer-docs/latest/development/backend-customization.html#webhooks"
        target="_blank"
        rel="noopener noreferrer"
      >
--- a/packages/strapi-generate-api/templates/controller.template
+++ b/packages/strapi-generate-api/templates/controller.template
@ -1,7 +1,7 @@
 'use strict';

 /**
- * Read the documentation (https://strapi.io/documentation/developer-docs/latest/concepts/controllers.html#core-controllers)
+ * Read the documentation (https://strapi.io/documentation/developer-docs/latest/development/backend-customization.html#core-controllers)
 * to customize this controller
 */

--- a/packages/strapi-generate-api/templates/model.template
+++ b/packages/strapi-generate-api/templates/model.template
@ -1,7 +1,7 @@
 'use strict';

 /**
- * Read the documentation (https://strapi.io/documentation/developer-docs/latest/concepts/models.html#lifecycle-hooks)
+ * Read the documentation (https://strapi.io/documentation/developer-docs/latest/development/backend-customization.html#lifecycle-hooks)
 * to customize this model
 */

--- a/packages/strapi-generate-api/templates/service.template
+++ b/packages/strapi-generate-api/templates/service.template
@ -1,7 +1,7 @@
 'use strict';

 /**
- * Read the documentation (https://strapi.io/documentation/developer-docs/latest/concepts/services.html#core-services)
+ * Read the documentation (https://strapi.io/documentation/developer-docs/latest/development/backend-customization.html#core-services)
 * to customize this service
 */

--- a/packages/strapi-generate-new/lib/resources/files/config/functions/bootstrap.js
+++ b/packages/strapi-generate-new/lib/resources/files/config/functions/bootstrap.js
@ -7,7 +7,7 @@
 * This gives you an opportunity to set up your data model,
 * run jobs, or perform some special logic.
 *
- * See more details here: https://strapi.io/documentation/developer-docs/latest/concepts/configurations.html#bootstrap
+ * See more details here: https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/configurations.html#bootstrap
 */

 module.exports = () => {};
--- a/packages/strapi-generate-new/lib/resources/files/config/functions/cron.js
+++ b/packages/strapi-generate-new/lib/resources/files/config/functions/cron.js
@ -7,7 +7,7 @@
 * The cron format consists of:
 * [SECOND (optional)] [MINUTE] [HOUR] [DAY OF MONTH] [MONTH OF YEAR] [DAY OF WEEK]
 *
- * See more details here: https://strapi.io/documentation/developer-docs/latest/concepts/configurations.html#cron-tasks
+ * See more details here: https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/configurations.html#cron-tasks
 */

 module.exports = {
--- a/packages/strapi-plugin-documentation/config/settings.json
+++ b/packages/strapi-plugin-documentation/config/settings.json
@ -36,7 +36,7 @@
  ],
  "externalDocs": {
    "description": "Find out more",
-    "url": "https://strapi.io/documentation/developer-docs/latest/"
+    "url": "https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html"
  },
  "security": [
    {
--- a/packages/strapi-plugin-documentation/services/Documentation.js
+++ b/packages/strapi-plugin-documentation/services/Documentation.js
@ -1306,7 +1306,7 @@ module.exports = {

    if (verb === 'get' && controllerMethod === 'find') {
      // parametersOptions corresponds to this section
-      // of the documentation https://strapi.io/documentation/guides/filters.html
+      // of the documentation https://strapi.io/documentation/developer-docs/latest/developer-resources/content-api/content-api.html#filters
      return [...params, ...parametersOptions];
    }

--- a/packages/strapi-plugin-email/admin/src/containers/Settings/index.js
+++ b/packages/strapi-plugin-email/admin/src/containers/Settings/index.js
@ -122,7 +122,7 @@ const SettingsPage = () => {
                    file: <code>./config/plugins.js</code>,
                    link: (
                      <a
-                        href="https://strapi.io/documentation/developer-docs/latest/plugins/email.html#configure-the-plugin"
+                        href="https://strapi.io/documentation/developer-docs/latest/development/plugins/email.html#configure-the-plugin"
                        target="_blank"
                        rel="noopener noreferrer"
                      >
--- a/packages/strapi-plugin-email/controllers/Email.js
+++ b/packages/strapi-plugin-email/controllers/Email.js
@ -36,7 +36,7 @@ module.exports = {
    const email = {
      to: to,
      subject: `Strapi test mail to: ${to}`,
-      text: `Great! You have correctly configured the Strapi email plugin with the ${strapi.plugins.email.config.provider} provider. \r\nFor documentation on how to use the email plugin checkout: https://strapi.io/documentation/developer-docs/latest/plugins/email.html`,
+      text: `Great! You have correctly configured the Strapi email plugin with the ${strapi.plugins.email.config.provider} provider. \r\nFor documentation on how to use the email plugin checkout: https://strapi.io/documentation/developer-docs/latest/development/plugins/email.html`,
    };

    try {
--- a/packages/strapi-plugin-graphql/README.md
+++ b/packages/strapi-plugin-graphql/README.md
@ -3,4 +3,4 @@
 This plugin will add GraphQL functionality to your app.
 By default it will provide you with most of the CRUD methods exposed in the Strapi REST API.

-To learn more about GraphQL in Strapi [visit documentation](https://strapi.io/documentation/developer-docs/latest/plugins/graphql.html)
+To learn more about GraphQL in Strapi [visit documentation](https://strapi.io/documentation/developer-docs/latest/development/plugins/graphql.html)
--- a/packages/strapi-plugin-users-permissions/admin/src/containers/EmailTemplates/CustomTextInput.js
+++ b/packages/strapi-plugin-users-permissions/admin/src/containers/EmailTemplates/CustomTextInput.js
@ -28,7 +28,7 @@ const CustomTextInput = ({

  const link = (
    <a
-      href="https://strapi.io/documentation/developer-docs/latest/plugins/users-permissions.html#templating-emails"
+      href="https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#templating-emails"
      target="_blank"
      rel="noopener noreferrer"
    >
--- a/packages/strapi-plugin-users-permissions/admin/src/containers/EmailTemplates/utils/forms.js
+++ b/packages/strapi-plugin-users-permissions/admin/src/containers/EmailTemplates/utils/forms.js
@ -50,7 +50,7 @@ const forms = [
        values={{
          link: (
            <a
-              href="https://strapi.io/documentation/developer-docs/latest/plugins/users-permissions.html#templating-emails"
+              href="https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#templating-emails"
              target="_blank"
              rel="noopener noreferrer"
            >
--- a/packages/strapi-plugin-users-permissions/controllers/Auth.js
+++ b/packages/strapi-plugin-users-permissions/controllers/Auth.js
@ -256,7 +256,7 @@ module.exports = {

    if (!strapi.config.server.url.startsWith('http')) {
      strapi.log.warn(
-        'You are using a third party provider for login. Make sure to set an absolute url in config/server.js. More info here: https://strapi.io/documentation/developer-docs/latest/plugins/users-permissions.html#setting-up-the-server-url'
+        'You are using a third party provider for login. Make sure to set an absolute url in config/server.js. More info here: https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#setting-up-the-server-url'
      );
    }

--- a/packages/strapi-plugin-users-permissions/documentation/1.0.0/overrides/users-permissions-User.json
+++ b/packages/strapi-plugin-users-permissions/documentation/1.0.0/overrides/users-permissions-User.json
@ -6,7 +6,7 @@
        "security": [],
        "externalDocs": {
          "description": "Find out more in the strapi's documentation",
-          "url": "https://strapi.io/documentation/guides/authentication.html#usage"
+          "url": "https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#registration"
        },
        "responses": {
          "200": {
@ -58,7 +58,7 @@
        "security": [],
        "externalDocs": {
          "description": "Find out more in the strapi's documentation",
-          "url": "https://strapi.io/documentation/guides/authentication.html#usage"
+          "url": "https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#email-validation"
        },
        "responses": {
          "200": {
@ -130,7 +130,7 @@
        ],
        "externalDocs": {
          "description": "Find out more about the authentication flow in the strapi documentation",
-          "url": "https://strapi.io/documentation/guides/authentication.html#providers"
+          "url": "https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#setting-up-the-provider-examples"
        },
        "responses": {
          "200": {
@ -143,7 +143,7 @@
      "post": {
        "externalDocs": {
          "description": "Find out more in the strapi's documentation",
-          "url": "https://strapi.io/documentation/guides/authentication.html#login"
+          "url": "https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#login"
        },
        "tags": ["Authentication"],
        "security": [],
@ -188,7 +188,7 @@
        "tags": ["Authentication"],
        "externalDocs": {
          "description": "Find out more in the strapi's documentation",
-          "url": "https://strapi.io/documentation/guides/authentication.html#providers"
+          "url": "https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#setting-up-the-provider-examples"
        },
        "parameters": [
          {
@ -223,7 +223,7 @@
        "summary": "Send an email to reset your password",
        "externalDocs": {
          "description": "Find out more in the strapi's documentation",
-          "url": "https://strapi.io/documentation/guides/authentication.html#send-forgot-password-request"
+          "url": "https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html#forgotten-reset-password"
        },
        "requestBody": {
          "description": "",
@ -315,7 +315,7 @@
      "description": "All the routes related to the authentication",
      "externalDocs": {
        "description": "Find out more in strapi's documentation",
-        "url": "https://strapi.io/documentation/guides/authentication.html"
+        "url": "https://strapi.io/documentation/developer-docs/latest/development/plugins/users-permissions.html"
      }
    },
    {
--- a/packages/strapi-provider-upload-aws-s3/README.md
+++ b/packages/strapi-provider-upload-aws-s3/README.md
@ -4,7 +4,7 @@

 Your configuration is passed down to the provider. (e.g: `new AWS.S3(config)`). You can see the complete list of options [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property)

-See the [using a provider](https://strapi.io/documentation/developer-docs/latest/plugins/upload.html#using-a-provider) documentation for information on installing and using a provider. And see the [environment variables](https://strapi.io/documentation/developer-docs/latest/concepts/configurations.html#environment-variables) for setting and using environment variables in your configs.
+See the [using a provider](https://strapi.io/documentation/developer-docs/latest/development/plugins/upload.html#using-a-provider) documentation for information on installing and using a provider. And see the [environment variables](https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/configurations.html#environment-variables) for setting and using environment variables in your configs.

 **Example**

--- a/packages/strapi-provider-upload-cloudinary/README.md
+++ b/packages/strapi-provider-upload-cloudinary/README.md
@ -6,7 +6,7 @@ Your configuration is passed down to the cloudinary configuration. (e.g: `cloudi

 `actionOptions` are passed directly to the upload and delete functions respectively allowing for custom options such as folder, type, etc. You can see the complete list of upload options [here](https://cloudinary.com/documentation/image_upload_api_reference#upload_optional_parameters) and delete options [here](https://cloudinary.com/documentation/image_upload_api_reference#destroy_optional_parameters)

-See the [using a provider](https://strapi.io/documentation/developer-docs/latest/plugins/upload.html#using-a-provider) documentation for information on installing and using a provider. And see the [environment variables](https://strapi.io/documentation/developer-docs/latest/concepts/configurations.html#environment-variables) for setting and using environment variables in your configs.
+See the [using a provider](https://strapi.io/documentation/developer-docs/latest/development/plugins/upload.html#using-a-provider) documentation for information on installing and using a provider. And see the [environment variables](https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/configurations.html#environment-variables) for setting and using environment variables in your configs.

 **Example**

--- a/packages/strapi-provider-upload-local/README.md
+++ b/packages/strapi-provider-upload-local/README.md
@ -17,7 +17,7 @@ This provider has only one parameter: `sizeLimit`.
 }
 ```

-The `sizeLimit` parameter must be a number. Be aware that the unit is in bytes, and the default is 1000000. When setting this value high, you should make sure to also configure the body parser middleware `maxFileSize` so the file can be sent and processed. Read more [here](https://strapi.io/documentation/developer-docs/latest/plugins/upload.html#configuration)
+The `sizeLimit` parameter must be a number. Be aware that the unit is in bytes, and the default is 1000000. When setting this value high, you should make sure to also configure the body parser middleware `maxFileSize` so the file can be sent and processed. Read more [here](https://strapi.io/documentation/developer-docs/latest/development/plugins/upload.html#configuration)

 ## Resources

--- a/packages/strapi-provider-upload-rackspace/README.md
+++ b/packages/strapi-provider-upload-rackspace/README.md
@ -4,7 +4,7 @@

 Your configuration is passed down to the client initialization. (e.g: `createClient(config)`). The implementation is based on the package `pkgcloud`. You can read the docs [here](https://github.com/pkgcloud/pkgcloud#storage).

-See the [using a provider](https://strapi.io/documentation/developer-docs/latest/plugins/upload.html#using-a-provider) documentation for information on installing and using a provider. And see the [environment variables](https://strapi.io/documentation/developer-docs/latest/concepts/configurations.html#environment-variables) for setting and using environment variables in your configs.
+See the [using a provider](https://strapi.io/documentation/developer-docs/latest/development/plugins/upload.html#using-a-provider) documentation for information on installing and using a provider. And see the [environment variables](https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/configurations.html#environment-variables) for setting and using environment variables in your configs.

 **Example**

--- a/packages/strapi-utils/lib/convert-rest-query-params.js
+++ b/packages/strapi-utils/lib/convert-rest-query-params.js
@ -2,7 +2,7 @@

 /**
 * Converts the standard Strapi REST query params to a moe usable format for querying
- * You can read more here: https://strapi.io/documentation/developer-docs/latest/content-api/parameters.html#filters
+ * You can read more here: https://strapi.io/documentation/developer-docs/latest/developer-resources/content-api/content-api.html#filters
 */

 const _ = require('lodash');
--- a/packages/strapi/lib/services/metrics/index.js
+++ b/packages/strapi/lib/services/metrics/index.js
@ -1,7 +1,7 @@
 'use strict';
 /**
 * Strapi telemetry package.
- * You can learn more at https://strapi.io/documentation/developer-docs/latest/global-strapi/usage-information.html#commitment-to-our-users-data-collection
+ * You can learn more at https://strapi.io/documentation/developer-docs/latest/getting-started/usage-information.html
 */

 const crypto = require('crypto');