diff --git a/docs.config.ts b/docs.config.ts index 9dfa607f4..e7d77f652 100644 --- a/docs.config.ts +++ b/docs.config.ts @@ -34,63 +34,16 @@ const linkWhitelist: string[] = [...redirects.map(r => r.source), "/forms/produc */ const whitelistedVersions: string[] = []; -/** - * Only build versions at or above this version (e.g., "5.40.x"). - * Set via MIN_VERSION environment variable or modify here. - * Set to empty string to build all versions. - */ -const minVersionToBuild = process.env.MIN_VERSION || ""; - const filterByEnvironment = (version: Version) => { // In `preview`, if there are specific versions whitelisted for deployment, those are the only ones we'll output. if (preview && whitelistedVersions.length > 0) { return whitelistedVersions.includes(version.getValue()); } - // If minVersionToBuild is set, only build versions >= minVersion or `latest`. - if (minVersionToBuild) { - if (minVersionToBuild === "latest") { - return version.isLatest(); - } - const versionNum = parseFloat(version.getValue().replace(/[^\d.]/g, "")); - const minVersionNum = parseFloat(minVersionToBuild.replace(/[^\d.]/g, "")); - return versionNum >= minVersionNum; - } - // Build everything. return true; }; -const filterFilePathByVersion = (filePath: string): boolean => { - // Extract version from file path (e.g., /docs/developer-docs/5.40.x/... or /docs/user-guides/5.40.x/...) - const versionMatch = filePath.match(/\/(\d+\.\d+\.x)\//); - - if (!versionMatch) { - // If no version in path, include the file (e.g., non-versioned docs) - return true; - } - - const versionString = versionMatch[1]; - - // Use the same filtering logic as filterByEnvironment - if (preview && whitelistedVersions.length > 0) { - return whitelistedVersions.includes(versionString); - } - - if (minVersionToBuild) { - if (minVersionToBuild === "latest") { - // For file paths, we can't determine if it's "latest" without more context - // So we'll include all versioned files when minVersionToBuild is "latest" - return true; - } - const versionNum = parseFloat(versionString.replace(/[^\d.]/g, "")); - const minVersionNum = parseFloat(minVersionToBuild.replace(/[^\d.]/g, "")); - return versionNum >= minVersionNum; - } - - return true; -}; - const existsInDocs = (link: string) => { return fs.pathExists(path.join(__dirname, `src/pages/${link}.js`)); }; @@ -99,13 +52,9 @@ export default { projectRootDir: __dirname, cleanOutputDir: path.resolve("src/pages/docs"), sitemapOutputPath: path.resolve("public/algolia/sitemap.xml"), - linkValidator: new LinkValidator( - linkWhitelist, - link => { - return existsInDocs(link); - }, - filterFilePathByVersion - ), + linkValidator: new LinkValidator(linkWhitelist, link => { + return existsInDocs(link); + }), documentRoots: [ /* Developer Docs */ new VersionedDocumentRootConfig({ diff --git a/docs/developer-docs/5.28.x/core-development-concepts/scaffolding/react-application.mdx b/docs/developer-docs/5.28.x/core-development-concepts/scaffolding/react-application.mdx index 556767825..7be617254 100644 --- a/docs/developer-docs/5.28.x/core-development-concepts/scaffolding/react-application.mdx +++ b/docs/developer-docs/5.28.x/core-development-concepts/scaffolding/react-application.mdx @@ -227,7 +227,7 @@ import { createWatchApp, createBuildApp } from "@webiny/project-utils"; // Exports fundamental watch and build commands. // Need to inject environment variables or link your application with an existing GraphQL API? -// See https://www.webiny.com/docs/{version}/core-development-concepts/scaffolding/full-stack-application/webiny-config. +// See https://www.webiny.com/docs/core-development-concepts/scaffolding/full-stack-application/webiny-config. export default { commands: { async watch(options, context) { diff --git a/docs/developer-docs/5.28.x/custom-app-tutorial/adding-user-pools/adding-user-pool-and-user-pool-domain.mdx b/docs/developer-docs/5.28.x/custom-app-tutorial/adding-user-pools/adding-user-pool-and-user-pool-domain.mdx index 60475728c..60571f521 100644 --- a/docs/developer-docs/5.28.x/custom-app-tutorial/adding-user-pools/adding-user-pool-and-user-pool-domain.mdx +++ b/docs/developer-docs/5.28.x/custom-app-tutorial/adding-user-pools/adding-user-pool-and-user-pool-domain.mdx @@ -124,7 +124,7 @@ import Cloudfront from "./cloudfront"; const DEBUG = String(process.env.DEBUG); // Enables logs forwarding. -// https://www.webiny.com/docs/{version}/core-development-concepts/basics/watch-command#enabling-logs-forwarding +// https://www.webiny.com/docs/core-development-concepts/basics/watch-command#enabling-logs-forwarding const WEBINY_LOGS_FORWARD_URL = String(process.env.WEBINY_LOGS_FORWARD_URL); export default () => { diff --git a/docs/developer-docs/5.28.x/custom-app-tutorial/securing-graphql-api/initial-setup.mdx b/docs/developer-docs/5.28.x/custom-app-tutorial/securing-graphql-api/initial-setup.mdx index 165e13065..ffdcdc68b 100644 --- a/docs/developer-docs/5.28.x/custom-app-tutorial/securing-graphql-api/initial-setup.mdx +++ b/docs/developer-docs/5.28.x/custom-app-tutorial/securing-graphql-api/initial-setup.mdx @@ -73,7 +73,7 @@ import Cognito from "./cognito"; import S3 from "./s3"; // Among other things, this determines the amount of information we reveal on runtime errors. -// https://www.webiny.com/docs/{version}/core-development-concepts/environment-variables/#debug-environment-variable +// https://www.webiny.com/docs/core-development-concepts/environment-variables/#debug-environment-variable const DEBUG = String(process.env.DEBUG); // Enables logs forwarding. diff --git a/docs/developer-docs/5.28.x/get-started/install-webiny.mdx b/docs/developer-docs/5.28.x/get-started/install-webiny.mdx index 7550025bb..049740a6f 100644 --- a/docs/developer-docs/5.28.x/get-started/install-webiny.mdx +++ b/docs/developer-docs/5.28.x/get-started/install-webiny.mdx @@ -27,7 +27,7 @@ Before proceeding, make sure you have the following: - Webiny works with both yarn versions [1 (classic)](https://yarnpkg.com/en/docs/install) and [>=2 (berry)](https://yarnpkg.com/) - for version 1 - **1.22.0** or later is required 3. **AWS account and user credentials** - - in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/{version}/infrastructure/aws/configure-aws-credentials) set up on your system + - in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/infrastructure/aws/configure-aws-credentials) set up on your system ## Project Setup diff --git a/docs/developer-docs/5.28.x/infrastructure/basics/environments.mdx b/docs/developer-docs/5.28.x/infrastructure/basics/environments.mdx index ba0cd3270..2f31c9fd1 100644 --- a/docs/developer-docs/5.28.x/infrastructure/basics/environments.mdx +++ b/docs/developer-docs/5.28.x/infrastructure/basics/environments.mdx @@ -67,6 +67,6 @@ In certain cases, this might be reasonable. For example, you can reduce developm -Depending on the environment, the **API** project application is deployed as two different sets of cloud infrastructure resources - development and production. Visit the [API Overview - Default VPC](/docs/{version}/architecture/deployment-modes/development) key topic to learn more. +Depending on the environment, the **API** project application is deployed as two different sets of cloud infrastructure resources - development and production. Visit the [API Overview - Default VPC](/docs/architecture/deployment-modes/development) key topic to learn more. diff --git a/docs/developer-docs/5.28.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx b/docs/developer-docs/5.28.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx index 294945626..eea2919a5 100644 --- a/docs/developer-docs/5.28.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx +++ b/docs/developer-docs/5.28.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx @@ -174,7 +174,7 @@ Currently, Webiny is not using the [Automation API](https://www.pulumi.com/blog/ Switching to a different infrastructure-as-code (IaC) solution would require a significant amount of work as it would involve rewriting almost all of the Webiny IaC code from scratch for a different IaC solution. **Therefore, we do not recommend it.** However, if you want to experiment with it, you would need to create a custom CLI plugin similar to the [Webiny CLI plugin for Pulumi](https://github.com/webiny/webiny-js/tree/next/packages/cli-plugin-deploy-pulumi). This plugin is responsible for creating the deploy, destroy, watch, and other commands. -To use your custom plugin, you would then need to import it into the `webiny.project.ts` file and remove the Pulumi plugin. The most challenging part would be transforming all of the Pulumi code into respective IaC code (i.e. transforming all Pulumi code to [CloudFormation](https://aws.amazon.com/cloudformation/), [Terraform](https://www.terraform.io/), or other IaC). You can refer to the Pulumi code to see the resources Webiny deploys and the [Cloud Infrastructure documentation](https://www.webiny.com/docs/{version}/architecture/introduction) for more information. +To use your custom plugin, you would then need to import it into the `webiny.project.ts` file and remove the Pulumi plugin. The most challenging part would be transforming all of the Pulumi code into respective IaC code (i.e. transforming all Pulumi code to [CloudFormation](https://aws.amazon.com/cloudformation/), [Terraform](https://www.terraform.io/), or other IaC). You can refer to the Pulumi code to see the resources Webiny deploys and the [Cloud Infrastructure documentation](https://www.webiny.com/docs/architecture/introduction) for more information. **Please keep in mind that this process will require a significant amount of effort, and it's recommended to stick with Pulumi unless your organization has strict policies that require using a different IaC solution.** diff --git a/docs/developer-docs/5.29.x/admin-area/new-app-tutorial/scaffolding.mdx b/docs/developer-docs/5.29.x/admin-area/new-app-tutorial/scaffolding.mdx index cbf6a76ca..693ffae43 100644 --- a/docs/developer-docs/5.29.x/admin-area/new-app-tutorial/scaffolding.mdx +++ b/docs/developer-docs/5.29.x/admin-area/new-app-tutorial/scaffolding.mdx @@ -28,7 +28,7 @@ Note that, when we say GraphQL HTTP API, by default, we're referring to the one -Learn more about the **API** project application on the cloud infrastructure level in the [Cloud Infrastructure](/docs/{version}/architecture/introduction) key topics section. +Learn more about the **API** project application on the cloud infrastructure level in the [Cloud Infrastructure](/docs/architecture/introduction) key topics section. diff --git a/docs/developer-docs/5.29.x/core-development-concepts/scaffolding/extend-graphql-api.mdx b/docs/developer-docs/5.29.x/core-development-concepts/scaffolding/extend-graphql-api.mdx index 9c4e14ab8..7758a334a 100644 --- a/docs/developer-docs/5.29.x/core-development-concepts/scaffolding/extend-graphql-api.mdx +++ b/docs/developer-docs/5.29.x/core-development-concepts/scaffolding/extend-graphql-api.mdx @@ -223,7 +223,7 @@ You are free to create new tests in the similar fashion, or amend the existing o Please note that, by default, the authentication and authorization logic isn't included in the generated code. In other words, all of the generated GraphQL query and mutation operations can be performed by anonymous (not logged-in) users, which is in most cases not the desired behavior. -Luckily, with a couple of built-in utilities, this can be relatively easily added. Please check out the [existing tutorials](/docs/{version}/admin-area/new-app-tutorial/security) to learn how to implement these on your own. +Luckily, with a couple of built-in utilities, this can be relatively easily added. Please check out the [existing tutorials](/docs/admin-area/new-app-tutorial/security) to learn how to implement these on your own. ### I need more flexibility when it comes to data querying. Can I bring in a different database, for example ElasticSearch? diff --git a/docs/developer-docs/5.29.x/infrastructure/basics/modify-cloud-infrastructure.mdx b/docs/developer-docs/5.29.x/infrastructure/basics/modify-cloud-infrastructure.mdx index 0db0f0116..9b6a5c1bd 100644 --- a/docs/developer-docs/5.29.x/infrastructure/basics/modify-cloud-infrastructure.mdx +++ b/docs/developer-docs/5.29.x/infrastructure/basics/modify-cloud-infrastructure.mdx @@ -197,7 +197,7 @@ export default createCoreApp({ ### Defining Multiple Production Environments -Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/{version}/architecture/deployment-modes/production). +Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/architecture/deployment-modes/production). On order to use the production deployment mode for environments other than `prod`, we can use the `productionEnvironments` parameter. The following example shows how we can use the production mode for the `staging` environment: diff --git a/docs/developer-docs/5.30.x/wcp/link-a-project.mdx b/docs/developer-docs/5.30.x/wcp/link-a-project.mdx index b8947994c..d6c1dcc37 100644 --- a/docs/developer-docs/5.30.x/wcp/link-a-project.mdx +++ b/docs/developer-docs/5.30.x/wcp/link-a-project.mdx @@ -84,7 +84,7 @@ And all it's left to do is to select a project from the list. **Note**: if you h ![WCP - Link project inside personal development environment - Step 4](./assets/link-a-project/link-personal-step4.png) -Once you select your project, you are pretty much done, all you need to do, is to [deploy it](/docs/{version}/core-development-concepts/basics/project-deployment). +Once you select your project, you are pretty much done, all you need to do, is to [deploy it](/docs/core-development-concepts/basics/project-deployment). diff --git a/docs/developer-docs/5.30.x/wcp/overview.mdx b/docs/developer-docs/5.30.x/wcp/overview.mdx index 6be36e6d8..3cadad8b2 100644 --- a/docs/developer-docs/5.30.x/wcp/overview.mdx +++ b/docs/developer-docs/5.30.x/wcp/overview.mdx @@ -70,7 +70,7 @@ A WCP user with an access to a specific WCP project can retrieve the license for -To learn how to retrieve a license inside your own personal development environment, [check this guide](/docs/{version}/wcp/link-a-project#personal-development-environment). +To learn how to retrieve a license inside your own personal development environment, [check this guide](/docs/wcp/link-a-project#personal-development-environment). @@ -86,7 +86,7 @@ Every WCP project you create will have a CI/CD environment called `production` b -To learn how to retrieve a license inside CI/CD environment, [check this guide](/docs/{version}/wcp/link-a-project#ci-cd-environment). +To learn how to retrieve a license inside CI/CD environment, [check this guide](/docs/wcp/link-a-project#ci-cd-environment). diff --git a/docs/developer-docs/5.33.x/headless-cms/extending/content-models-via-code.mdx b/docs/developer-docs/5.33.x/headless-cms/extending/content-models-via-code.mdx index 075f87811..ec421b422 100644 --- a/docs/developer-docs/5.33.x/headless-cms/extending/content-models-via-code.mdx +++ b/docs/developer-docs/5.33.x/headless-cms/extending/content-models-via-code.mdx @@ -41,7 +41,7 @@ In the following sections, we cover a couple of examples that show how to define Note that we **NEVER** set the `storageId` property value as it is created automatically out of the field `id` and `type` property values. -To find out more about the `storageId` property, and understand why it exists, please read [this](/docs/{version}/headless-cms/extending/content-models-via-code-storage-id) article. +To find out more about the `storageId` property, and understand why it exists, please read [this](/docs/headless-cms/extending/content-models-via-code-storage-id) article. @@ -151,7 +151,7 @@ Once plugins are registered successfully, we should be able to see the following -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. @@ -263,7 +263,7 @@ export default [ ] ``` -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. And you should be able to see the following Product model. diff --git a/docs/developer-docs/5.34.x/core-development-concepts/development/local-development.mdx b/docs/developer-docs/5.34.x/core-development-concepts/development/local-development.mdx index 2ffeee449..8a84b25d6 100644 --- a/docs/developer-docs/5.34.x/core-development-concepts/development/local-development.mdx +++ b/docs/developer-docs/5.34.x/core-development-concepts/development/local-development.mdx @@ -25,7 +25,7 @@ To do local development in Webiny, the API or any infrastructure changes must be In summary, changes made to API and infrastructure must be deployed to the cloud during local development. However, for changes made to only UI, deploying to the cloud is not necessary. Once the UI changes are finalised, these changes can be pushed to the cloud. If you're wondering how to push changes to the cloud during development, don't worry. As previously mentioned, we have developed various CLI tools, such as the `watch` command, to make deploying changes to the cloud during development easy. The `watch` command allows you to continuously rebuild and redeploy your code, making the development process seamless. -For detailed information, please refer to the [`watch command`](/docs/{version}/core-development-concepts/basics/watch-command) documentation. +For detailed information, please refer to the [`watch command`](/docs/core-development-concepts/basics/watch-command) documentation. Now let's learn more about local development with the frequently asked questions related to Webiny development. diff --git a/docs/developer-docs/5.34.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx b/docs/developer-docs/5.34.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx index 2bc2699aa..aa1a948f1 100644 --- a/docs/developer-docs/5.34.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx +++ b/docs/developer-docs/5.34.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx @@ -15,7 +15,7 @@ import { Alert } from "@/components/Alert"; ## Introduction -In the `5.34.0` version we added a possibility for users to modify our `Fastify` handler instance, via the `ModifyFastifyPlugin`. To find our more on how and why we use `Fastify`, please read this [article](/docs/{version}/core-development-concepts/basics/routes-and-events). +In the `5.34.0` version we added a possibility for users to modify our `Fastify` handler instance, via the `ModifyFastifyPlugin`. To find our more on how and why we use `Fastify`, please read this [article](/docs/core-development-concepts/basics/routes-and-events). With the given plugin user can change and add anything to the `Fastify` instance, including the error handler. diff --git a/docs/developer-docs/5.34.x/enterprise/use-existing-amazon-vpc.mdx b/docs/developer-docs/5.34.x/enterprise/use-existing-amazon-vpc.mdx index f1d506467..161cc6ebf 100644 --- a/docs/developer-docs/5.34.x/enterprise/use-existing-amazon-vpc.mdx +++ b/docs/developer-docs/5.34.x/enterprise/use-existing-amazon-vpc.mdx @@ -89,10 +89,10 @@ Note that, if the Webiny project is being deployed into the production environme -Production deployment means deploying your Webiny project into `prod` environment, via the [`webiny deploy`](https://www.webiny.com/docs/{version}/core-development-concepts/basics/project-deployment) command: `yarn webiny deploy --env prod`. +Production deployment means deploying your Webiny project into `prod` environment, via the [`webiny deploy`](https://www.webiny.com/docs/core-development-concepts/basics/project-deployment) command: `yarn webiny deploy --env prod`. More on the development and production modes can be found here: -[https://www.webiny.com/docs/{version}/architecture/deployment-modes/introduction](https://www.webiny.com/docs/{version}/architecture/deployment-modes/introduction) +[https://www.webiny.com/docs/architecture/deployment-modes/introduction](https://www.webiny.com/docs/architecture/deployment-modes/introduction) @@ -196,7 +196,7 @@ Note that for a Webiny project to work as expected, an Amazon VPC must have an [ 1. **Amazon Cognito** - Webiny's application code interacts with Amazon Cognito via AWS SDK. May not be needed if the organization doesn't plan to rely on Amazon Cognito as their identity provider. 2. **Amazon CloudFront** - Webiny's application code interacts with Amazon CloudFront via AWS SDK -3. **Webiny Control Panel (WCP)** - [Webiny Control Panel (WCP)](/docs/{version}/wcpoverview)-linked Webiny projects also frequently interact with app's public HTTP API (`api.webiny.com`) +3. **Webiny Control Panel (WCP)** - [Webiny Control Panel (WCP)](/docs/wcp/overview)-linked Webiny projects also frequently interact with app's public HTTP API (`api.webiny.com`) 4. **Webiny's Prerendering Service** - for website performance reasons, whenever a user publishes a page created with Webiny’s Page Builder application, behind the scenes, an AWS Lambda function is triggered, which issues HTTP requests to published page’s URL (a public CloudFront URL). May not be needed if the organization doesn't plan to use the Page Builder application. ### VPC Endpoints diff --git a/docs/developer-docs/5.34.x/headless-cms/basics/using-graphql-api-filtering.mdx b/docs/developer-docs/5.34.x/headless-cms/basics/using-graphql-api-filtering.mdx index a459ca6c1..91d991f79 100644 --- a/docs/developer-docs/5.34.x/headless-cms/basics/using-graphql-api-filtering.mdx +++ b/docs/developer-docs/5.34.x/headless-cms/basics/using-graphql-api-filtering.mdx @@ -249,4 +249,4 @@ query { ## Conditional Filtering -The article [`Using the GraphQL API Advanced Filtering`](/docs/{version}/headless-cms/basics/using-graphql-api-advanced-filtering) will cover the conditional (advanced) filtering, where we will show you how to use the `AND` and `OR` conditionals. +The article [`Using the GraphQL API Advanced Filtering`](/docs/headless-cms/basics/using-graphql-api-advanced-filtering) will cover the conditional (advanced) filtering, where we will show you how to use the `AND` and `OR` conditionals. diff --git a/docs/developer-docs/5.35.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx b/docs/developer-docs/5.35.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx index 88cda93c2..5702c6b01 100644 --- a/docs/developer-docs/5.35.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx +++ b/docs/developer-docs/5.35.x/core-development-concepts/extending-and-customizing/customizing-the-error-output.mdx @@ -15,7 +15,7 @@ import { Alert } from "@/components/Alert"; ## Introduction -In the `5.34.0` version we added a possibility for users to modify our `Fastify` handler instance, via the `ModifyFastifyPlugin`. To find our more on how and why we use `Fastify`, please read this [article](/docs/{version}/core-development-concepts/basics/routes-and-events). +In the `5.34.0` version we added a possibility for users to modify our `Fastify` handler instance, via the `ModifyFastifyPlugin`. To find our more on how and why we use `Fastify`, please read this [article](/docs/core-development-concepts/basics/routes-and-events). With the given plugin user can change and add anything to the `Fastify` instance, including the error handler. diff --git a/docs/developer-docs/5.35.x/headless-cms/basics/using-graphql-api-filtering.mdx b/docs/developer-docs/5.35.x/headless-cms/basics/using-graphql-api-filtering.mdx index a459ca6c1..91d991f79 100644 --- a/docs/developer-docs/5.35.x/headless-cms/basics/using-graphql-api-filtering.mdx +++ b/docs/developer-docs/5.35.x/headless-cms/basics/using-graphql-api-filtering.mdx @@ -249,4 +249,4 @@ query { ## Conditional Filtering -The article [`Using the GraphQL API Advanced Filtering`](/docs/{version}/headless-cms/basics/using-graphql-api-advanced-filtering) will cover the conditional (advanced) filtering, where we will show you how to use the `AND` and `OR` conditionals. +The article [`Using the GraphQL API Advanced Filtering`](/docs/headless-cms/basics/using-graphql-api-advanced-filtering) will cover the conditional (advanced) filtering, where we will show you how to use the `AND` and `OR` conditionals. diff --git a/docs/developer-docs/5.35.x/headless-cms/extending/content-models-via-code.mdx b/docs/developer-docs/5.35.x/headless-cms/extending/content-models-via-code.mdx index 0c00faa5c..8c0a91954 100644 --- a/docs/developer-docs/5.35.x/headless-cms/extending/content-models-via-code.mdx +++ b/docs/developer-docs/5.35.x/headless-cms/extending/content-models-via-code.mdx @@ -41,7 +41,7 @@ In the following sections, we cover a couple of examples that show how to define Note that we **NEVER** set the `storageId` property value as it is created automatically out of the field `id` and `type` property values. -To find out more about the `storageId` property, and understand why it exists, please read [this](/docs/{version}/headless-cms/extending/content-models-via-code-storage-id) article. +To find out more about the `storageId` property, and understand why it exists, please read [this](/docs/headless-cms/extending/content-models-via-code-storage-id) article. @@ -151,7 +151,7 @@ Once plugins are registered successfully, we should be able to see the following -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. @@ -263,7 +263,7 @@ export default [ ] ``` -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. And you should be able to see the following Product model. @@ -388,7 +388,7 @@ renderer: { (...) ``` -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. And you should be able to see the following Product Review model. diff --git a/docs/developer-docs/5.36.x/infrastructure/basics/modify-cloud-infrastructure.mdx b/docs/developer-docs/5.36.x/infrastructure/basics/modify-cloud-infrastructure.mdx index a15073364..d1df19beb 100644 --- a/docs/developer-docs/5.36.x/infrastructure/basics/modify-cloud-infrastructure.mdx +++ b/docs/developer-docs/5.36.x/infrastructure/basics/modify-cloud-infrastructure.mdx @@ -197,7 +197,7 @@ export default createCoreApp({ ### Defining Multiple Production Environments -Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/{version}/architecture/deployment-modes/production). +Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/architecture/deployment-modes/production). On order to use the production deployment mode for environments other than `prod`, we can use the `productionEnvironments` parameter. The following example shows how we can use the production mode for the `staging` environment: diff --git a/docs/developer-docs/5.37.x/enterprise/teams.mdx b/docs/developer-docs/5.37.x/enterprise/teams.mdx index 4d5ea3774..de670a193 100644 --- a/docs/developer-docs/5.37.x/enterprise/teams.mdx +++ b/docs/developer-docs/5.37.x/enterprise/teams.mdx @@ -32,7 +32,7 @@ Trying to select **Custom Access** will result in an alert message being shown, -To upgrade to **Business** tier, users [link their project](/docs/{version}/wcplink-a-project) with [Webiny Control Panel (WCP)](/docs/{version}/wcpoverview), from where they can activate the Advanced Access Control Layer (AACL) for their project. By doing this, users will be able to define fine-grained permissions for individual Webiny apps. +To upgrade to **Business** tier, users [link their project](/docs/wcp/link-a-project) with [Webiny Control Panel (WCP)](/docs/wcp/overview), from where they can activate the Advanced Access Control Layer (AACL) for their project. By doing this, users will be able to define fine-grained permissions for individual Webiny apps. { Under the hood, filters are handled via a regular form component: this means we can hook into the form to set new filter values. We're using the `useBind` hook and give it a name. This `name` will become a key within the form data object, which will be passed to the GraphQL query. To unset a filter, we set `undefined`. -You can write any filtering logic based on [Headless CMS's built-in GraphQL API filtering](/docs/{version}/headless-cms/basics/using-graphql-api-advanced-filtering). +You can write any filtering logic based on [Headless CMS's built-in GraphQL API filtering](/docs/headless-cms/basics/using-graphql-api-advanced-filtering). diff --git a/docs/developer-docs/5.38.x/enterprise/aacl/teams.mdx b/docs/developer-docs/5.38.x/enterprise/aacl/teams.mdx index 30943c043..049556599 100644 --- a/docs/developer-docs/5.38.x/enterprise/aacl/teams.mdx +++ b/docs/developer-docs/5.38.x/enterprise/aacl/teams.mdx @@ -35,7 +35,7 @@ This feature is especially useful for larger organizations, where it's common to ## Enabling Teams and Feature Overview -For Webiny Enterprise users, apart from [linking their Webiny project](/docs/{version}/wcp/link-a-project) with Webiny Control Panel (WCP), there are no additional steps required to enable Teams. +For Webiny Enterprise users, apart from [linking their Webiny project](/docs/wcp/link-a-project) with Webiny Control Panel (WCP), there are no additional steps required to enable Teams. Once linked, Teams will be automatically enabled and the module can be accessed from the main menu: diff --git a/docs/developer-docs/5.38.x/get-started/install-webiny.mdx b/docs/developer-docs/5.38.x/get-started/install-webiny.mdx index 62c53c74f..feabdab17 100644 --- a/docs/developer-docs/5.38.x/get-started/install-webiny.mdx +++ b/docs/developer-docs/5.38.x/get-started/install-webiny.mdx @@ -27,7 +27,7 @@ Before proceeding, make sure you have the following: - Webiny works with both yarn versions [1 (classic)](https://yarnpkg.com/en/docs/install) and [>=2 (berry)](https://yarnpkg.com/) - for version 1 - **1.22.21** or later is required 3. **AWS account and user credentials** - - in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/{version}/infrastructure/aws/configure-aws-credentials) set up on your system + - in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/infrastructure/aws/configure-aws-credentials) set up on your system ## Project Setup diff --git a/docs/developer-docs/5.39.x/admin-area/extending/environment-variables.mdx b/docs/developer-docs/5.39.x/admin-area/extending/environment-variables.mdx index eac5a7fce..869e45521 100644 --- a/docs/developer-docs/5.39.x/admin-area/extending/environment-variables.mdx +++ b/docs/developer-docs/5.39.x/admin-area/extending/environment-variables.mdx @@ -19,7 +19,7 @@ import { WhatYouWillLearn } from "@/components/WhatYouWillLearn"; Admin app relies on several environment variables that get injected into React apps at build time using Pulumi state files. Sometimes, you might want to inject new variables, relevant to your project, and in this article we show you how to do just that. -Note that the naming convention for environment variables is explained in a dedicated article on [Environment Variables](/docs/{version}/core-development-concepts/basics/environment-variables). +Note that the naming convention for environment variables is explained in a dedicated article on [Environment Variables](/docs/core-development-concepts/basics/environment-variables). ## Inject Variables from Pulumi State diff --git a/docs/developer-docs/5.39.x/architecture/api/overview.mdx b/docs/developer-docs/5.39.x/architecture/api/overview.mdx index c3953f16a..8175024e2 100644 --- a/docs/developer-docs/5.39.x/architecture/api/overview.mdx +++ b/docs/developer-docs/5.39.x/architecture/api/overview.mdx @@ -102,7 +102,7 @@ For background tasks (jobs)-related requirements, Webiny relies on [AWS Step Fun Note that background tasks are triggered via an Amazon EventBridge event. Amazon EventBridge is deployed as part of the **Core** project application (not shown on the diagram). -For more information on how to create and execute background tasks, check out the [Background Tasks](/docs/{version}/core-development-concepts/background-tasks/about-background-tasks) article. +For more information on how to create and execute background tasks, check out the [Background Tasks](/docs/core-development-concepts/background-tasks/about-background-tasks) article. ## FAQ diff --git a/docs/developer-docs/5.39.x/core-development-concepts/development/local-development.mdx b/docs/developer-docs/5.39.x/core-development-concepts/development/local-development.mdx index 753dc216d..612ac8fa4 100644 --- a/docs/developer-docs/5.39.x/core-development-concepts/development/local-development.mdx +++ b/docs/developer-docs/5.39.x/core-development-concepts/development/local-development.mdx @@ -25,7 +25,7 @@ To do local development in Webiny, the API or any infrastructure changes must be In summary, changes made to API and infrastructure must be deployed to the cloud during local development. However, for changes made to only UI, deploying to the cloud is not necessary. Once the UI changes are finalised, these changes can be pushed to the cloud. -If you're wondering how to push changes to the cloud during development, don't worry. As previously mentioned, we have developed various CLI tools, such as the [`watch command`](/docs/{version}/core-development-concepts/basics/watch-command) command, to make deploying changes to the cloud during development easy. The command allows you to continuously rebuild and redeploy your code, making the development process seamless. +If you're wondering how to push changes to the cloud during development, don't worry. As previously mentioned, we have developed various CLI tools, such as the [`watch command`](/docs/core-development-concepts/basics/watch-command) command, to make deploying changes to the cloud during development easy. The command allows you to continuously rebuild and redeploy your code, making the development process seamless. Now let's learn more about local development with the frequently asked questions related to Webiny development. @@ -43,7 +43,7 @@ With that in mind, we don't recommend using tools like [LocalStack](https://www. ## What is the potential cost associated with using an AWS account for development? -Webiny supports [two database setups](/docs/{version}/architecture/introduction#different-database-setups) at the moment: +Webiny supports [two database setups](/docs/architecture/introduction#different-database-setups) at the moment: 1. Amazon DynamoDB 2. Amazon DynamoDB + Amazon OpenSearch @@ -52,7 +52,7 @@ The Amazon DynamoDB database setup fully utilizes serverless services, which mea On the other hand, with the Amazon DynamoDB + Amazon OpenSearch version, [Amazon OpenSearch Service](https://aws.amazon.com/opensearch-service/) is the only non-serverless service used by Webiny, which is not priced on a pay-per-use basis. This means that you will be charged for the time the service is running, regardless of whether you are using it or not. -To mitigate costs, you can have one Amazon OpenSearch Service domain that's used by the entire team. This way, you can share the cost of the service among the team members. For more information on how to set this up, please refer to the [Using a Shared Amazon OpenSearch Service Domain](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure#using-a-shared-amazon-open-search-service-domain) article. +To mitigate costs, you can have one Amazon OpenSearch Service domain that's used by the entire team. This way, you can share the cost of the service among the team members. For more information on how to set this up, please refer to the [Using a Shared Amazon OpenSearch Service Domain](/docs/infrastructure/basics/modify-cloud-infrastructure#using-a-shared-amazon-open-search-service-domain) article. ## Working with team on a Webiny project diff --git a/docs/developer-docs/5.39.x/enterprise/use-existing-amazon-vpc.mdx b/docs/developer-docs/5.39.x/enterprise/use-existing-amazon-vpc.mdx index a8404c82f..64f617cca 100644 --- a/docs/developer-docs/5.39.x/enterprise/use-existing-amazon-vpc.mdx +++ b/docs/developer-docs/5.39.x/enterprise/use-existing-amazon-vpc.mdx @@ -91,10 +91,10 @@ Note that, if the Webiny project is being deployed into the production environme -Production deployment means deploying your Webiny project into `prod` environment, via the [`webiny deploy`](https://www.webiny.com/docs/{version}/core-development-concepts/basics/project-deployment) command: `yarn webiny deploy --env prod`. +Production deployment means deploying your Webiny project into `prod` environment, via the [`webiny deploy`](https://www.webiny.com/docs/core-development-concepts/basics/project-deployment) command: `yarn webiny deploy --env prod`. More on the development and production modes can be found here: -[https://www.webiny.com/docs/{version}/architecture/deployment-modes/introduction](https://www.webiny.com/docs/{version}/architecture/deployment-modes/introduction) +[https://www.webiny.com/docs/architecture/deployment-modes/introduction](https://www.webiny.com/docs/architecture/deployment-modes/introduction) @@ -198,7 +198,7 @@ Note that for a Webiny project to work as expected, an Amazon VPC must have an [ 1. **Amazon Cognito** - Webiny's application code interacts with Amazon Cognito via AWS SDK. May not be needed if the organization doesn't plan to rely on Amazon Cognito as their identity provider. 2. **Amazon CloudFront** - Webiny's application code interacts with Amazon CloudFront via AWS SDK -3. **Webiny Control Panel (WCP)** - Webiny Control Panel (WCP)-linked Webiny projects also frequently interact with app's public HTTP API (`api.webiny.com`) +3. **Webiny Control Panel (WCP)** - [Webiny Control Panel (WCP)](/docs/wcp/overview)-linked Webiny projects also frequently interact with app's public HTTP API (`api.webiny.com`) 4. **Webiny's Prerendering Service** - for website performance reasons, whenever a user publishes a page created with Webiny’s Page Builder application, behind the scenes, an AWS Lambda function is triggered, which issues HTTP requests to published page’s URL (a public CloudFront URL). May not be needed if the organization doesn't plan to use the Page Builder application. ### VPC Endpoints diff --git a/docs/developer-docs/5.39.x/get-started/install-webiny.mdx b/docs/developer-docs/5.39.x/get-started/install-webiny.mdx index 7217b97ac..0e01de93d 100644 --- a/docs/developer-docs/5.39.x/get-started/install-webiny.mdx +++ b/docs/developer-docs/5.39.x/get-started/install-webiny.mdx @@ -31,7 +31,7 @@ Before proceeding, make sure you have the following: 3. **AWS account and user credentials** -- in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/{version}/infrastructure/aws/configure-aws-credentials) set up on your system +- in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/infrastructure/aws/configure-aws-credentials) set up on your system ## Project Setup @@ -133,4 +133,4 @@ To install Webiny, you will need a basic understanding of Node, Yarn, JavaScript ### Which AWS regions are supported by Webiny? -Webiny supports all AWS regions except the China regions (Beijing and Ningxia) because Webiny relies on Amazon CloudFront and Amazon Cognito services, which are not available in [Beijing and Ningxia regions](https://www.amazonaws.cn/en/about-aws/regional-product-services/) respectively. +Webiny supports all AWS regions except the China regions (Beijing and Ningxia) because Webiny relies on Amazon CloudFront and Amazon Cognito services, which are not available in [Beijing and Ningxia regions](https://www.amazonaws.cn/en/about-aws/regional-product-services/) respectively. \ No newline at end of file diff --git a/docs/developer-docs/5.39.x/get-started/welcome.mdx b/docs/developer-docs/5.39.x/get-started/welcome.mdx index e5239d076..b8e8ad877 100644 --- a/docs/developer-docs/5.39.x/get-started/welcome.mdx +++ b/docs/developer-docs/5.39.x/get-started/welcome.mdx @@ -86,7 +86,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun categoryTitle="Products" /> - +

Learn how to create plugins and customize the Headless CMS experience to your content needs. From extending the built-in GraphQL capabilities to modifying the editorial experience.

@@ -108,7 +108,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun In this section, you'll learn how to customize the layout and visual aspects of your forms.

- +

The Admin Area is an app inside which all other apps live. You can white-label the UI to match the brand of your customer, introduce new apps into the menu, modify the start page, and more.

@@ -130,7 +130,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun For developers just getting started with Webiny, we've prepared a short onboarding video course to help you take your first step in development with Webiny.

- +

Once you're past the basics of how to develop with Webiny, this category of articles is a good next step.

@@ -138,24 +138,24 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun You'll learn about the core concepts such as the watch command, project organization, the CLI utility and more.

- +

Learn how to extend the GraphQL API, CLI utility, add custom routes to the Lambda function, intercept requests or customize the built-in Lexical editor.

- +

If you need to configure and deploy Webiny from a CI/CD environment, follow this guide.

- +

Webiny has a simple, but powerful security framework that allows you to integrate with different SSO systems as well as customize the authentication and authorization flows.

- +

Webiny supports long-running tasks that are executed in the background. In this set of articles, you'll learn how to leverage this mechanism inside your own custom plugins and apps built inside Webiny.

@@ -172,7 +172,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun categoryTitle="Resources" /> - +

Guides to help non-technical users master Webiny and many of its features.

diff --git a/docs/developer-docs/5.39.x/headless-cms/extending/content-models-via-code.mdx b/docs/developer-docs/5.39.x/headless-cms/extending/content-models-via-code.mdx index 7046625f5..60cfede45 100644 --- a/docs/developer-docs/5.39.x/headless-cms/extending/content-models-via-code.mdx +++ b/docs/developer-docs/5.39.x/headless-cms/extending/content-models-via-code.mdx @@ -42,7 +42,7 @@ In the following sections, we cover a couple of examples that show how to define Note that we **NEVER** set the `storageId` property value as it is created automatically out of the field `id` and `type` property values. -To find out more about the `storageId` property, and understand why it exists, please read [this](/docs/{version}/headless-cms/extending/content-models-via-code-storage-id) article. +To find out more about the `storageId` property, and understand why it exists, please read [this](/docs/headless-cms/extending/content-models-via-code-storage-id) article. @@ -152,7 +152,7 @@ Once plugins are registered successfully, we should be able to see the following -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. @@ -264,7 +264,7 @@ export default [ ] ``` -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. And you should be able to see the following Product model. @@ -389,7 +389,7 @@ renderer: { (...) ``` -With the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command up and running, +With the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command up and running, the performed application code changes should be automatically rebuilt and redeployed into the cloud. And you should be able to see the following Product Review model. @@ -401,7 +401,7 @@ With this [5.39.2 release](/docs/release-notes/5.39.2/changelog#content-models-d Security Permissions Defined via the Security Application -Additionally, in case the [Folder Level Permissions](/docs/{version}/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. +Additionally, in case the [Folder Level Permissions](/docs/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. The following example demonstrates how to disable authorization for a content model and its entries. @@ -456,7 +456,7 @@ new CmsModelPlugin({ }); ``` -With the `authorization` property set to `false`, base authorization checks are disabled for the content model and its entries. Furthermore, in case the [Folder Level Permissions](/docs/{version}/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. +With the `authorization` property set to `false`, base authorization checks are disabled for the content model and its entries. Furthermore, in case the [Folder Level Permissions](/docs/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. ### Define a Content Model Only for a Specific Locale diff --git a/docs/developer-docs/5.39.x/headless-cms/extending/lexical-editor.mdx b/docs/developer-docs/5.39.x/headless-cms/extending/lexical-editor.mdx index 393841872..c4c108f98 100644 --- a/docs/developer-docs/5.39.x/headless-cms/extending/lexical-editor.mdx +++ b/docs/developer-docs/5.39.x/headless-cms/extending/lexical-editor.mdx @@ -22,7 +22,7 @@ In this article, we'll cover the Lexical Editor configuration for the Headless C ### Toolbar -Headless CMS uses a static toolbar, which is always visible. Webiny ships with a set of default actions, but you can add new actions, replace existing actions, or remove them completely. +Headless CMS uses a static toolbar, which is always visible, unlike the [Page Builder](/docs/page-builder/extending/lexical-editor), which uses a floating toolbar. Webiny ships with a set of default actions, but you can add new actions, replace existing actions, or remove them completely. diff --git a/docs/developer-docs/5.39.x/headless-cms/extending/private-models.mdx b/docs/developer-docs/5.39.x/headless-cms/extending/private-models.mdx index f2292c71d..f5dc87259 100644 --- a/docs/developer-docs/5.39.x/headless-cms/extending/private-models.mdx +++ b/docs/developer-docs/5.39.x/headless-cms/extending/private-models.mdx @@ -32,7 +32,7 @@ Let's delve into the details of both public and private models and explore how y Public models in Webiny are those content models that are visible within the admin app. These models come with a generated navigation menu, allowing easy access to content entries through the user interface. Creating public models involves the conventional process of logging into the admin app and using the user interface to create a content model or you can also define public content model via code. The result is the automatic generation of an API, including a GraphQL type and a set of resolvers for seamless data interaction. -Alternatively, you can also build public models through code using a [plugin](/docs/{version}/headless-cms/extending/content-models-via-code-storage-id). +Alternatively, you can also build public models through code using a [plugin](/docs/headless-cms/extending/content-models-via-code-storage-id). ## Private Models Private models, in contrast, remain hidden from the admin app UI. These models are defined programmatically through a plugin. While the schema and resolvers aren't auto-generated, developers have the freedom to design them on the backend or API. diff --git a/docs/developer-docs/5.39.x/headless-cms/overview.mdx b/docs/developer-docs/5.39.x/headless-cms/overview.mdx index 9a09a7c8e..5feba1f28 100644 --- a/docs/developer-docs/5.39.x/headless-cms/overview.mdx +++ b/docs/developer-docs/5.39.x/headless-cms/overview.mdx @@ -25,17 +25,17 @@ Below you'll find a few core articles that we recommend every engineer to go thr /> - +

Learn what is the Headless CMS GraphQL API, what are its main characteristics, and how to access it.

- +

Learn how to use the Headless CMS's built-in GraphQL API.

- +

Learn how to use the Headless CMS's built-in GraphQL API advanced filter.

@@ -52,17 +52,17 @@ Below you'll find a few core articles that we recommend every engineer to go thr /> - +

Learn how to extend the Headless CMS-related GraphQL types and operations.

- +

Learn how to define content models and content model groups through code.

- +

Learn how to add, replace, or remove columns in the Entry List Table.

@@ -79,17 +79,17 @@ Below you'll find a few core articles that we recommend every engineer to go thr /> - +

Learn how to build a frontend for Webiny Headless CMS with NextJS

- +

Learn about Headless CMS lifecycle events, how they work and how to subscribe to a lifecycle event.

- +

Learn about the date/time and identity-related meta fields that are available for content entries.

diff --git a/docs/developer-docs/5.39.x/headless-cms/references/date-time-and-identity-meta-fields.mdx b/docs/developer-docs/5.39.x/headless-cms/references/date-time-and-identity-meta-fields.mdx index 8c062009c..30c4a327f 100644 --- a/docs/developer-docs/5.39.x/headless-cms/references/date-time-and-identity-meta-fields.mdx +++ b/docs/developer-docs/5.39.x/headless-cms/references/date-time-and-identity-meta-fields.mdx @@ -23,7 +23,7 @@ Apart from the fields that are defined in a content model by the user, all conte These meta fields are automatically populated by the system, and they can be used to display information about the entry, such as when it was created, modified, or published, and by whom. -Developers can use these fields when querying entries, for example via the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api): +Developers can use these fields when querying entries, for example via the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api): ```graphql query { @@ -49,7 +49,7 @@ query { } ``` -They can also use them in their custom JavaScript (TypeScript) code, for example, when hooking onto [lifecycle events](/docs/{version}/headless-cms/references/lifecycle-events): +They can also use them in their custom JavaScript (TypeScript) code, for example, when hooking onto [lifecycle events](/docs/headless-cms/references/lifecycle-events): ```typescript new ContextPlugin(async context => { diff --git a/docs/developer-docs/5.39.x/infrastructure/basics/modify-cloud-infrastructure.mdx b/docs/developer-docs/5.39.x/infrastructure/basics/modify-cloud-infrastructure.mdx index f017d86d3..d306ac316 100644 --- a/docs/developer-docs/5.39.x/infrastructure/basics/modify-cloud-infrastructure.mdx +++ b/docs/developer-docs/5.39.x/infrastructure/basics/modify-cloud-infrastructure.mdx @@ -197,7 +197,7 @@ export default createCoreApp({ ### Defining Multiple Production Environments -Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/{version}/architecture/deployment-modes/production). +Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/architecture/deployment-modes/production). On order to use the production deployment mode for environments other than `prod`, we can use the `productionEnvironments` parameter. The following example shows how we can use the production mode for the `staging` environment: diff --git a/docs/developer-docs/5.40.x/admin-area/basics/framework.mdx b/docs/developer-docs/5.40.x/admin-area/basics/framework.mdx index ded21ccc5..e739508bc 100644 --- a/docs/developer-docs/5.40.x/admin-area/basics/framework.mdx +++ b/docs/developer-docs/5.40.x/admin-area/basics/framework.mdx @@ -73,9 +73,9 @@ export const App = () => { }; ``` -The `AddRoute` component is described in the dedicated [Custom Routes](/docs/{version}/admin-area/extending/custom-routes) article. +The `AddRoute` component is described in the dedicated [Custom Routes](/docs/admin-area/extending/custom-routes) article. -The `AddMenu` component is described in the dedicated [Customize Navigation](/docs/{version}/admin-area/extending/customize-navigation) article. +The `AddMenu` component is described in the dedicated [Customize Navigation](/docs/admin-area/extending/customize-navigation) article. Let's see a more advanced example, and demonstrate a real-life example of menus, routes, and permissions: @@ -120,7 +120,7 @@ export const App = () => { - We highly recommend using our [Extensions](/docs/{version}/core-development-concepts/basics/extensions) to organize your code in a scalable and portable manner. + We highly recommend using our [Extensions](/docs/core-development-concepts/basics/extensions) to organize your code in a scalable and portable manner. diff --git a/docs/developer-docs/5.40.x/architecture/api/overview.mdx b/docs/developer-docs/5.40.x/architecture/api/overview.mdx index 7174f7c46..5519d9e5b 100644 --- a/docs/developer-docs/5.40.x/architecture/api/overview.mdx +++ b/docs/developer-docs/5.40.x/architecture/api/overview.mdx @@ -102,7 +102,7 @@ For background tasks (jobs)-related requirements, Webiny relies on [AWS Step Fun Note that background tasks are triggered via an Amazon EventBridge event. Amazon EventBridge is deployed as part of the **Core** project application (not shown on the diagram). -For more information on how to create and execute background tasks, check out the [Background Tasks](/docs/{version}/core-development-concepts/background-tasks/about-background-tasks) article. +For more information on how to create and execute background tasks, check out the [Background Tasks](/docs/core-development-concepts/background-tasks/about-background-tasks) article. ## Additional Information diff --git a/docs/developer-docs/5.40.x/core-development-concepts/basics/extensions.mdx b/docs/developer-docs/5.40.x/core-development-concepts/basics/extensions.mdx index dd36026b8..772708731 100644 --- a/docs/developer-docs/5.40.x/core-development-concepts/basics/extensions.mdx +++ b/docs/developer-docs/5.40.x/core-development-concepts/basics/extensions.mdx @@ -23,7 +23,7 @@ There are a couple of types of extensions in Webiny, but the most common ones ar - **API** - used to extend Webiny's backend functionality (for example its GraphQL API) - **Cloud Infrastructure** - used to extend the cloud infrastructure Webiny deploys -For example, via an Admin extension, we can change the [layout of the dashboard](/docs/{version}/admin-area/extending/custom-dashboard) or [change the logo](/docs/{version}/admin-area/extending/change-logo) that's shown in the header and the main menu. On the other hand, via an API extension, we can introduce new GraphQL queries or mutations, [content models](/docs/{version}/headless-cms/extending/content-models-via-code), or [hook into lifecycle events](/docs/{version}/headless-cms/references/lifecycle-events). +For example, via an Admin extension, we can change the [layout of the dashboard](/docs/admin-area/extending/custom-dashboard) or [change the logo](/docs/admin-area/extending/change-logo) that's shown in the header and the main menu. On the other hand, via an API extension, we can introduce new GraphQL queries or mutations, [content models](/docs/headless-cms/extending/content-models-via-code), or [hook into lifecycle events](/docs/headless-cms/references/lifecycle-events). ## Getting Started @@ -41,7 +41,7 @@ Ultimately, the scaffold creates the base code for the new extension in the `ext - There are a couple of cases where the extension code is placed outside of the `extensions` folder. For example, when [modifying cloud infrastructure](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure), the code is placed in different `webiny.application.ts` files, located in the `apps` folder. + There are a couple of cases where the extension code is placed outside of the `extensions` folder. For example, when [modifying cloud infrastructure](/docs/infrastructure/basics/modify-cloud-infrastructure), the code is placed in different `webiny.application.ts` files, located in the `apps` folder. diff --git a/docs/developer-docs/5.40.x/core-development-concepts/extending-and-customizing/extend-graphql-api.mdx b/docs/developer-docs/5.40.x/core-development-concepts/extending-and-customizing/extend-graphql-api.mdx index 3e9abbf9c..e07442382 100644 --- a/docs/developer-docs/5.40.x/core-development-concepts/extending-and-customizing/extend-graphql-api.mdx +++ b/docs/developer-docs/5.40.x/core-development-concepts/extending-and-customizing/extend-graphql-api.mdx @@ -91,7 +91,7 @@ With this code in place, we should be able to run the following GraphQL query: -The easiest way to test it is by using the [API Playground](https://www.webiny.com/docs/{version}/admin-area/basics/api-playground) in the Admin app: +The easiest way to test it is by using the [API Playground](https://www.webiny.com/docs/admin-area/basics/api-playground) in the Admin app: Testing the listBooks query in the API Playground} /> diff --git a/docs/developer-docs/5.40.x/core-development-concepts/security-framework/api-security.mdx b/docs/developer-docs/5.40.x/core-development-concepts/security-framework/api-security.mdx index 15559ef84..0198f8c66 100644 --- a/docs/developer-docs/5.40.x/core-development-concepts/security-framework/api-security.mdx +++ b/docs/developer-docs/5.40.x/core-development-concepts/security-framework/api-security.mdx @@ -17,7 +17,7 @@ In this article, we cover how Webiny Security Framework (_WSF_ for short) works -This article uses terms like authentication, authorization, identity, and permissions extensively. These terms are described in details in the [Introduction](/docs/{version}/core-development-concepts/security-framework/introduction) article. If you're not familiar with these terms, make sure you read that article first. +This article uses terms like authentication, authorization, identity, and permissions extensively. These terms are described in details in the [Introduction](/docs/core-development-concepts/security-framework/introduction) article. If you're not familiar with these terms, make sure you read that article first. diff --git a/docs/developer-docs/5.40.x/core-development-concepts/security-framework/react-security.mdx b/docs/developer-docs/5.40.x/core-development-concepts/security-framework/react-security.mdx index f8865afad..1e3131857 100644 --- a/docs/developer-docs/5.40.x/core-development-concepts/security-framework/react-security.mdx +++ b/docs/developer-docs/5.40.x/core-development-concepts/security-framework/react-security.mdx @@ -14,7 +14,7 @@ import { Alert } from "@/components/Alert"; -This article is a continuation of the previous two articles about Webiny Security Framework. If you haven't already, please do read the [Introduction](/docs/{version}/core-development-concepts/security-framework/introduction) and [API Security](/docs/{version}/core-development-concepts/security-framework/api-security) articles before continuing. +This article is a continuation of the previous two articles about Webiny Security Framework. If you haven't already, please do read the [Introduction](/docs/core-development-concepts/security-framework/introduction) and [API Security](/docs/core-development-concepts/security-framework/api-security) articles before continuing. @@ -28,7 +28,7 @@ Let's use the following diagram to analyze the order of operations that are goin Once your application has started, it will render a login form (this can be your custom form or the one provided by your IdP's React SDK). A user submits their credentials to the IdP (`1`). If credentials are valid, IdP will return some basic identity information and a JSON Web Token (JWT) (`2`). -Now that you want to communicate with the Webiny API, you will attach that JWT to every request you make (`3`). The Webiny API will then run the authentication process (`4`) described in the [API Security](/docs/{version}/core-development-concepts/security-framework/api-security) article, and verify the JWT (remember, how you implement your authentication plugin is up to you). +Now that you want to communicate with the Webiny API, you will attach that JWT to every request you make (`3`). The Webiny API will then run the authentication process (`4`) described in the [API Security](/docs/core-development-concepts/security-framework/api-security) article, and verify the JWT (remember, how you implement your authentication plugin is up to you). If the identity is valid and is authorized to perform the requested operation, the React application will receive the expected response from the API. diff --git a/docs/developer-docs/5.40.x/enterprise/advanced-tenant-management.mdx b/docs/developer-docs/5.40.x/enterprise/advanced-tenant-management.mdx index 8c75cdd1f..c13d7dfa1 100644 --- a/docs/developer-docs/5.40.x/enterprise/advanced-tenant-management.mdx +++ b/docs/developer-docs/5.40.x/enterprise/advanced-tenant-management.mdx @@ -23,7 +23,7 @@ import customTenantTHeme from "./assets/tenant-management/custom-tenant-theme.pn ## Overview -Out of the box, Webiny provides a very basic module to manage tenants, called Tenant Manager. We've talked about this module in the article on [Multi-Tenancy](/docs/{version}/enterprise/multi-tenancy). This module allows you to create tenants, tag them, and assign custom domains for website routing (assuming you're using our Page Builder to build your website). This works well for managing of a small number of tenants. However, if you need to manage hundreds, or even thousands of tenants, that UI will quickly become unsuitable for the task. +Out of the box, Webiny provides a very basic module to manage tenants, called Tenant Manager. We've talked about this module in the article on [Multi-Tenancy](/docs/enterprise/multi-tenancy). This module allows you to create tenants, tag them, and assign custom domains for website routing (assuming you're using our Page Builder to build your website). This works well for managing of a small number of tenants. However, if you need to manage hundreds, or even thousands of tenants, that UI will quickly become unsuitable for the task. Building a tenant management system to satisfy a wide variety of business use cases is difficult, because every business domain has its own definition of a tenant. In some projects, a tenant would be represented by a "Company", in other projects, tenant would be a "Brand", etc. Webiny allows you to use the tenancy API to closely integrate its tenants (used for data separation), with your business domain, and have a flawless tenant management experience, which follows your business rules. @@ -62,7 +62,7 @@ in the Webiny Examples repository, and only describing the process and the outco ## Tenant Content Model -To begin, we need to [create a content model](https://github.com/webiny/webiny-examples/blob/master/cms-tenant-management/5.40.x/extensions/api/src/companyModel.ts) which represents a business tenant in our system, which we'll use to create the low-level tenants within Webiny. We've created a content model plugin via code, as described in the [Define Content Models via Code](/docs/{version}/headless-cms/extending/content-models-via-code) article. +To begin, we need to [create a content model](https://github.com/webiny/webiny-examples/blob/master/cms-tenant-management/5.40.x/extensions/api/src/companyModel.ts) which represents a business tenant in our system, which we'll use to create the low-level tenants within Webiny. We've created a content model plugin via code, as described in the [Define Content Models via Code](/docs/headless-cms/extending/content-models-via-code) article. In our example, we named our model _Company_, and created a few basic attributes: `name`, `description`, `theme` (with `primaryColor`, `secondaryColor`, and `logo` attributes), and a hidden boolean attribute called `isInstalled`. @@ -91,13 +91,13 @@ This is just one way of running a use case; you could achieve the same by implem -Keep in mind that, if you plan to seed your new tenant with data, depending on the amount of data you're seeding, you will most likely want to move that logic to a [background task](/docs/{version}/core-development-concepts/background-tasks/about-background-tasks), since it's not limited by a 30 seconds API Gateway request timeout. Tenant creation and installation could still be executed as described in this example, but to seed a tenant, you would invoke an asynchronous background task. +Keep in mind that, if you plan to seed your new tenant with data, depending on the amount of data you're seeding, you will most likely want to move that logic to a [background task](/docs/core-development-concepts/background-tasks/about-background-tasks), since it's not limited by a 30 seconds API Gateway request timeout. Tenant creation and installation could still be executed as described in this example, but to seed a tenant, you would invoke an asynchronous background task. ## Table Column to Install and Access a Tenant -Now we need to [add a piece of UI](https://github.com/webiny/webiny-examples/blob/master/cms-tenant-management/5.40.x/extensions/admin/src/CompanyEntryList.tsx), in our example it will be a button, to trigger tenant installation. The table customization API is documented in the [Customize Entry List Table Columns](/docs/{version}/headless-cms/extending/customize-entry-list-table-columns) article. +Now we need to [add a piece of UI](https://github.com/webiny/webiny-examples/blob/master/cms-tenant-management/5.40.x/extensions/admin/src/CompanyEntryList.tsx), in our example it will be a button, to trigger tenant installation. The table customization API is documented in the [Customize Entry List Table Columns](/docs/headless-cms/extending/customize-entry-list-table-columns) article. diff --git a/docs/developer-docs/5.40.x/get-started/welcome.mdx b/docs/developer-docs/5.40.x/get-started/welcome.mdx index 24567ad4f..d8f5f9124 100644 --- a/docs/developer-docs/5.40.x/get-started/welcome.mdx +++ b/docs/developer-docs/5.40.x/get-started/welcome.mdx @@ -86,7 +86,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun categoryTitle="Products" /> - +

Learn how to create plugins and customize the Headless CMS experience to your content needs. From extending the built-in GraphQL capabilities to modifying the editorial experience.

@@ -108,7 +108,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun In this section, you'll learn how to customize the layout and visual aspects of your forms.

- +

The Admin Area is an app inside which all other apps live. You can white-label the UI to match the brand of your customer, introduce new apps into the menu, modify the start page, and more.

@@ -130,7 +130,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun For developers just getting started with Webiny, we've prepared a short onboarding video course to help you take your first step in development with Webiny.

- +

Once you're past the basics of how to develop with Webiny, this category of articles is a good next step.

@@ -138,24 +138,24 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun You'll learn about the core concepts such as the watch command, project organization, the CLI utility and more.

- +

Learn how to extend the GraphQL API, CLI utility, add custom routes to the Lambda function, intercept requests or customize the built-in Lexical editor.

- +

If you need to configure and deploy Webiny from a CI/CD environment, follow this guide.

- +

Webiny has a simple, but powerful security framework that allows you to integrate with different SSO systems as well as customize the authentication and authorization flows.

- +

Webiny supports long-running tasks that are executed in the background. In this set of articles, you'll learn how to leverage this mechanism inside your own custom plugins and apps built inside Webiny.

@@ -172,7 +172,7 @@ import { ReactComponent as CommunityIcon } from "./assets/resources-icons/commun categoryTitle="Resources" /> - +

Guides to help non-technical users master Webiny and many of its features.

diff --git a/docs/developer-docs/5.40.x/headless-cms/extending/content-entry-live-preview.mdx b/docs/developer-docs/5.40.x/headless-cms/extending/content-entry-live-preview.mdx index 4370d1a9f..21ecb2011 100644 --- a/docs/developer-docs/5.40.x/headless-cms/extending/content-entry-live-preview.mdx +++ b/docs/developer-docs/5.40.x/headless-cms/extending/content-entry-live-preview.mdx @@ -68,7 +68,7 @@ in the Webiny Examples repository, and only describing the process and the outco ## Content Model -To begin, we need to create an Article content model which represents a website article, which we want to create a Live Preview for. We've provided [an export of the model](https://github.com/webiny/webiny-examples/blob/master/cms-live-preview/5.40.x/article-model.json) which you can simply [import into your own project](/docs/{version}/user-guides/headless-cms/advanced/import-export-content-models#importing-content-models). +To begin, we need to create an Article content model which represents a website article, which we want to create a Live Preview for. We've provided [an export of the model](https://github.com/webiny/webiny-examples/blob/master/cms-live-preview/5.40.x/article-model.json) which you can simply [import into your own project](/docs/user-guides/headless-cms/advanced/import-export-content-models#importing-content-models). The `content` field of the Article content model is built using the _Dynamic Zone_ field type, which allows you to define templates that represent your frontend components (blocks of data), which the content creator can then use to write the content within the constraints of the content model. diff --git a/docs/developer-docs/5.40.x/headless-cms/extending/content-models-via-code.mdx b/docs/developer-docs/5.40.x/headless-cms/extending/content-models-via-code.mdx index ef2d5b109..15edd2fdc 100644 --- a/docs/developer-docs/5.40.x/headless-cms/extending/content-models-via-code.mdx +++ b/docs/developer-docs/5.40.x/headless-cms/extending/content-models-via-code.mdx @@ -407,7 +407,7 @@ With this [5.39.2 release](/docs/release-notes/5.39.2/changelog#content-models-d Security Permissions Defined via the Security Application -Additionally, in case the [Folder Level Permissions](/docs/{version}/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. +Additionally, in case the [Folder Level Permissions](/docs/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. The following example demonstrates how to disable authorization for a content model and its entries. @@ -425,7 +425,7 @@ createCmsModelPlugin({ }); ``` -With the `authorization` property set to `false`, base authorization checks are disabled for the content model and its entries. Furthermore, in case the [Folder Level Permissions](/docs/{version}/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. +With the `authorization` property set to `false`, base authorization checks are disabled for the content model and its entries. Furthermore, in case the [Folder Level Permissions](/docs/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. ### Define a Content Model Only for a Specific Locale @@ -637,7 +637,7 @@ export const createExtension = () => { ### Can I modify the Singular API Name and Plural API Name of a model? -Modifying the Singular API Name and Plural API Name of a model cannot be done via the UI due to the potential risks involved. However, you can achieve this through the API by using the `updateContentModel` mutation in the [Headless CMS Manage GraphQL API](/docs/{version}/headless-cms/basics/graphql-api#manage), accessible in the API Playground. +Modifying the Singular API Name and Plural API Name of a model cannot be done via the UI due to the potential risks involved. However, you can achieve this through the API by using the `updateContentModel` mutation in the [Headless CMS Manage GraphQL API](/docs/headless-cms/basics/graphql-api#manage), accessible in the API Playground. Please be extra caution when using the `updateContentModel` mutation. You must pass the entire content model object, including all fields, during the update. To get all the details about a model, you can use the `getContentModel` API. The reason for passing the complete object is to avoid ambiguity in partial updates, where it is unclear whether you intend to remove a value or keep it unchanged. diff --git a/docs/developer-docs/5.40.x/headless-cms/extending/private-models.mdx b/docs/developer-docs/5.40.x/headless-cms/extending/private-models.mdx index 12dc952dc..00a11636a 100644 --- a/docs/developer-docs/5.40.x/headless-cms/extending/private-models.mdx +++ b/docs/developer-docs/5.40.x/headless-cms/extending/private-models.mdx @@ -30,7 +30,7 @@ Let's delve into the details of both public and private models and explore how y Public models in Webiny are those content models that are visible within the admin app. These models come with a generated navigation menu, allowing easy access to content entries through the user interface. Creating public models involves the conventional process of logging into the admin app and using the user interface to create a content model or you can also define public content model via code. The result is the automatic generation of an API, including a GraphQL type and a set of resolvers for seamless data interaction. -Alternatively, you can also build public models through code using a [plugin](/docs/{version}/headless-cms/extending/content-models-via-code-storage-id). +Alternatively, you can also build public models through code using a [plugin](/docs/headless-cms/extending/content-models-via-code-storage-id). ## Private Models diff --git a/docs/developer-docs/5.40.x/headless-cms/notes-app/react-notes-app.mdx b/docs/developer-docs/5.40.x/headless-cms/notes-app/react-notes-app.mdx index 022b9245d..1c54a808b 100644 --- a/docs/developer-docs/5.40.x/headless-cms/notes-app/react-notes-app.mdx +++ b/docs/developer-docs/5.40.x/headless-cms/notes-app/react-notes-app.mdx @@ -268,7 +268,7 @@ First, create a `graphql` directory in the `src` folder, and then add a `client. - The `uri` mentioned below is the Manage API URL for the Headless CMS. For more details on how to obtain the Manage API URL, refer to [this guide](/docs/{version}/headless-cms/basics/graphql-api#where-to-find-the-url-of-the-graph-ql-api). + The `uri` mentioned below is the Manage API URL for the Headless CMS. For more details on how to obtain the Manage API URL, refer to [this guide](/docs/headless-cms/basics/graphql-api#where-to-find-the-url-of-the-graph-ql-api). diff --git a/docs/developer-docs/5.40.x/headless-cms/notes-app/webiny-infrastructure-setup.mdx b/docs/developer-docs/5.40.x/headless-cms/notes-app/webiny-infrastructure-setup.mdx index a2d73fb78..7a0aa9af7 100644 --- a/docs/developer-docs/5.40.x/headless-cms/notes-app/webiny-infrastructure-setup.mdx +++ b/docs/developer-docs/5.40.x/headless-cms/notes-app/webiny-infrastructure-setup.mdx @@ -339,7 +339,7 @@ Additionally, under the Permissions/Content section, select "**All locales**" (a ### Create Note Model to Store User Notes -As the final step on the Webiny side, we'll create a Note Model to store user notes. If you're new to creating models in Webiny, refer to the [Create Content Model](/docs/{version}/user-guides/headless-cms/essentials/create-content-model) user guide. +As the final step on the Webiny side, we'll create a Note Model to store user notes. If you're new to creating models in Webiny, refer to the [Create Content Model](/docs/user-guides/headless-cms/essentials/create-content-model) user guide. We'll set up a Note content model with the following fields: diff --git a/docs/developer-docs/5.40.x/headless-cms/references/date-time-and-identity-meta-fields.mdx b/docs/developer-docs/5.40.x/headless-cms/references/date-time-and-identity-meta-fields.mdx index 02c4e0c37..4f7172798 100644 --- a/docs/developer-docs/5.40.x/headless-cms/references/date-time-and-identity-meta-fields.mdx +++ b/docs/developer-docs/5.40.x/headless-cms/references/date-time-and-identity-meta-fields.mdx @@ -23,7 +23,7 @@ Apart from the fields that are defined in a content model by the user, all conte These meta fields are automatically populated by the system, and they can be used to display information about the entry, such as when it was created, modified, or published, and by whom. -Developers can use these fields when querying entries, for example via the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api): +Developers can use these fields when querying entries, for example via the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api): ```graphql query { @@ -49,7 +49,7 @@ query { } ``` -They can also use them in their custom JavaScript (TypeScript) code, for example, when hooking onto [lifecycle events](/docs/{version}/headless-cms/references/lifecycle-events): +They can also use them in their custom JavaScript (TypeScript) code, for example, when hooking onto [lifecycle events](/docs/headless-cms/references/lifecycle-events): ```typescript new ContextPlugin(async context => { diff --git a/docs/developer-docs/5.40.x/infrastructure/basics/modify-cloud-infrastructure.mdx b/docs/developer-docs/5.40.x/infrastructure/basics/modify-cloud-infrastructure.mdx index 5d1b62584..a0fad6380 100644 --- a/docs/developer-docs/5.40.x/infrastructure/basics/modify-cloud-infrastructure.mdx +++ b/docs/developer-docs/5.40.x/infrastructure/basics/modify-cloud-infrastructure.mdx @@ -195,7 +195,7 @@ export default createCoreApp({ ### Defining Multiple Production Environments -Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/{version}/architecture/deployment-modes/production). +Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/architecture/deployment-modes/production). On order to use the production deployment mode for environments other than `prod`, we can use the `productionEnvironments` parameter. The following example shows how we can use the production mode for the `staging` environment: diff --git a/docs/developer-docs/5.40.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx b/docs/developer-docs/5.40.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx index ab100367c..ccb266477 100644 --- a/docs/developer-docs/5.40.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx +++ b/docs/developer-docs/5.40.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx @@ -39,7 +39,7 @@ In the background, all of these applications are standalone [Pulumi projects](ht 1. every project application contains its own infrastructure-related code ([Pulumi program](https://www.pulumi.com/docs/intro/concepts/programming-model/#programs)), configuration, meta, and [state files](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi#state-files) -2. upon fully deploying a Webiny project via the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, applications are deployed separately, one by one, in the same order as listed above +2. upon fully deploying a Webiny project via the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command, applications are deployed separately, one by one, in the same order as listed above @@ -62,7 +62,7 @@ Still, in some cases, users may need to modify the cloud infrastructure code. Fo To learn more about how to modify the cloud infrastructure code, please refer to the [Modify Cloud - Infrastructure](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure) article. + Infrastructure](/docs/infrastructure/basics/modify-cloud-infrastructure) article. diff --git a/docs/developer-docs/5.41.x/core-development-concepts/basics/extensions.mdx b/docs/developer-docs/5.41.x/core-development-concepts/basics/extensions.mdx index d2291c5ca..39894b15d 100644 --- a/docs/developer-docs/5.41.x/core-development-concepts/basics/extensions.mdx +++ b/docs/developer-docs/5.41.x/core-development-concepts/basics/extensions.mdx @@ -23,7 +23,7 @@ There are a couple of types of extensions in Webiny, but the most common ones ar - **API** - used to extend Webiny's backend functionality (for example its GraphQL API) - **Cloud Infrastructure** - used to extend the cloud infrastructure Webiny deploys -For example, via an Admin extension, we can change the [layout of the dashboard](/docs/{version}/admin-area/extending/custom-dashboard) or [change the logo](/docs/{version}/admin-area/extending/change-logo) that's shown in the header and the main menu. On the other hand, via an API extension, we can introduce new GraphQL queries or mutations, [content models](/docs/{version}/headless-cms/extending/content-models-via-code), or [hook into lifecycle events](/docs/{version}/headless-cms/references/lifecycle-events). +For example, via an Admin extension, we can change the [layout of the dashboard](/docs/admin-area/extending/custom-dashboard) or [change the logo](/docs/admin-area/extending/change-logo) that's shown in the header and the main menu. On the other hand, via an API extension, we can introduce new GraphQL queries or mutations, [content models](/docs/headless-cms/extending/content-models-via-code), or [hook into lifecycle events](/docs/headless-cms/references/lifecycle-events). ## Getting Started @@ -41,7 +41,7 @@ Once all the questions are answered, the command creates the base code for the n - There are a couple of cases where the extension code is placed outside of the `extensions` folder. For example, when [modifying cloud infrastructure](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure), the code is placed in different `webiny.application.ts` files, located in the `apps` folder. + There are a couple of cases where the extension code is placed outside of the `extensions` folder. For example, when [modifying cloud infrastructure](/docs/infrastructure/basics/modify-cloud-infrastructure), the code is placed in different `webiny.application.ts` files, located in the `apps` folder. diff --git a/docs/developer-docs/5.41.x/core-development-concepts/basics/watch-command.mdx b/docs/developer-docs/5.41.x/core-development-concepts/basics/watch-command.mdx index ee888a969..a91c5e6ac 100644 --- a/docs/developer-docs/5.41.x/core-development-concepts/basics/watch-command.mdx +++ b/docs/developer-docs/5.41.x/core-development-concepts/basics/watch-command.mdx @@ -45,7 +45,7 @@ yarn webiny watch website --env dev - Extensions are the primary way to develop on top Webiny and extend it. To learn more, check out the [Extensions](/docs/{version}/core-development-concepts/basics/extensions) article. + Extensions are the primary way to develop on top Webiny and extend it. To learn more, check out the [Extensions](/docs/core-development-concepts/basics/extensions) article. diff --git a/docs/developer-docs/5.41.x/enterprise/aacl/teams.mdx b/docs/developer-docs/5.41.x/enterprise/aacl/teams.mdx index 63af86cc9..5f7e8e646 100644 --- a/docs/developer-docs/5.41.x/enterprise/aacl/teams.mdx +++ b/docs/developer-docs/5.41.x/enterprise/aacl/teams.mdx @@ -33,11 +33,11 @@ And although this approach might work for some users, it can quickly become cumb This feature is especially useful for larger organizations, where it's common to have multiple teams working on different projects. Also, it's a great way to simplify the process of managing permissions for multiple users, as you can simply assign a role to a team, instead of assigning it to each individual user. -Additionally, the Teams feature can be used in conjunction with [Folder Level Permissions (FLP)](/docs/{version}/enterprise/aacl/folder-level-permissions) to further enhance the security of your Webiny project. Instead of just being able to define folder level permissions for individual users, you can now define them for teams as well. Make sure to check out the FLP documentation to learn more about this feature. +Additionally, the Teams feature can be used in conjunction with [Folder Level Permissions (FLP)](/docs/enterprise/aacl/folder-level-permissions) to further enhance the security of your Webiny project. Instead of just being able to define folder level permissions for individual users, you can now define them for teams as well. Make sure to check out the FLP documentation to learn more about this feature. ## Enabling Teams and Feature Overview -For Webiny Enterprise users, apart from [linking their Webiny project](/docs/{version}/wcp/link-a-project) with Webiny Control Panel (WCP), there are no additional steps required to enable Teams. +For Webiny Enterprise users, apart from [linking their Webiny project](/docs/wcp/link-a-project) with Webiny Control Panel (WCP), there are no additional steps required to enable Teams. Once linked, Teams will be automatically enabled and the module can be accessed from the main menu: diff --git a/docs/developer-docs/5.41.x/enterprise/auth0-integration.mdx b/docs/developer-docs/5.41.x/enterprise/auth0-integration.mdx index 154ab43eb..b9dc6c467 100644 --- a/docs/developer-docs/5.41.x/enterprise/auth0-integration.mdx +++ b/docs/developer-docs/5.41.x/enterprise/auth0-integration.mdx @@ -136,7 +136,7 @@ export default ({ documentClient }: { documentClient: DocumentClient }) => [ + groups: [token["webiny_group"]] + + // With the Teams feature enabled, you can also assign teams to the user. -+ // Learn more: https://www.webiny.com/docs/{version}/enterprise/aacl/teams ++ // Learn more: https://www.webiny.com/docs/enterprise/aacl/teams + // teams: [token["webiny_team"]] + + // Assign any custom values you might need. diff --git a/docs/developer-docs/5.41.x/enterprise/okta-integration.mdx b/docs/developer-docs/5.41.x/enterprise/okta-integration.mdx index 16b178576..bd18cbebc 100644 --- a/docs/developer-docs/5.41.x/enterprise/okta-integration.mdx +++ b/docs/developer-docs/5.41.x/enterprise/okta-integration.mdx @@ -134,7 +134,7 @@ export default ({ documentClient }: { documentClient: DocumentClient }) => [ + groups: [token["webiny_group"]] + + // With the Teams feature enabled, you can also assign teams to the user. -+ // Learn more: https://www.webiny.com/docs/{version}/enterprise/aacl/teams ++ // Learn more: https://www.webiny.com/docs/enterprise/aacl/teams + // teams: [token["webiny_team"]] + + // Assign any custom values you might need. diff --git a/docs/developer-docs/5.41.x/headless-cms/ai/smart-seo-open-ai.mdx b/docs/developer-docs/5.41.x/headless-cms/ai/smart-seo-open-ai.mdx index df18044b9..93f117266 100644 --- a/docs/developer-docs/5.41.x/headless-cms/ai/smart-seo-open-ai.mdx +++ b/docs/developer-docs/5.41.x/headless-cms/ai/smart-seo-open-ai.mdx @@ -61,11 +61,11 @@ Details on this are covered in the sections below. For now, let’s deploy the A yarn webiny deploy api --env ENVIRONMENT_NAME ``` -Alternatively, you can use the watch command, which continuously rebuild and redeploy your code. Learn more about it [here](/docs/{version}/core-development-concepts/basics/watch-command). +Alternatively, you can use the watch command, which continuously rebuild and redeploy your code. Learn more about it [here](/docs/core-development-concepts/basics/watch-command). ## Run the Project -After downloading the extension to your project, run the [webiny watch](/docs/{version}/core-development-concepts/basics/watch-command) command to see the Smart SEO functionality in action. +After downloading the extension to your project, run the [webiny watch](/docs/core-development-concepts/basics/watch-command) command to see the Smart SEO functionality in action. ```bash yarn webiny watch admin --env ENVIRONMENT_NAME @@ -78,7 +78,7 @@ You’re now ready to generate SEO titles and tags for your articles using OpenA ## Code Walkthrough -Let’s walk through the code to understand how the Smart SEO extension operates. We’ve created a new [extension](/docs/{version}/core-development-concepts/basics/extensions) called [`smart-seo-open-ai`](https://github.com/webiny/webiny-examples/tree/master/headless-cms/smart-seo-open-ai/5.41.x/extensions/smartSeoOpenAi), and we’ll review each plugin used in this extension one by one. +Let’s walk through the code to understand how the Smart SEO extension operates. We’ve created a new [extension](/docs/core-development-concepts/basics/extensions) called [`smart-seo-open-ai`](https://github.com/webiny/webiny-examples/tree/master/headless-cms/smart-seo-open-ai/5.41.x/extensions/smartSeoOpenAi), and we’ll review each plugin used in this extension one by one. ### Field Tracker, ContentEntry Form Decorator In this example, we have an **Article - Smart SEO** Model with four fields: **Content**, **SEO - Title**, **SEO - Description**, and **SEO - Meta Tags**. We will track these fields. Once the Content field is populated, we will send it to OpenAI, which will generate SEO-friendly titles and tags for the article. The generated title and tags will then be set in the respective **Title**, **Description** and **Tags** fields of the model. @@ -102,7 +102,7 @@ Webiny leverages the [Lexical text editor](https://lexical.dev/) for Rich Text F ### Extend Headless CMS GraphQL API -In this example, we [extended the Headless CMS GraphQL API](/docs/{version}/headless-cms/extending/extend-graphql-api) to generate SEO data using the OpenAI API. The [`generateSeo` plugin](https://github.com/webiny/webiny-examples/blob/master/headless-cms/smart-seo-open-ai/5.41.x/extensions/smartSeoOpenAi/api/src/generateSeo.ts) integrates Webiny with OpenAI. We created a `generateSeo` query for the same. +In this example, we [extended the Headless CMS GraphQL API](/docs/headless-cms/extending/extend-graphql-api) to generate SEO data using the OpenAI API. The [`generateSeo` plugin](https://github.com/webiny/webiny-examples/blob/master/headless-cms/smart-seo-open-ai/5.41.x/extensions/smartSeoOpenAi/api/src/generateSeo.ts) integrates Webiny with OpenAI. We created a `generateSeo` query for the same. To prevent exposing our OpenAI API key to the public, we avoid calling the OpenAI API from the client side. Instead, we handle it server-side by creating this `generateSeo` plugin that extends the Headless CMS GraphQL API for secure SEO data generation. This plugin sends content to OpenAI and retrieves SEO-related information. diff --git a/docs/developer-docs/5.41.x/headless-cms/extending/customize-entry-list-bulk-actions.mdx b/docs/developer-docs/5.41.x/headless-cms/extending/customize-entry-list-bulk-actions.mdx index 19e5ee0a7..3f4530867 100644 --- a/docs/developer-docs/5.41.x/headless-cms/extending/customize-entry-list-bulk-actions.mdx +++ b/docs/developer-docs/5.41.x/headless-cms/extending/customize-entry-list-bulk-actions.mdx @@ -250,7 +250,7 @@ By declaring the `modelIds` prop, you can define in which Content Model Entry Li ### Bulk Action via Background Task -When working with large datasets, performing bulk actions in the background is essential for maintaining a smooth user experience. Webiny allows editors to perform bulk actions asynchronously in the background, eliminating the need for sequential processing on the client side. This functionality is powered by the [Webiny background task feature](/docs/{version}/core-development-concepts/background-tasks/about-background-tasks), which simplifies large-scale operations. +When working with large datasets, performing bulk actions in the background is essential for maintaining a smooth user experience. Webiny allows editors to perform bulk actions asynchronously in the background, eliminating the need for sequential processing on the client side. This functionality is powered by the [Webiny background task feature](/docs/core-development-concepts/background-tasks/about-background-tasks), which simplifies large-scale operations. In this tutorial, we'll walk you through creating a plugin to enable bulk actions in the background. You don't need to be familiar with the background task infrastructure, as Webiny provides simplified APIs that allow you to focus on your business logic. diff --git a/docs/developer-docs/5.41.x/page-builder/extending/create-a-page-element.mdx b/docs/developer-docs/5.41.x/page-builder/extending/create-a-page-element.mdx index 5bc6d31df..bcfcdda47 100644 --- a/docs/developer-docs/5.41.x/page-builder/extending/create-a-page-element.mdx +++ b/docs/developer-docs/5.41.x/page-builder/extending/create-a-page-element.mdx @@ -181,7 +181,7 @@ export const SpaceX = createRenderer(() => { ``` -As we can see in the code, in order to be able to issue remote GraphQL queries, we're using the [`graphql-request`](https://www.npmjs.com/package/graphql-request) library, which we've specified as our extension's dependency upon running the [`webiny extension`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-extension) command in the [Getting Started](#getting-started) section. +As we can see in the code, in order to be able to issue remote GraphQL queries, we're using the [`graphql-request`](https://www.npmjs.com/package/graphql-request) library, which we've specified as our extension's dependency upon running the [`webiny extension`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-extension) command in the [Getting Started](#getting-started) section. Note that our GraphQL query is called within the `useLoader` React hook. This is important because, essentially, this enables proper data caching when the page is published. This way, the page element is rendered efficiently, without the need to re-fetch the data each time the page is loaded. diff --git a/docs/developer-docs/5.41.x/page-builder/extending/loading-data-in-page-elements.mdx b/docs/developer-docs/5.41.x/page-builder/extending/loading-data-in-page-elements.mdx index 3a2f01ce9..0f117877d 100644 --- a/docs/developer-docs/5.41.x/page-builder/extending/loading-data-in-page-elements.mdx +++ b/docs/developer-docs/5.41.x/page-builder/extending/loading-data-in-page-elements.mdx @@ -21,7 +21,7 @@ import dataLoadedWithoutLoader from "./assets/loading-data-in-page-elements/load It's not uncommon to have a custom page element that loads data from an external remote HTTP API and displays it on the page. -For example, you might want to display a list of products or a list of blog posts that are loaded from [Webiny's Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api). Another examples is listing rocket and dragon spacecrafts from an external SpaceX API, which is covered in the [Create a Custom Page Element](/docs/{version}/page-builder/extending/create-a-page-element) guide. +For example, you might want to display a list of products or a list of blog posts that are loaded from [Webiny's Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api). Another examples is listing rocket and dragon spacecrafts from an external SpaceX API, which is covered in the [Create a Custom Page Element](/docs/page-builder/extending/create-a-page-element) guide. In this guide, we show how to efficiently load data in Page Builder elements using the `useLoader` React hook. @@ -54,7 +54,7 @@ Let's analyze the code that was used to create the page element we saw in the vi - If you're not familiar with creating custom page elements, you can learn more about it in the [Create a Custom Page Element](/docs/{version}/page-builder/extending/create-a-page-element) guide. + If you're not familiar with creating custom page elements, you can learn more about it in the [Create a Custom Page Element](/docs/page-builder/extending/create-a-page-element) guide. diff --git a/docs/developer-docs/5.41.x/security/extensions/programmatically-create-roles-and-teams.mdx b/docs/developer-docs/5.41.x/security/extensions/programmatically-create-roles-and-teams.mdx index 97ac720d9..4db204da5 100644 --- a/docs/developer-docs/5.41.x/security/extensions/programmatically-create-roles-and-teams.mdx +++ b/docs/developer-docs/5.41.x/security/extensions/programmatically-create-roles-and-teams.mdx @@ -33,7 +33,7 @@ The most straightforward way to define roles and teams would be via the Admin Ar - Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/{version}/enterprise/aacl/teams) article. + Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/enterprise/aacl/teams) article. @@ -103,7 +103,7 @@ The easiest way to find out which permissions are available and to build roles w - More info on security permissions can also be found in the [Security Framework - Introduction](/docs/{version}/security/security-framework/introduction#permission) article. + More info on security permissions can also be found in the [Security Framework - Introduction](/docs/security/security-framework/introduction#permission) article. @@ -149,7 +149,7 @@ With this code in place, we should be able to see the following team in the Team - Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/{version}/enterprise/aacl/teams) article. + Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/enterprise/aacl/teams) article. diff --git a/docs/developer-docs/5.42.x/headless-cms/extending/content-models-via-code.mdx b/docs/developer-docs/5.42.x/headless-cms/extending/content-models-via-code.mdx index c97c4a887..9a3367010 100644 --- a/docs/developer-docs/5.42.x/headless-cms/extending/content-models-via-code.mdx +++ b/docs/developer-docs/5.42.x/headless-cms/extending/content-models-via-code.mdx @@ -420,7 +420,7 @@ With this [5.39.2 release](/docs/release-notes/5.39.2/changelog#content-models-d Security Permissions Defined via the Security Application -Additionally, in case the [Folder Level Permissions](/docs/{version}/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. +Additionally, in case the [Folder Level Permissions](/docs/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. The following example demonstrates how to disable authorization for a content model and its entries. @@ -438,7 +438,7 @@ createModelPlugin({ }); ``` -With the `authorization` property set to `false`, base authorization checks are disabled for the content model and its entries. Furthermore, in case the [Folder Level Permissions](/docs/{version}/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. +With the `authorization` property set to `false`, base authorization checks are disabled for the content model and its entries. Furthermore, in case the [Folder Level Permissions](/docs/enterprise/aacl/folder-level-permissions) feature is enabled in your Webiny project, the content model entries will not be subject to folder level permissions. ### Define a Content Model Only for a Specific Locale @@ -660,7 +660,7 @@ export const createExtension = () => { ### Can I modify the Singular API Name and Plural API Name of a model? -Modifying the Singular API Name and Plural API Name of a model cannot be done via the UI due to the potential risks involved. However, you can achieve this through the API by using the `updateContentModel` mutation in the [Headless CMS Manage GraphQL API](/docs/{version}/headless-cms/basics/graphql-api#manage), accessible in the API Playground. +Modifying the Singular API Name and Plural API Name of a model cannot be done via the UI due to the potential risks involved. However, you can achieve this through the API by using the `updateContentModel` mutation in the [Headless CMS Manage GraphQL API](/docs/headless-cms/basics/graphql-api#manage), accessible in the API Playground. Please be extra caution when using the `updateContentModel` mutation. You must pass the entire content model object, including all fields, during the update. To get all the details about a model, you can use the `getContentModel` API. The reason for passing the complete object is to avoid ambiguity in partial updates, where it is unclear whether you intend to remove a value or keep it unchanged. diff --git a/docs/developer-docs/5.43.x/core-development-concepts/background-tasks/built-in-background-tasks.mdx b/docs/developer-docs/5.43.x/core-development-concepts/background-tasks/built-in-background-tasks.mdx index 9d26d9d6f..97ba447dd 100644 --- a/docs/developer-docs/5.43.x/core-development-concepts/background-tasks/built-in-background-tasks.mdx +++ b/docs/developer-docs/5.43.x/core-development-concepts/background-tasks/built-in-background-tasks.mdx @@ -25,7 +25,7 @@ The following is a list of background tasks that are included in Webiny by defau - This task can be used with the Amazon DynamoDB + Amazon OpenSearch [database setup](/docs/{version}/architecture/introduction#different-database-setups). It can be also used with the legacy Amazon DynamoDB + Amazon Elasticsearch setup. + This task can be used with the Amazon DynamoDB + Amazon OpenSearch [database setup](/docs/architecture/introduction#different-database-setups). It can be also used with the legacy Amazon DynamoDB + Amazon Elasticsearch setup. @@ -82,7 +82,7 @@ This is done to reduce the strain on the Elasticsearch/OpenSearch cluster as the - This task can be used with the Amazon DynamoDB + Amazon OpenSearch [database setup](/docs/{version}/architecture/introduction#different-database-setups). It can be also used with the legacy Amazon DynamoDB + Amazon Elasticsearch setup. + This task can be used with the Amazon DynamoDB + Amazon OpenSearch [database setup](/docs/architecture/introduction#different-database-setups). It can be also used with the legacy Amazon DynamoDB + Amazon Elasticsearch setup. diff --git a/docs/developer-docs/6.0.x/get-started/install-webiny.mdx b/docs/developer-docs/6.0.x/get-started/install-webiny.mdx deleted file mode 100644 index 90b1ad441..000000000 --- a/docs/developer-docs/6.0.x/get-started/install-webiny.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: aafeab3f -title: Install Webiny -description: Learn how to create a new Webiny project and deploy it into your AWS account. ---- - -import { Alert } from "@/components/Alert"; - - - -- how to create a brand new Webiny project -- how to deploy it to your [AWS](https://aws.amazon.com/) account - - - ---- diff --git a/docs/developer-docs/6.0.x/get-started/welcome.mdx b/docs/developer-docs/6.0.x/get-started/welcome.mdx deleted file mode 100644 index 109cfbe1f..000000000 --- a/docs/developer-docs/6.0.x/get-started/welcome.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -id: db45d287 -title: Welcome to Webiny Docs -description: Learn how to install Webiny and customize its capabilities as a developer. -pageHeader: false -fullWidth: true ---- - -Welcome! TODO diff --git a/docs/developer-docs/6.0.x/navigation.tsx b/docs/developer-docs/6.0.x/navigation.tsx deleted file mode 100644 index faf27cc11..000000000 --- a/docs/developer-docs/6.0.x/navigation.tsx +++ /dev/null @@ -1,22 +0,0 @@ -import React from "react"; -import { Group, Page, NavigationRoot } from "@webiny/docs-generator"; -import { Separator } from "@webiny/docs-generator"; - -export const Navigation = ({ children }: { children: React.ReactNode }) => { - return ( - - - - - - - ); -}; diff --git a/docs/developer-docs/6.0.x/overview/features/security.mdx b/docs/developer-docs/6.0.x/overview/features/security.mdx deleted file mode 100644 index f4c0995f0..000000000 --- a/docs/developer-docs/6.0.x/overview/features/security.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -id: aafeaacb -title: Security -description: Overview of Webiny security strategy. ---- - -import { Alert } from "@/components/Alert"; - - - -- How we approach security -- Additional security recommendations - - - -## About - -If we don't have security, we can't really say we have a good product. Although Webiny is a self-hosted solution, meaning you control your security, it's still important for us to provide an overview of our security practices. This will make you acquainted with our approach, and will make it easier to align your implementation to some of the best practices we established. - -This being an overview article, it will provide the main elements and a clear distinction in terms of the security responsibilities that are on your end in comparison to the ones being handled by Webiny. - -We've structured the article into 4 main sections: - -- **Codebase** - how we ensure our codebase isn't compromised -- **Infrastructure** - how the security layer is implemented as part of the infrastructure that Webiny deploys -- **Application** - how Webiny protects the application from unauthorized access -- **Data** - how your data is stored and secured - -## Codebase - -Webiny, being an open-source project, our code is public, and with that comes great responsibility for the security aspects around it. - -Our code-base is regularly scanned for vulnerabilities by [CodeQL](https://securitylab.github.com/tools/codeql)—the world’s most powerful code analysis engine. - -All the 3rd party dependencies we use are scanned via [Dependabot](https://dependabot.com). - -No single change made to our codebase skips these checks. - -## Infrastructure - -Webiny is designed to run on top of the AWS cloud at the moment, with support for other clouds coming at a later point. - - -The serverless services Webiny uses as part of its architecture are fault-tolerant by design. The only exception is Elasticsearch. In the Webiny production deployment stack, Elasticsearch is automatically deployed in multiple AZs, making it highly-available. Any public access, in both VPC and non-VPC deployment is restricted. - -With Webiny there are zero servers you need to manage, reducing the risk of a security breach due to misconfiguration. Serverless services are tested by the cloud provider against all forms of attacks across millions of customers, giving your confidence in their security. Serverless services in general reduce the potential attack vectors that can be used against your application. - -Webiny ships with 2 infrastructure stacks by default, a development one and a production one. - - - -We highly recommend that you use the production stack for all your projects running production traffic. - - - -The production stack by default is deployed inside a private VPC preventing direct access to resources like DynamoDB and the Elasticsearch database. Keeping your data safe. - -Additional security improvements you can make to your project: - -- **Firewall**: Webiny intentionally deploys a CloudFront web distribution in front of an API Gateway. This setup allows you to place a web application firewall to all incoming requests for added security. - -## Application - -Webiny is built to support different authentication mechanisms. Out of the box, it is configured to work with [AWS Cognito](https://aws.amazon.com/cognito/), an enterprise-grade, battle-tested identity provider. The framework, however, supports any identity provider, by means of plugins. - -Webiny draws a very clear line between **authentication** and **authorization**. We rely on third-party IdPs for authentication and use a very flexible system of permissions for authorization. - -Authorization is usually very closely tied to business logic, so using scopes from the JWT, or simple string-based roles is not enough for complex business applications. To allow different types of integration, we provide a very thin security framework, based on plugins. On top of that, we define permissions as rich objects with different application-related properties. - -## Data - -Because Webiny is self-hosted and under the MIT license, your data stays within your cloud infrastructure. In practice, this usually means there is no need for any legal, data compliance or GDPR changes to be made when adopting Webiny. - -When it comes to storing your data, it's saved inside a DynamoDB database and Elasticsearch, and files are stored inside an S3 bucket. - -All the data inside DynamoDB is encrypted in transit and at rest by default. - -All the data inside Elasticsearch is encrypted at transit only, by default. - - - -For production cases, we recommend you also encrypt data at rest in Elasticsearch. Ensure you have a proper key management strategy in place beforehand otherwise it could lead to making your data inaccessible. For more info visit: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/encryption-at-rest.html - - - -The data inside S3 bucket by default is not encrypted, is set to be publicly accessible and versioning is turned off. Public access is only allowed on the `list` command. Write operations need to be signed with a security token to be allowed. We advise that you adjust these parameters to the needs of your project accordingly. - - - -If needed you can restrict access to the S3 buckets by modifying the ACL policy inside the Pulumi infrastructure files. At the moment if you make the S3 bucket private to non-authorized users, images embedded in the Page Builder and other places will not be displayed and potentially the Admin app might be made inaccessible. Please contact us in case you need to make your S3 completely private. - - - -## FAQ - -### Can I use a different identity provider? - -Yes, absolutely. The default IdP implementation contains a set of plugins on the API and React sides. All you need to do is follow the same principle and implement your own plugins that will work with the IdP of your choice. - -### Can I roll my own authentication system instead of using a third-party IdP? - -We don't recommend it, but yes, you can. Following the same implementation strategy that comes with Webiny by default, you can create all kinds of authentication mechanisms. diff --git a/docs/developer-docs/6.0.x/overview/pricing.mdx b/docs/developer-docs/6.0.x/overview/pricing.mdx deleted file mode 100644 index 0b730f2d8..000000000 --- a/docs/developer-docs/6.0.x/overview/pricing.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: aafeab41 -title: Pricing Tiers -description: How is Webiny priced and what are the available options. ---- - -import { Alert } from "@/components/Alert"; - - - -- What is Webiny's business model? -- What is commercial open-source software? -- What are the different Webiny pricing tiers? - - - -Webiny is an open-source project and at such, all our code is open to the public on our [GitHub repository](https://github.com/webiny/webiny-js). However building an open-source project and a business, in the past have been two different things. But lately, they have come together into what's today known as Commercial Open Source Software (COSS) and this is the model Webiny as a project has embraced. - - - -Here's is a great article on the topic of Commercial Open-Source: -https://www.webiny.com/blog/what-is-commercial-open-source - - - -## Webiny's Dual License Model - -Majority of Webiny's code base (over 95%) is licensed under the MIT open-source license. As such, you are given the right to use that code for any type of use-cases, projects, be commercial or not. You're allowed to make changes to the project and you can even resell it if you want to. We are a strong believer that open-source is the only way software will be written and distributed in the future and we are commited to such a cause ourselves. - -However, as a fairly young company we need to ensure the long-term success of our project. Webiny is already a large project, and it's growing. As such it requires a dedicated team working full time to maintain, build and fix things, alongside the contributions coming from the community. To ensure their long-term sustainability, many open-source projects add a commercial aspect to their project. - -This is usually done through either offering a cloud version, or a dual-license offering. Certain features might not be available under the free OSS license, but instead under a commercial license. Which might, or might not, be open-source. **It's important to distiguish that open-source doesn't mean "free"**. If only means the code is open for public to view, modify and enhance. Still to use the code, the user must adhear to the terms of the license. - - - -What is open-source? https://opensource.com/resources/what-open-source - - - -Alongside the MIT license, Webiny also has a commercial license that comes with a cost, which unlocks additional features and functionality within the system. The revenue we get from this license is directly reinvested into building more features, and making the platform better and enjoyable to use. This is how we are building a sustainable model around our business, and ensuring the long-term development of our project. - -## Webiny Pricing Tiers - -Webiny comes in these three pricing tiers: - -- **Free** - - for personal and hobby projects - - has only basic security options - - doesn't support multi-tenancy - - all code is licensed under the MIT open-source license - - 100% free to use without any restrictions -- **Business** - - for small team projects - - supports advanced roles and permissions - - supports optional addons such as Publishing Workflow and Headless Pages - - supports multi-tenancy - - all the code is open-source, but it's a mix of the MIT license and the Webiny's commerical license, users are allowed to make modifications to the code regardless of the license - - price starts at $9 user/month, first user is free -- **Enterprise** - - for teams working on critical projects - - comes with SSO and team management - - includes SLA support and consultancy services - - all the code is open-source, but it's a mix of the MIT license and the Webiny's commerical license, users are allowed to make modifications to the code regardless of the license - - price starts at $3,499 / month - -For more details on the pricing tier, please visit our [pricing page](https://www.webiny.com/pricing). For any additional questions, please email us at [sales@webiny.com](mailto:sales@webiny.com). diff --git a/docs/developer-docs/shared/release-management/branching-strategy.mdx b/docs/developer-docs/shared/release-management/branching-strategy.mdx index 60258ec0e..00c1c7e54 100644 --- a/docs/developer-docs/shared/release-management/branching-strategy.mdx +++ b/docs/developer-docs/shared/release-management/branching-strategy.mdx @@ -45,4 +45,4 @@ Notice the green **sync commits**, they're necessary to pull in the files modifi The strategies described in this article should make releases more predictable, upgrades more reliable, and our users more confident when they do get to upgrading their projects. -If you're interested in test-driving the latest unstable features of Webiny, the ones that live in the `next` branch, read the article about [unstable releases](/docs/{version}/release-management/unstable-releases). +If you're interested in test-driving the latest unstable features of Webiny, the ones that live in the `next` branch, read the article about [unstable releases](/docs/release-management/unstable-releases). diff --git a/docs/developer-docs/shared/release-management/unstable-releases.mdx b/docs/developer-docs/shared/release-management/unstable-releases.mdx index 87f7c8dea..b609811fc 100644 --- a/docs/developer-docs/shared/release-management/unstable-releases.mdx +++ b/docs/developer-docs/shared/release-management/unstable-releases.mdx @@ -12,7 +12,7 @@ description: Learn how to install and test unstable features. ## Overview -As described in the [Branching Strategy](/docs/{version}/release-management/branching-strategy) article, features that are scheduled to be released in the next quarterly release are published under the `unstable` tag to NPM. If you're interested in taking that release for a spin, follow the instructions below. +As described in the [Branching Strategy](/docs/release-management/branching-strategy) article, features that are scheduled to be released in the next quarterly release are published under the `unstable` tag to NPM. If you're interested in taking that release for a spin, follow the instructions below. ## Setup the Unstable Release diff --git a/docs/messages/missing-stack-output.mdx b/docs/messages/missing-stack-output.mdx index df4506e4b..6bb125ba2 100644 --- a/docs/messages/missing-stack-output.mdx +++ b/docs/messages/missing-stack-output.mdx @@ -5,7 +5,7 @@ title: Could not assign required environment variables. API project application' import stackOutputSuccess from "./assets/stack-output-success.png"; -Looks like you wanted to start the **Admin** or **Website** app locally via the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command. But, upon doing that, the required environment variables that define values like the GraphQL API URL, or Amazon Cognito User Pool Client ID, could not be assigned. +Looks like you wanted to start the **Admin** or **Website** app locally via the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command. But, upon doing that, the required environment variables that define values like the GraphQL API URL, or Amazon Cognito User Pool Client ID, could not be assigned. Because of this, your locally running app will not be able to communicate with Webiny's backend services like its GraphQL API, and you will see errors in the console. diff --git a/docs/release-notes/5.10.0/changelog.mdx b/docs/release-notes/5.10.0/changelog.mdx index 77335b2e6..c1bb3319e 100644 --- a/docs/release-notes/5.10.0/changelog.mdx +++ b/docs/release-notes/5.10.0/changelog.mdx @@ -74,15 +74,15 @@ From now on, files whose content didn't change simply won't be uploaded. This wi -Learn more about project applications and project organization in general, in the [Project Applications and Packages](/docs/{version}/core-development-concepts/project-organization/project-applications-and-packages) key topic. +Learn more about project applications and project organization in general, in the [Project Applications and Packages](/docs/core-development-concepts/project-organization/project-applications-and-packages) key topic. ### Improved Existing Scaffolds ([#1739](https://github.com/webiny/webiny-js/pull/1739)) -A couple of minor fixes and improvements were made to the [scaffolding utilities](/docs/{version}/core-development-concepts/scaffolding/introduction), introduced in the previous [Webiny 5.9.0](/docs/release-notes/5.9.0/changelog) release. +A couple of minor fixes and improvements were made to the [scaffolding utilities](/docs/core-development-concepts/scaffolding/introduction), introduced in the previous [Webiny 5.9.0](/docs/release-notes/5.9.0/changelog) release. -For example, if you already had the chance to use the [Extend GraphQL API](/docs/{version}/core-development-concepts/scaffolding/extend-graphql-api) scaffold, you might notice that the default location in which the application code is generated has been changed: +For example, if you already had the chance to use the [Extend GraphQL API](/docs/core-development-concepts/scaffolding/extend-graphql-api) scaffold, you might notice that the default location in which the application code is generated has been changed: ```bash # Previously, all of the application code would be generated within the following path: diff --git a/docs/release-notes/5.10.0/upgrade-guide.mdx b/docs/release-notes/5.10.0/upgrade-guide.mdx index b888e82fc..84469b212 100644 --- a/docs/release-notes/5.10.0/upgrade-guide.mdx +++ b/docs/release-notes/5.10.0/upgrade-guide.mdx @@ -78,6 +78,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.11.0/changelog.mdx b/docs/release-notes/5.11.0/changelog.mdx index fe75b8645..95de22911 100644 --- a/docs/release-notes/5.11.0/changelog.mdx +++ b/docs/release-notes/5.11.0/changelog.mdx @@ -46,7 +46,7 @@ Shout out to [Karthick Raja](https://github.com/karthick3018) for getting the ba From now on, all new Webiny projects will benefit from improved security, due to fine-grained policies used with AWS Lambda roles (instead of using the default `AdministratorAccess` policy, which was previously the case). -In addition to that, you can also use a fine-grained policy for the [CLI user](/docs/{version}/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template), which is important for making secure deploys of your Webiny project. +In addition to that, you can also use a fine-grained policy for the [CLI user](/docs/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template), which is important for making secure deploys of your Webiny project. At the moment, for existing projects we don’t offer a migration path, but if you’re interested in applying this improvement to your Webiny project, you can contact us via our community [Slack](https://webiny.com/slack). @@ -54,7 +54,7 @@ At the moment, for existing projects we don’t offer a migration path, but if y ### Pulumi v3 Upgrade ([#1787](https://github.com/webiny/webiny-js/pull/1787)) -From now on, all Webiny projects will use [Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) v3. +From now on, all Webiny projects will use [Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi) v3. For Webiny users, this will make it possible to have access to all of the new features and fixes that the framework will receive in the future. @@ -66,7 +66,7 @@ A couple of useful updates were made to the existing CI/CD scaffold. -Learn more about CI/CD and how to set it up for your Webiny project in our [CI/CD key topics](/docs/{version}/core-development-concepts/ci-cd/introduction). +Learn more about CI/CD and how to set it up for your Webiny project in our [CI/CD key topics](/docs/core-development-concepts/ci-cd/introduction). diff --git a/docs/release-notes/5.11.0/upgrade-guide.mdx b/docs/release-notes/5.11.0/upgrade-guide.mdx index f8991a9bf..a720fb81d 100644 --- a/docs/release-notes/5.11.0/upgrade-guide.mdx +++ b/docs/release-notes/5.11.0/upgrade-guide.mdx @@ -67,7 +67,7 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. @@ -81,11 +81,11 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -As mentioned in the [changelog](/docs/release-notes/5.11.0/changelog), from the 5.11.0 release, all Webiny projects will use [Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) v3. +As mentioned in the [changelog](/docs/release-notes/5.11.0/changelog), from the 5.11.0 release, all Webiny projects will use [Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi) v3. In terms of existing projects and upgrading, there shouldn't be any major changes or extra steps that you'll need to perform. But, there are a couple of things to have in mind. -Once you've run the above shown `webiny upgrade` command, the existing Pulumi CLI should automatically be removed from your project. And, upon redeploying your Webiny project (using the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command), the new Pulumi CLI should be downloaded and installed, again automatically. +Once you've run the above shown `webiny upgrade` command, the existing Pulumi CLI should automatically be removed from your project. And, upon redeploying your Webiny project (using the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command), the new Pulumi CLI should be downloaded and installed, again automatically. Furthermore, during the first deployment, in case you didn't make any changes that would affect the deployment, you should only see a change in `provider` for each cloud infrastructure resource: diff --git a/docs/release-notes/5.11.1/upgrade-guide.mdx b/docs/release-notes/5.11.1/upgrade-guide.mdx index 35db8a1d4..02b576ff0 100644 --- a/docs/release-notes/5.11.1/upgrade-guide.mdx +++ b/docs/release-notes/5.11.1/upgrade-guide.mdx @@ -51,7 +51,7 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.12.0/changelog.mdx b/docs/release-notes/5.12.0/changelog.mdx index 792f30995..dbc9b2586 100644 --- a/docs/release-notes/5.12.0/changelog.mdx +++ b/docs/release-notes/5.12.0/changelog.mdx @@ -68,7 +68,7 @@ Scaffolds are backwards compatible, so you can continue using them. But in the f In this release, we've introduced the ability to define content models and content model groups via plugins. This brings a couple of cool benefits, like having both stored in your version control, in some cases additional flexibility, and more. -Be sure to check out the [Define Content Models via Plugins](/docs/{version}/headless-cms/extending/content-models-via-code) guide to learn more. +Be sure to check out the [Define Content Models via Plugins](/docs/headless-cms/extending/content-models-via-code) guide to learn more. ### Compress Data That Is Stored in DynamoDB Table for ES ([#1821](https://github.com/webiny/webiny-js/pull/1821)) diff --git a/docs/release-notes/5.12.0/upgrade-guide.mdx b/docs/release-notes/5.12.0/upgrade-guide.mdx index 1f89fe3e3..021c23cd0 100644 --- a/docs/release-notes/5.12.0/upgrade-guide.mdx +++ b/docs/release-notes/5.12.0/upgrade-guide.mdx @@ -67,6 +67,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.13.0/changelog.mdx b/docs/release-notes/5.13.0/changelog.mdx index d574e9121..7fe076773 100644 --- a/docs/release-notes/5.13.0/changelog.mdx +++ b/docs/release-notes/5.13.0/changelog.mdx @@ -23,7 +23,7 @@ Please check the [Webiny 5.13.0 migration guide](/docs/release-notes/5.13.0/upgr The highlight of this release - we bring you three brand new scaffolds that are focused on aiding developers in custom application development. The three scaffolds are: - [Full Stack Application](/docs/5.28.x/core-development-concepts/scaffolding/full-stack-application) -- [GraphQL API](/docs/{version}/core-development-concepts/scaffolding/extend-graphql-api) +- [GraphQL API](/docs/core-development-concepts/scaffolding/extend-graphql-api) - [React Application](/docs/5.28.x/core-development-concepts/scaffolding/full-stack-application) To get started, simply run the existing `webiny scaffold` command and pick the scaffold you need. On the other hand, if you'd like to learn more, you can check out the linked how-to guides. @@ -65,7 +65,7 @@ export default new GraphQLSchemaPlugin({ Except for the ability to interact with the `context` object in a type-safe manner, another benefit of this approach is easier usage. All of the properties of the `context` object will now be shown by your IDE, in an autocomplete dropdown menu. -The existing guides that cover extending GraphQL APIs were also updated, so make sure to [check them out](/docs/{version}/core-development-concepts/extending-and-customizing/extend-graphql-api) to learn more: +The existing guides that cover extending GraphQL APIs were also updated, so make sure to [check them out](/docs/core-development-concepts/extending-and-customizing/extend-graphql-api) to learn more: ### Yarn 3 Support ([#1862](https://github.com/webiny/webiny-js/pull/1862)) @@ -79,13 +79,13 @@ This has now been taken care of and you should be able to successfully deploy yo -Check out the [Use AWS Profiles](/docs/{version}/infrastructure/aws/use-aws-profiles) how-to guide to learn how to use different AWS profiles upon deploying your Webiny project. +Check out the [Use AWS Profiles](/docs/infrastructure/aws/use-aws-profiles) how-to guide to learn how to use different AWS profiles upon deploying your Webiny project. ### Fix `watch` on Windows ([#1848](https://github.com/webiny/webiny-js/pull/1848)) -There's currently a bug in the Pulumi path detection for file watching, so on Windows, where paths start with **C:**, etc., Pulumi thinks it's a relative path, and constructs a wrong file path to watch. To bypass this issue, and get the [watch](/docs/{version}/core-development-concepts/basics/watch-command#webiny-watch-command) command to work on Windows, we've temporarily disabled path filtering on Windows. +There's currently a bug in the Pulumi path detection for file watching, so on Windows, where paths start with **C:**, etc., Pulumi thinks it's a relative path, and constructs a wrong file path to watch. To bypass this issue, and get the [watch](/docs/core-development-concepts/basics/watch-command#webiny-watch-command) command to work on Windows, we've temporarily disabled path filtering on Windows. Watch works just a good, but you might experience a case of double update on Lambda functions. Not a major problem, just a little detail you'll most likely not even notice, if you don't pay attention to deploy logs. diff --git a/docs/release-notes/5.13.0/upgrade-guide.mdx b/docs/release-notes/5.13.0/upgrade-guide.mdx index e466bdbcb..92a92cdc6 100644 --- a/docs/release-notes/5.13.0/upgrade-guide.mdx +++ b/docs/release-notes/5.13.0/upgrade-guide.mdx @@ -67,6 +67,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.14.0/changelog.mdx b/docs/release-notes/5.14.0/changelog.mdx index 4f03b3362..6858fde3e 100644 --- a/docs/release-notes/5.14.0/changelog.mdx +++ b/docs/release-notes/5.14.0/changelog.mdx @@ -61,7 +61,7 @@ The file in question is now correctly updated during the scaffolding process, so #### All Existing Repositories Visible ([@IzioDev](https://github.com/IzioDev), [#1877](https://github.com/webiny/webiny-js/pull/1877)) -While going through the [CI/CD](/docs/{version}/core-development-concepts/ci-cd/setup) scaffold's setup wizard, if a user wanted to use an existing GitHub repository, the repositories list would only show the first one hundred entries. So, if a user had more than one hundred repositories, she/he would not be able to pick the wanted one, forcing the user to perform all kinds of workarounds to be able to complete the wizard. +While going through the [CI/CD](/docs/core-development-concepts/ci-cd/setup) scaffold's setup wizard, if a user wanted to use an existing GitHub repository, the repositories list would only show the first one hundred entries. So, if a user had more than one hundred repositories, she/he would not be able to pick the wanted one, forcing the user to perform all kinds of workarounds to be able to complete the wizard. Special thanks to [IzioDev](https://github.com/IzioDev) for taking care of this. diff --git a/docs/release-notes/5.14.0/upgrade-guide.mdx b/docs/release-notes/5.14.0/upgrade-guide.mdx index d47caf383..f6779e1f7 100644 --- a/docs/release-notes/5.14.0/upgrade-guide.mdx +++ b/docs/release-notes/5.14.0/upgrade-guide.mdx @@ -57,6 +57,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.15.0/changelog.mdx b/docs/release-notes/5.15.0/changelog.mdx index 24010a250..f7112ed63 100644 --- a/docs/release-notes/5.15.0/changelog.mdx +++ b/docs/release-notes/5.15.0/changelog.mdx @@ -24,7 +24,7 @@ The majority of changes that were introduced in this release are related to the -[In case you missed it](/docs/{version}/architecture/api/overview), at the moment, Webiny relies on both [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and [Amazon OpenSearch Service](https://aws.amazon.com/opensearch-service/the-elk-stack/what-is-elasticsearch/) databases in order to store and retrieve data. And while this is definitely a good choice for larger projects, for smaller and mid-sized projects, we'll be introducing an Amazon DynamoDB-only version of Webiny. For now there are no official estimates when this will be available, but we can definitely say that a very large amount of work has already been done. +[In case you missed it](/docs/architecture/api/overview), at the moment, Webiny relies on both [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and [Amazon OpenSearch Service](https://aws.amazon.com/opensearch-service/the-elk-stack/what-is-elasticsearch/) databases in order to store and retrieve data. And while this is definitely a good choice for larger projects, for smaller and mid-sized projects, we'll be introducing an Amazon DynamoDB-only version of Webiny. For now there are no official estimates when this will be available, but we can definitely say that a very large amount of work has already been done. @@ -91,7 +91,7 @@ A special shout out to [@nelsonchen5](https://github.com/nelsonchen5) for sortin -Learn more about different types of the Headless CMS GraphQL API in [this key topic](/docs/{version}/headless-cms/basics/graphql-api). +Learn more about different types of the Headless CMS GraphQL API in [this key topic](/docs/headless-cms/basics/graphql-api). diff --git a/docs/release-notes/5.15.0/upgrade-guide.mdx b/docs/release-notes/5.15.0/upgrade-guide.mdx index a68fd6748..fc1c585b0 100644 --- a/docs/release-notes/5.15.0/upgrade-guide.mdx +++ b/docs/release-notes/5.15.0/upgrade-guide.mdx @@ -67,6 +67,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.16.0/changelog.mdx b/docs/release-notes/5.16.0/changelog.mdx index 99f1bad5d..300861043 100644 --- a/docs/release-notes/5.16.0/changelog.mdx +++ b/docs/release-notes/5.16.0/changelog.mdx @@ -31,7 +31,7 @@ Once completed, the exported pages can be imported in a different environment or -To learn more about environments in general, check out the [Environments](/docs/{version}/infrastructure/basics/environments) key topic. +To learn more about environments in general, check out the [Environments](/docs/infrastructure/basics/environments) key topic. @@ -102,7 +102,7 @@ Available options to send are `createdOn_ASC`, `createdOn_DESC`, `savedOn_ASC` a ### Pulumi CLI Is Now Downloaded Into Project Root's `.webiny` Folder ([#1947](https://github.com/webiny/webiny-js/pull/1947)) -To deploy necessary cloud infrastructure, by default, Webiny relies on [Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi), a modern infrastructure as code framework. +To deploy necessary cloud infrastructure, by default, Webiny relies on [Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi), a modern infrastructure as code framework. For every Webiny project, the framework is downloaded automatically, and, prior to this release, all of the related binaries would be downloaded into project's `node_modules/@webiny/pulumi-sdk/pulumi` folder. And although this works, over time, we've noticed a couple of interesting issues with this solution: @@ -113,7 +113,7 @@ Because of these, from now on, all the Pulumi CLI related binaries will be downl -Once your project has been upgraded to `5.16.0`, upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) or the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command, the Pulumi CLI will be re-downloaded. This is normal and will happen even if you already had the Pulumi CLI downloaded in the mentioned `node_modules/@webiny/pulumi-sdk/pulumi` folder. +Once your project has been upgraded to `5.16.0`, upon running the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) or the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command, the Pulumi CLI will be re-downloaded. This is normal and will happen even if you already had the Pulumi CLI downloaded in the mentioned `node_modules/@webiny/pulumi-sdk/pulumi` folder. @@ -121,9 +121,9 @@ Once your project has been upgraded to `5.16.0`, upon running the [`webiny deplo Webiny CLI also received a couple of neat improvements. -For starters, we've introduced the `--allow-production` flag for the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command, which allows the user to run the command even with `prod` and `production` environments (by default, the command doesn't allow that). +For starters, we've introduced the `--allow-production` flag for the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command, which allows the user to run the command even with `prod` and `production` environments (by default, the command doesn't allow that). -Speaking of the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command, we've also made the logs displayed in the **Deploy** pane a bit cleaner and nicer: +Speaking of the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command, we've also made the logs displayed in the **Deploy** pane a bit cleaner and nicer: diff --git a/docs/release-notes/5.16.0/upgrade-guide.mdx b/docs/release-notes/5.16.0/upgrade-guide.mdx index fc0a5c0f6..19ce45b87 100644 --- a/docs/release-notes/5.16.0/upgrade-guide.mdx +++ b/docs/release-notes/5.16.0/upgrade-guide.mdx @@ -73,6 +73,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.17.0/upgrade-guide.mdx b/docs/release-notes/5.17.0/upgrade-guide.mdx index 52744b5fd..786d06f8b 100644 --- a/docs/release-notes/5.17.0/upgrade-guide.mdx +++ b/docs/release-notes/5.17.0/upgrade-guide.mdx @@ -95,7 +95,7 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.18.0/changelog.mdx b/docs/release-notes/5.18.0/changelog.mdx index f4f1f321f..3d3f5212c 100644 --- a/docs/release-notes/5.18.0/changelog.mdx +++ b/docs/release-notes/5.18.0/changelog.mdx @@ -50,7 +50,7 @@ We really hope you'll give this new version of Webiny Serverless CMS a try and t ### Overhaul of Existing Development Tools ([#1990](https://github.com/webiny/webiny-js/pull/1990), [#2028](https://github.com/webiny/webiny-js/pull/2028), [#1998](https://github.com/webiny/webiny-js/pull/1998), [#1989](https://github.com/webiny/webiny-js/pull/1989)) -A complete overhaul was done on the most important development-related Webiny CLI commands - [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) and [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command). In short, you can expect both of these to be faster and also consume significantly less system resources. +A complete overhaul was done on the most important development-related Webiny CLI commands - [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) and [`webiny watch`](/docs/core-development-concepts/basics/watch-command). In short, you can expect both of these to be faster and also consume significantly less system resources. In case you would like to learn more, feel free to check out the links to closed pull requests: @@ -83,7 +83,7 @@ For more information on this change, make sure to check out the [Additional Info ### Pulumi Command - Improved Handling of `--json` Flag -Previously, when invoking the Pulumi CLI via the [`webiny pulumi`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-pulumi-folder---env-env----command) command and passing the `--json` flag to it, the final output would still include informative messages: +Previously, when invoking the Pulumi CLI via the [`webiny pulumi`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-pulumi-folder---env-env----command) command and passing the `--json` flag to it, the final output would still include informative messages: ![Inappropriate output of the webiny pulumi command.](./images/pulumi-cli-json-issue.png) @@ -101,7 +101,7 @@ The existing `--logs` flag now serves a different purpose - it enables the code -Learn more about remote runtime logs (logs forwarding) in the [Use the Watch Command](/docs/{version}/core-development-concepts/basics/watch-command#enabling-logs-forwarding) how-to guide. +Learn more about remote runtime logs (logs forwarding) in the [Use the Watch Command](/docs/core-development-concepts/basics/watch-command#enabling-logs-forwarding) how-to guide. @@ -111,7 +111,7 @@ Learn more about remote runtime logs (logs forwarding) in the [Use the Watch Com The existing `InstallationPlugin`, `CmsContentModelHookPlugin` and `CmsContentEntryHookPlugin` plugins, used to hook into the lifecycle of the Headless CMS installation process, content models and content entries, were removed and replaced with a simpler publish/subscribe (pub/sub) approach. -To learn more more about it, please read our [Lifecycle Events](/docs/{version}/headless-cms/references/lifecycle-events) key topic. +To learn more more about it, please read our [Lifecycle Events](/docs/headless-cms/references/lifecycle-events) key topic. ### Renamed Plugins, Types and Interfaces diff --git a/docs/release-notes/5.18.0/upgrade-guide.mdx b/docs/release-notes/5.18.0/upgrade-guide.mdx index 007b9d606..874e291b9 100644 --- a/docs/release-notes/5.18.0/upgrade-guide.mdx +++ b/docs/release-notes/5.18.0/upgrade-guide.mdx @@ -67,7 +67,7 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.19.0/changelog.mdx b/docs/release-notes/5.19.0/changelog.mdx index 93cefc17d..3953f2a98 100644 --- a/docs/release-notes/5.19.0/changelog.mdx +++ b/docs/release-notes/5.19.0/changelog.mdx @@ -16,7 +16,7 @@ In attempt to make things a bit more stable, we've decided to put a lock on the -`@pulumi/*` NPM packages are being utilized by Pulumi, the underlying infrastructure-as-code (IaC) solution Webiny relies on. To learn more, check out the [Infrastructure as Code With Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) key topic. +`@pulumi/*` NPM packages are being utilized by Pulumi, the underlying infrastructure-as-code (IaC) solution Webiny relies on. To learn more, check out the [Infrastructure as Code With Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi) key topic. @@ -34,7 +34,7 @@ Thank you goes to [**@snstanton**](https://github.com/snstanton) for discovering ### Fixed Incorrect AWS Profile Being Logged During Deployment ([#2078](https://github.com/webiny/webiny-js/pull/2078)) -In order to use the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, AWS credentials need to be set, which can be done in [multiple ways](/docs/{version}/infrastructure/aws/configure-aws-credentials). +In order to use the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command, AWS credentials need to be set, which can be done in [multiple ways](/docs/infrastructure/aws/configure-aws-credentials). When relying on environment variables, users can choose to either use a combination of `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`, or a single `AWS_PROFILE` variable. In case of the former, we've noticed that, during deployment, an incorrect message would get displayed in the terminal, saying AWS profile "undefined" is being used. @@ -56,7 +56,7 @@ The `acl` property lets you set **Canned ACL** for every uploaded file. To learn ### `webiny deploy` Command - Introduced `--deploy` Flag ([#2096](https://github.com/webiny/webiny-js/pull/2096)) -A new `--deploy` flag has been added to the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment). +A new `--deploy` flag has been added to the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment). By setting it to false (by passing `--no-deploy`), this small addition allows users to skip the deployment step, which can be useful if they only want to build the specified project application. For example: @@ -66,7 +66,7 @@ yarn webiny deploy api --env dev --no-deploy ### `webiny watch` Command - Fixed Multiline Logs ([#2103](https://github.com/webiny/webiny-js/pull/2103)) -Previously, if you were to add multiline logs in your cloud infrastructure (Pulumi) code, the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command#can-i-use-the-webiny-watch-command-to-start-a-watch-process-on-frontend-react-apps) command's terminal output would get truncated. This has now been addressed, so you can freely add any additional multiline logs that you might need. +Previously, if you were to add multiline logs in your cloud infrastructure (Pulumi) code, the [`webiny watch`](/docs/core-development-concepts/basics/watch-command#can-i-use-the-webiny-watch-command-to-start-a-watch-process-on-frontend-react-apps) command's terminal output would get truncated. This has now been addressed, so you can freely add any additional multiline logs that you might need. ![The highlight of this release - the new Amazon DynamoDB-only version of Webiny!](./images/truncation-fixed.png) diff --git a/docs/release-notes/5.19.0/upgrade-guide.mdx b/docs/release-notes/5.19.0/upgrade-guide.mdx index 21e3950ca..4241a3a7b 100644 --- a/docs/release-notes/5.19.0/upgrade-guide.mdx +++ b/docs/release-notes/5.19.0/upgrade-guide.mdx @@ -73,6 +73,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.19.1/upgrade-guide.mdx b/docs/release-notes/5.19.1/upgrade-guide.mdx index ceec94670..23ca4fd90 100644 --- a/docs/release-notes/5.19.1/upgrade-guide.mdx +++ b/docs/release-notes/5.19.1/upgrade-guide.mdx @@ -57,6 +57,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.20.0/changelog.mdx b/docs/release-notes/5.20.0/changelog.mdx index f9dd368f8..f43922b86 100644 --- a/docs/release-notes/5.20.0/changelog.mdx +++ b/docs/release-notes/5.20.0/changelog.mdx @@ -22,7 +22,7 @@ We've resolved an issue that would occur when a user created a content model pro -To learn more about creating content models via code, check out the [Define Content Models via Code](/docs/{version}/headless-cms/extending/content-models-via-code) guide. +To learn more about creating content models via code, check out the [Define Content Models via Code](/docs/headless-cms/extending/content-models-via-code) guide. @@ -91,7 +91,7 @@ The `PagePlugin` plugin that was previously used is no longer supported. If you' ### Fixed `webiny watch` Command's `--remoteRuntimeLogs` (`-r`) Argument ([#2124](https://github.com/webiny/webiny-js/pull/2124)) -In a couple of scenarios, upon running the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command, adding the `--remoteRuntimeLogs` (`-r`) argument would not properly return runtime logs in user's terminal. This has now been addressed. +In a couple of scenarios, upon running the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command, adding the `--remoteRuntimeLogs` (`-r`) argument would not properly return runtime logs in user's terminal. This has now been addressed. ### Fixed React Component Scaffold's `webiny.config.ts` File ([#2123](https://github.com/webiny/webiny-js/pull/2123)) @@ -99,7 +99,7 @@ The [`webiny.config.ts`](https://github.com/webiny/webiny-js/blob/next/packages/ ### Two New `webiny deploy` Hooks ([#2079](https://github.com/webiny/webiny-js/pull/2079)) -You can now hook onto the pre-build and post-build events that are emitted during the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command. More information about all related hooks can be found in the new [Build and Deploy Hooks](/docs/{version}/infrastructure/basics/build-and-deploy-hooks) guide. +You can now hook onto the pre-build and post-build events that are emitted during the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command. More information about all related hooks can be found in the new [Build and Deploy Hooks](/docs/infrastructure/basics/build-and-deploy-hooks) guide. ## Documentation diff --git a/docs/release-notes/5.20.0/upgrade-guide.mdx b/docs/release-notes/5.20.0/upgrade-guide.mdx index 1766aad7a..9e3dd293a 100644 --- a/docs/release-notes/5.20.0/upgrade-guide.mdx +++ b/docs/release-notes/5.20.0/upgrade-guide.mdx @@ -57,6 +57,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.21.0/changelog.mdx b/docs/release-notes/5.21.0/changelog.mdx index 00c5d28f8..a48e01ee8 100644 --- a/docs/release-notes/5.21.0/changelog.mdx +++ b/docs/release-notes/5.21.0/changelog.mdx @@ -70,11 +70,11 @@ A good example of this can be found in our [Extend Page Settings](/docs/page-bui ### Added Webiny Version Header To GraphQL Response ([#2143](https://github.com/webiny/webiny-js/pull/2143)) -We added the Webiny version header to every GraphQL response. By default, header is not added. To add it into the output, read our article about [environment variables](/docs/{version}/core-development-concepts/basics/environment-variables#enable-webiny-version-header-environment-variable). +We added the Webiny version header to every GraphQL response. By default, header is not added. To add it into the output, read our article about [environment variables](/docs/core-development-concepts/basics/environment-variables#enable-webiny-version-header-environment-variable). ### Stop The Deploy Process On Errors in Deploy Hooks ([#2161](https://github.com/webiny/webiny-js/pull/2161)) -Prior to this PR, if one of the [deploy hooks](/docs/{version}/infrastructure/basics/build-and-deploy-hooks) threw an error, the deploy process would not be stopped, which is incorrect. This PR ensures that any error encountered in the deploy process, including hooks, will stop the whole deploy process. +Prior to this PR, if one of the [deploy hooks](/docs/infrastructure/basics/build-and-deploy-hooks) threw an error, the deploy process would not be stopped, which is incorrect. This PR ensures that any error encountered in the deploy process, including hooks, will stop the whole deploy process. ## Visual Improvements diff --git a/docs/release-notes/5.21.0/upgrade-guide.mdx b/docs/release-notes/5.21.0/upgrade-guide.mdx index 5d210f392..fc2093eb2 100644 --- a/docs/release-notes/5.21.0/upgrade-guide.mdx +++ b/docs/release-notes/5.21.0/upgrade-guide.mdx @@ -67,6 +67,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.22.0/upgrade-guide.mdx b/docs/release-notes/5.22.0/upgrade-guide.mdx index 0f23560e4..83ba18b01 100644 --- a/docs/release-notes/5.22.0/upgrade-guide.mdx +++ b/docs/release-notes/5.22.0/upgrade-guide.mdx @@ -66,6 +66,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.22.1/upgrade-guide.mdx b/docs/release-notes/5.22.1/upgrade-guide.mdx index 7406d8915..c85720e64 100644 --- a/docs/release-notes/5.22.1/upgrade-guide.mdx +++ b/docs/release-notes/5.22.1/upgrade-guide.mdx @@ -46,6 +46,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.23.0/upgrade-guide.mdx b/docs/release-notes/5.23.0/upgrade-guide.mdx index 44b7265f1..4a785a648 100644 --- a/docs/release-notes/5.23.0/upgrade-guide.mdx +++ b/docs/release-notes/5.23.0/upgrade-guide.mdx @@ -65,6 +65,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.24.0/upgrade-guide.mdx b/docs/release-notes/5.24.0/upgrade-guide.mdx index b2dca7db3..7cba8ace5 100644 --- a/docs/release-notes/5.24.0/upgrade-guide.mdx +++ b/docs/release-notes/5.24.0/upgrade-guide.mdx @@ -53,6 +53,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.25.0/upgrade-guide.mdx b/docs/release-notes/5.25.0/upgrade-guide.mdx index cfeb10fb1..4fdfe6a28 100644 --- a/docs/release-notes/5.25.0/upgrade-guide.mdx +++ b/docs/release-notes/5.25.0/upgrade-guide.mdx @@ -59,6 +59,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.26.0/changelog.mdx b/docs/release-notes/5.26.0/changelog.mdx index 50c3434f5..734c6f61a 100644 --- a/docs/release-notes/5.26.0/changelog.mdx +++ b/docs/release-notes/5.26.0/changelog.mdx @@ -46,14 +46,14 @@ The check is still being run on the API side, but this way we do not need to cal ### Customize The Elasticsearch Index Settings And Mappings For Your Deployment ([#2316](https://github.com/webiny/webiny-js/pull/2316)) We added plugins to customize your Elasticsearch Index creation for any of our applications. -To find out more, read [How To Customize Elasticsearch Index](/docs/{version}/core-development-concepts/extending-and-customizing/how-to-customize-elasticsearch-index). +To find out more, read [How To Customize Elasticsearch Index](/docs/core-development-concepts/extending-and-customizing/how-to-customize-elasticsearch-index). ### Split The Elasticsearch Index For Each Of The Locales ([#2323](https://github.com/webiny/webiny-js/pull/2323)) We added an option to split each Elasticsearch Index to per-locale one. In all new Webiny deployments where the Elasticsearch is used, it is the default behavior. -On all old systems, if you want to change how the indexes are created, and change the existing ones, please read [How To Change Elasticsearch Index Name To Contain Locale](/docs/{version}/core-development-concepts/extending-and-customizing/how-to-change-elasticsearch-index-name-to-contain-locale). +On all old systems, if you want to change how the indexes are created, and change the existing ones, please read [How To Change Elasticsearch Index Name To Contain Locale](/docs/core-development-concepts/extending-and-customizing/how-to-change-elasticsearch-index-name-to-contain-locale). ### Add Japanese Elasticsearch Index Configuration ([#2326](https://github.com/webiny/webiny-js/pull/2326)) diff --git a/docs/release-notes/5.26.0/upgrade-guide.mdx b/docs/release-notes/5.26.0/upgrade-guide.mdx index d4eb38d2e..2ae3a8c6b 100644 --- a/docs/release-notes/5.26.0/upgrade-guide.mdx +++ b/docs/release-notes/5.26.0/upgrade-guide.mdx @@ -59,6 +59,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.27.0/upgrade-guide.mdx b/docs/release-notes/5.27.0/upgrade-guide.mdx index 12cc0a565..5daa14d04 100644 --- a/docs/release-notes/5.27.0/upgrade-guide.mdx +++ b/docs/release-notes/5.27.0/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.28.0/upgrade-guide.mdx b/docs/release-notes/5.28.0/upgrade-guide.mdx index dddbe9144..7329150b7 100644 --- a/docs/release-notes/5.28.0/upgrade-guide.mdx +++ b/docs/release-notes/5.28.0/upgrade-guide.mdx @@ -59,6 +59,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.29.0/changelog.mdx b/docs/release-notes/5.29.0/changelog.mdx index 574bcca59..2a379079f 100644 --- a/docs/release-notes/5.29.0/changelog.mdx +++ b/docs/release-notes/5.29.0/changelog.mdx @@ -100,13 +100,13 @@ When it comes to existing Webiny projects, at the moment, there isn't an upgrade ### Removed Unnecessary Files and Folders -Prior to this release, once a new Webiny project has been created, developers would immediately be presented with (or intimidated by) lots of different folders and files. For example, if we were to look into the [`api`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code) folder ([the API project application](/docs/{version}/architecture/api/overview)), we would be able to find five different folders which contain application code for 14 different AWS Lambda functions. Together, these functions form Webiny's GraphQL APIs. +Prior to this release, once a new Webiny project has been created, developers would immediately be presented with (or intimidated by) lots of different folders and files. For example, if we were to look into the [`api`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code) folder ([the API project application](/docs/architecture/api/overview)), we would be able to find five different folders which contain application code for 14 different AWS Lambda functions. Together, these functions form Webiny's GraphQL APIs. And while this approach does give developers the ability to customize every aspect of Webiny, in practice, we've learned that the majority of these are not really something developers are concerned with. When talking about the [`api`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code) folder, almost always, the only two folders developers change are [`api/code/graphql`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code/graphql) and [`api/code/headlessCms`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code/headlessCms). -The [`api/code/graphql`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code/graphql) and [`api/code/headlessCms`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code/headlessCms) folders contain code for the two GraphQL APIs - the Main GraphQL API and the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/using-graphql-api). +The [`api/code/graphql`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code/graphql) and [`api/code/headlessCms`](https://github.com/webiny/webiny-js/tree/v5.28.0/api/code/headlessCms) folders contain code for the two GraphQL APIs - the Main GraphQL API and the [Headless CMS GraphQL API](/docs/headless-cms/basics/using-graphql-api). @@ -121,7 +121,7 @@ With this, and a couple of other use cases in mind, we've decided to drastically With the changes listed in the [Removed Unnecessary Files and Folders](/docs/release-notes/5.29.0/changelog#removed-unnecessary-files-and-folders) section in mind, one might ask themselves: -> If there are only 2 AWS Lambda functions in my [API project application](/docs/{version}/architecture/api/overview) now, what happened to other 12? Do they still exist? +> If there are only 2 AWS Lambda functions in my [API project application](/docs/architecture/api/overview) now, what happened to other 12? Do they still exist? Well, these functions still do exist, but, from now on, they will actually be prebuilt for developers' projects! @@ -131,11 +131,11 @@ To be more precise, you can expect a **~70%** reduction in time it takes to buil ### API Project Application Moved To `apps` Folder -Previously, the `api` folder ([the API project application](/docs/{version}/architecture/api/overview)) was located in the project root. This is no longer the case. All project applications are now located in the [`apps`](https://github.com/webiny/webiny-js/tree/v5/apps) folder. +Previously, the `api` folder ([the API project application](/docs/architecture/api/overview)) was located in the project root. This is no longer the case. All project applications are now located in the [`apps`](https://github.com/webiny/webiny-js/tree/v5/apps) folder. -Learn more about project applications and project organization in general, in the [Project Applications and Packages](/docs/{version}/core-development-concepts/project-organization/project-applications-and-packages) key topic. +Learn more about project applications and project organization in general, in the [Project Applications and Packages](/docs/core-development-concepts/project-organization/project-applications-and-packages) key topic. @@ -143,7 +143,7 @@ Learn more about project applications and project organization in general, in th With this release, we are introducing the new [Core](https://github.com/webiny/webiny-js/tree/v5/apps/core) project application, whose main purpose is to define and encapsulate the stateful cloud infrastructure resources. These are your [Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Introduction.html) and [Amazon Elasticsearch](https://aws.amazon.com/opensearch-service/) databases, [Amazon S3](https://aws.amazon.com/s3/) for storing files, [Amazon Cognito](https://aws.amazon.com/cognito/) for user information, and also [Amazon EventBridge](https://aws.amazon.com/eventbridge/) which we've introduced with this release, to manage events via event buses. -The [API project application](/docs/{version}/architecture/api/overview) still exists, but, from now on, it strictly defines the stateless resources responsible for hosting your project's GraphQL APIs. These include [Amazon API Gateway](https://aws.amazon.com/api-gateway/), [Amazon Cloudfront](https://aws.amazon.com/cloudfront/), and multiple [AWS Lambda](https://aws.amazon.com/lambda/) functions. +The [API project application](/docs/architecture/api/overview) still exists, but, from now on, it strictly defines the stateless resources responsible for hosting your project's GraphQL APIs. These include [Amazon API Gateway](https://aws.amazon.com/api-gateway/), [Amazon Cloudfront](https://aws.amazon.com/cloudfront/), and multiple [AWS Lambda](https://aws.amazon.com/lambda/) functions. This new organization will enable us to create some really interesting features in the near future, so stay tuned for that! @@ -207,7 +207,7 @@ This one belongs to the "small annoyances" department. The issue was only visibl ### Removed Pulumi Version Restriction -Prior to this release, via the project root's [`package.json`](https://github.com/webiny/webiny-js/blob/v5.28.0/packages/cwp-template-aws/template/ddb/dependencies.json#L92-L93) file and its `resolutions` property, the versions of Pulumi NPM packages were locked for quite some time now. As the time passed by, these versions became more and more outdated, so we made sure this is no longer the case. From now on, every Webiny project will be accompanied by the latest version of the [Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) CLI and related NPM packages. +Prior to this release, via the project root's [`package.json`](https://github.com/webiny/webiny-js/blob/v5.28.0/packages/cwp-template-aws/template/ddb/dependencies.json#L92-L93) file and its `resolutions` property, the versions of Pulumi NPM packages were locked for quite some time now. As the time passed by, these versions became more and more outdated, so we made sure this is no longer the case. From now on, every Webiny project will be accompanied by the latest version of the [Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi) CLI and related NPM packages. ### Automatic Download of Pulumi Resource Plugin diff --git a/docs/release-notes/5.29.0/project-setup-migration.mdx b/docs/release-notes/5.29.0/project-setup-migration.mdx index b8666593b..1fe3abeba 100644 --- a/docs/release-notes/5.29.0/project-setup-migration.mdx +++ b/docs/release-notes/5.29.0/project-setup-migration.mdx @@ -128,7 +128,7 @@ With the new project structure, all of the project applications are located with 3. **Admin** ([`apps/admin/webiny.application.ts`](https://github.com/webiny/webiny-js/blob/v5.29.0/packages/cwp-template-aws/template/common/apps/admin/webiny.application.ts)) 4. **Website** ([`apps/website/webiny.application.ts`](https://github.com/webiny/webiny-js/blob/v5.29.0/packages/cwp-template-aws/template/common/apps/website/webiny.application.ts)) -These are the files via which the cloud infrastructure adjustments can be applied. To learn more, we suggest you take a look at the [Modify Cloud Infrastructure](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure) +These are the files via which the cloud infrastructure adjustments can be applied. To learn more, we suggest you take a look at the [Modify Cloud Infrastructure](/docs/infrastructure/basics/modify-cloud-infrastructure) ### 3. Pulumi State Files Migration @@ -149,7 +149,7 @@ In the new project, we now have four project apps, thus four sets of state files -More info on the new cloud architecture can be found [here](https://www.webiny.com/docs/{version}/architecture/introduction). +More info on the new cloud architecture can be found [here](https://www.webiny.com/docs/architecture/introduction). diff --git a/docs/release-notes/5.29.0/upgrade-guide.mdx b/docs/release-notes/5.29.0/upgrade-guide.mdx index 2f7685d71..d2b91b2ca 100644 --- a/docs/release-notes/5.29.0/upgrade-guide.mdx +++ b/docs/release-notes/5.29.0/upgrade-guide.mdx @@ -65,6 +65,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.3.0/changelog.mdx b/docs/release-notes/5.3.0/changelog.mdx index 3caf55911..4e66d4380 100644 --- a/docs/release-notes/5.3.0/changelog.mdx +++ b/docs/release-notes/5.3.0/changelog.mdx @@ -12,7 +12,7 @@ This document highlights the most important fixes, improvements, and features, t ### Improved the `contains` GraphQL Operator [(#1531)](https://github.com/webiny/webiny-js/pull/1531) -While querying data via the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api), and using the `contains` query operator on a **text** field, [reserved ElasticSearch characters](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters) are now properly escaped. Without it, users could receive unexpected results or even errors, thrown by the ElasticSearch itself. +While querying data via the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api), and using the `contains` query operator on a **text** field, [reserved ElasticSearch characters](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters) are now properly escaped. Without it, users could receive unexpected results or even errors, thrown by the ElasticSearch itself. ### Fixed Search Bar [(#1532)](https://github.com/webiny/webiny-js/pull/1532) diff --git a/docs/release-notes/5.30.0/changelog.mdx b/docs/release-notes/5.30.0/changelog.mdx index e896619de..88b089f35 100644 --- a/docs/release-notes/5.30.0/changelog.mdx +++ b/docs/release-notes/5.30.0/changelog.mdx @@ -65,7 +65,7 @@ export default createWebsiteApp({ ### `webiny watch` Command - Redeploying Now Works Correctly ([#2538](https://github.com/webiny/webiny-js/pull/2538)) -With the [5.29.0](/docs/release-notes/5.29.0/changelog) release, a regression was introduced to the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command. +With the [5.29.0](/docs/release-notes/5.29.0/changelog) release, a regression was introduced to the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command. Instead of redeploying the AWS Lambda function code once after a source code change has been applied, the command would redeploy it twice. diff --git a/docs/release-notes/5.30.0/upgrade-guide.mdx b/docs/release-notes/5.30.0/upgrade-guide.mdx index 34b379d3f..ea0700163 100644 --- a/docs/release-notes/5.30.0/upgrade-guide.mdx +++ b/docs/release-notes/5.30.0/upgrade-guide.mdx @@ -65,6 +65,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.31.0/changelog.mdx b/docs/release-notes/5.31.0/changelog.mdx index bc61ae7f7..741bb77db 100644 --- a/docs/release-notes/5.31.0/changelog.mdx +++ b/docs/release-notes/5.31.0/changelog.mdx @@ -17,7 +17,7 @@ With this version, we switched all event routing and normalization to [Fastify]( This change will also help us refactor the system to use one Lambda function for handling of various GraphQL schemas, and share the entire Webiny context (all app SDKs) within a single Lambda event lifecycle. This means easier maintenance, easier customization, easier integration with various Webiny lifecycle events, etc. -To find out more about the new handlers, read our [Routes and Events](/docs/{version}/core-development-concepts/basics/routes-and-events) article. +To find out more about the new handlers, read our [Routes and Events](/docs/core-development-concepts/basics/routes-and-events) article. ### Make all S3 buckets private [#2558](https://github.com/webiny/webiny-js/pull/2558) @@ -80,8 +80,8 @@ Terraform (used internally by Pulumi), has [some issues](https://yaleman.org/pos ### CI/CD Scaffold Improvements ([#2586](https://github.com/webiny/webiny-js/pull/2586)) -For this release, we've also revisited the existing [CI/CD scaffold](/docs/{version}/core-development-concepts/ci-cd/setup), which sets up essential CI/CD workflows for your Webiny project. +For this release, we've also revisited the existing [CI/CD scaffold](/docs/core-development-concepts/ci-cd/setup), which sets up essential CI/CD workflows for your Webiny project. The main improvement we've implemented is the ability to use the scaffold with any type of a GitHub account and repository. Previously, the scaffold only worked with public repositories and private repositories under a GitHub Enterprise account. -The scaffold's [documentation](/docs/{version}/core-development-concepts/ci-cd/setup) has also been updated, so make sure to check it out if you'll be giving the scaffold another chance. +The scaffold's [documentation](/docs/core-development-concepts/ci-cd/setup) has also been updated, so make sure to check it out if you'll be giving the scaffold another chance. diff --git a/docs/release-notes/5.31.0/upgrade-guide.mdx b/docs/release-notes/5.31.0/upgrade-guide.mdx index 709961236..d1bb0b9fc 100644 --- a/docs/release-notes/5.31.0/upgrade-guide.mdx +++ b/docs/release-notes/5.31.0/upgrade-guide.mdx @@ -71,6 +71,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.32.0/changelog.mdx b/docs/release-notes/5.32.0/changelog.mdx index 78134c0b1..2a4df2e1d 100644 --- a/docs/release-notes/5.32.0/changelog.mdx +++ b/docs/release-notes/5.32.0/changelog.mdx @@ -11,7 +11,7 @@ import dashboardWidgets from "./assets/dashboard-widgets.png"; ### Watch Command - Removed Redundant Logs ([#2603](https://github.com/webiny/webiny-js/pull/2603)) -When running the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command with the [logs forwarding option](/docs/{version}/core-development-concepts/basics/watch-command#enabling-logs-forwarding), except for the actual logs, developers would also receive the underlying local tunnel URL, over which the logs would get forwarded to the developer's machine. +When running the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command with the [logs forwarding option](/docs/core-development-concepts/basics/watch-command#enabling-logs-forwarding), except for the actual logs, developers would also receive the underlying local tunnel URL, over which the logs would get forwarded to the developer's machine. @@ -19,7 +19,7 @@ With this release, the redundant URL won't be appearing anymore. ### Destroy Command Now Works Even If the Project Wasn't Previously Deployed -With this release, we've fixed an issue with the [`webiny destroy`](/docs/{version}/infrastructure/basics/destroy-cloud-infrastructure) command, where, in order for it to work correctly, a Webiny project application had to be previously deployed. +With this release, we've fixed an issue with the [`webiny destroy`](/docs/infrastructure/basics/destroy-cloud-infrastructure) command, where, in order for it to work correctly, a Webiny project application had to be previously deployed. This is no longer the case. A Webiny project application doesn't need to be previously deployed in order for the command to work. @@ -27,27 +27,27 @@ Thanks goes to [@ryohei-kamiya](https://github.com/ryohei-kamiya) for discoverin -Learn more about project applications and project organization in general, in the [Project Applications and Packages](/docs/{version}/core-development-concepts/project-organization/project-applications-and-packages) key topic. +Learn more about project applications and project organization in general, in the [Project Applications and Packages](/docs/core-development-concepts/project-organization/project-applications-and-packages) key topic. ### CI/CD Scaffold - Workflow Files Are Now Correctly Deployed ([#2601](https://github.com/webiny/webiny-js/pull/2601)) -Prior to this release, upon using the [CI/CD scaffold](/docs/{version}/core-development-concepts/ci-cd/setup), the GitHub Actions workflow files would not be correctly generated in developer's GitHub repository. +Prior to this release, upon using the [CI/CD scaffold](/docs/core-development-concepts/ci-cd/setup), the GitHub Actions workflow files would not be correctly generated in developer's GitHub repository. This has now been addressed. All the GitHub Actions workflow files should be generated correctly. ### Watch Command - Introduced the `hook-before-watch` Lifecycle Event ([#2607](https://github.com/webiny/webiny-js/pull/2607)) -We've introduced the new `hook-before-watch` lifecycle event to the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command. +We've introduced the new `hook-before-watch` lifecycle event to the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command. -The [Build and Deploy Hooks](/docs/{version}/infrastructure/basics/build-and-deploy-hooks) has been updated to reflect this change, so check it out to learn more. +The [Build and Deploy Hooks](/docs/infrastructure/basics/build-and-deploy-hooks) has been updated to reflect this change, so check it out to learn more. ### Ensure WCP-related Environment Variables Are Correctly Assigned With the Watch Command ([#2609](https://github.com/webiny/webiny-js/pull/2609)) -While using the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command, we've noticed that the relevant Webiny Control Panel (WCP) environment variables would get removed from the previously deployed AWS Lambda functions, which causes the link between developer's Webiny project and WCP to be temporarily broken. +While using the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command, we've noticed that the relevant Webiny Control Panel (WCP) environment variables would get removed from the previously deployed AWS Lambda functions, which causes the link between developer's Webiny project and WCP to be temporarily broken. -This has now been addressed. The link between the Webiny project and WCP should stay persistent, no matter if the project has been deployed via the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, or a developer is just doing development with the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command. +This has now been addressed. The link between the Webiny project and WCP should stay persistent, no matter if the project has been deployed via the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command, or a developer is just doing development with the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command. ## Admin App diff --git a/docs/release-notes/5.32.0/upgrade-guide.mdx b/docs/release-notes/5.32.0/upgrade-guide.mdx index 9838a5f6b..91b3f2b31 100644 --- a/docs/release-notes/5.32.0/upgrade-guide.mdx +++ b/docs/release-notes/5.32.0/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.33.0/changelog.mdx b/docs/release-notes/5.33.0/changelog.mdx index 65b8d0de6..cb238663a 100644 --- a/docs/release-notes/5.33.0/changelog.mdx +++ b/docs/release-notes/5.33.0/changelog.mdx @@ -14,7 +14,7 @@ import cmsContext from "./assets/cms-context.png"; Starting with the v5.33.0, we are allowing our users to change the `Field ID` (`fieldId`) property of the CMS Model Field definition, which serves as the field identifier in the GraphQL API and in the code. As the `fieldId` property is now changeable, we needed another property to identify the field in the database, so we introduced the `storageId` property. -If you have existing CMS Models defined via plugins, please read the **Upgrading CMS Model Plugin Definitions** of [this](/docs/{version}/headless-cms/extending/content-models-via-code-storage-id#upgrading-cms-model-plugin-definitions) article before you start the upgrade. +If you have existing CMS Models defined via plugins, please read the **Upgrading CMS Model Plugin Definitions** of [this](/docs/headless-cms/extending/content-models-via-code-storage-id#upgrading-cms-model-plugin-definitions) article before you start the upgrade. ## Development @@ -149,13 +149,13 @@ This issue has been addressed. Upon doing a new deployment, you can expect to se With the VPC option enabled or with the production deployment mode, the `AWSLambdaVPCAccessExecutionRole` policy will still be used, as usual. -To learn more about different deployment modes, check out the [Deployment Modes](/docs/{version}/architecture/deployment-modes/introduction) article. +To learn more about different deployment modes, check out the [Deployment Modes](/docs/architecture/deployment-modes/introduction) article. ### Webiny CLI - Easier to Debug AWS-related Auth Errors ([#2677](https://github.com/webiny/webiny-js/pull/2677)) -Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, if a user experienced an AWS auth-related error, it was hard to debug it. Mainly because the actual underlying error wasn't printed in the terminal, even in the presence of the `--debug` flag. +Upon running the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command, if a user experienced an AWS auth-related error, it was hard to debug it. Mainly because the actual underlying error wasn't printed in the terminal, even in the presence of the `--debug` flag. That is no longer the case. From now on, by passing the `--debug` flag upon running the command, users will be able to see the actual underlying error and, hopefully, resolve the issue faster than before. diff --git a/docs/release-notes/5.33.0/upgrade-guide.mdx b/docs/release-notes/5.33.0/upgrade-guide.mdx index 3d5ef3ce0..8d56b6a05 100644 --- a/docs/release-notes/5.33.0/upgrade-guide.mdx +++ b/docs/release-notes/5.33.0/upgrade-guide.mdx @@ -38,7 +38,7 @@ If you do not have CMS Models defined via code (via `CmsModelPlugin`), you can s Since we introduced a new property, `storageId`, into CMS Model Field definition, you must add it to your existing CMS Model Field definitions. This is only for the CMS models which are created prior to the 5.33.0. -Please read the **Upgrading CMS Model Plugin Definitions** of [this](/docs/{version}/headless-cms/extending/content-models-via-code-storage-id#upgrading-cms-model-plugin-definitions) article. +Please read the **Upgrading CMS Model Plugin Definitions** of [this](/docs/headless-cms/extending/content-models-via-code-storage-id#upgrading-cms-model-plugin-definitions) article. ## 3. Deploy Your Project @@ -71,6 +71,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.33.1/upgrade-guide.mdx b/docs/release-notes/5.33.1/upgrade-guide.mdx index ae2dc7418..0db0be26a 100644 --- a/docs/release-notes/5.33.1/upgrade-guide.mdx +++ b/docs/release-notes/5.33.1/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.33.2/changelog.mdx b/docs/release-notes/5.33.2/changelog.mdx index ab6539682..9c1ae86c1 100644 --- a/docs/release-notes/5.33.2/changelog.mdx +++ b/docs/release-notes/5.33.2/changelog.mdx @@ -38,19 +38,19 @@ This now allows users to access raw `where` object, received from the GraphQL. ### Updated "Deploy Webiny Project" CloudFormation Template ([#2773](https://github.com/webiny/webiny-js/pull/2773)) -In order to reflect the changes we've recently introduced in the cloud infrastructure that Webiny deploys, with this release, we've revisited the `DeployWebinyProject` [AWS CloudFormation template](/docs/{version}/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template) and updated the set of permissions it deploys. With these updates, users should now be able to use the template and expect their Webiny project to be fully deployed. +In order to reflect the changes we've recently introduced in the cloud infrastructure that Webiny deploys, with this release, we've revisited the `DeployWebinyProject` [AWS CloudFormation template](/docs/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template) and updated the set of permissions it deploys. With these updates, users should now be able to use the template and expect their Webiny project to be fully deployed.

-In case you've already deployed the previous version of the `DeployWebinyProject` AWS CloudFormation template, we suggest you first destroy the deployed stack, via the AWS Console. Then, via the link to the [AWS CloudFormation template](/docs/{version}/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template), you again perform a fresh deploy. +In case you've already deployed the previous version of the `DeployWebinyProject` AWS CloudFormation template, we suggest you first destroy the deployed stack, via the AWS Console. Then, via the link to the [AWS CloudFormation template](/docs/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template), you again perform a fresh deploy. -In case you missed it, in order to deploy your Webiny project in a more controlled and secure manner, you can utilize our `DeployWebinyProject` [AWS CloudFormation template](/docs/{version}/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template). The template deploys necessary ([least-privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege)) set of permissions into your AWS account, which also automatically get linked with an Amazon IAM user of your choosing (the user you plan to use upon running deployments). +In case you missed it, in order to deploy your Webiny project in a more controlled and secure manner, you can utilize our `DeployWebinyProject` [AWS CloudFormation template](/docs/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template). The template deploys necessary ([least-privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege)) set of permissions into your AWS account, which also automatically get linked with an Amazon IAM user of your choosing (the user you plan to use upon running deployments). diff --git a/docs/release-notes/5.33.2/upgrade-guide.mdx b/docs/release-notes/5.33.2/upgrade-guide.mdx index 108a4d768..298fffa76 100644 --- a/docs/release-notes/5.33.2/upgrade-guide.mdx +++ b/docs/release-notes/5.33.2/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.33.3/changelog.mdx b/docs/release-notes/5.33.3/changelog.mdx index d16546c9e..e185eb676 100644 --- a/docs/release-notes/5.33.3/changelog.mdx +++ b/docs/release-notes/5.33.3/changelog.mdx @@ -13,15 +13,15 @@ import fieldRenderer from "./assets/object-renderer-name.png"; ### Webiny Production Mode - All AWS Lambda Functions Are Now Assigned to VPC ([#2798](https://github.com/webiny/webiny-js/pull/2798)) -When deploying your Webiny project in [production mode](/docs/{version}/architecture/introduction#development-and-production-deployment-modes), for better security posture, all AWS Lambda functions are deployed into a [Virtual Private Cloud (VPC)](https://aws.amazon.com/vpc/) with private subnets. +When deploying your Webiny project in [production mode](/docs/architecture/introduction#development-and-production-deployment-modes), for better security posture, all AWS Lambda functions are deployed into a [Virtual Private Cloud (VPC)](https://aws.amazon.com/vpc/) with private subnets. -And while our initial intention was to have this cloud infrastructure configuration automatically be applied when a project is being [deployed](/docs/{version}/core-development-concepts/basics/project-deployment#the-deploy-command) into the production environment, due to a issue in an internal Webiny package, that just wasn't the case. +And while our initial intention was to have this cloud infrastructure configuration automatically be applied when a project is being [deployed](/docs/core-development-concepts/basics/project-deployment#the-deploy-command) into the production environment, due to a issue in an internal Webiny package, that just wasn't the case. With this release, the issue has been resolved. You can expect all the relevant AWS Lambda functions to be correctly deployed into a VPC when deploying your project into the production environment. -To learn more about development and production deployment modes, check out the [Deployment Modes](/docs/{version}/architecture/deployment-modes/introduction) section. +To learn more about development and production deployment modes, check out the [Deployment Modes](/docs/architecture/deployment-modes/introduction) section. diff --git a/docs/release-notes/5.33.3/upgrade-guide.mdx b/docs/release-notes/5.33.3/upgrade-guide.mdx index 334bb036f..d15f21118 100644 --- a/docs/release-notes/5.33.3/upgrade-guide.mdx +++ b/docs/release-notes/5.33.3/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.33.4/changelog.mdx b/docs/release-notes/5.33.4/changelog.mdx index 02527500d..b5e575820 100644 --- a/docs/release-notes/5.33.4/changelog.mdx +++ b/docs/release-notes/5.33.4/changelog.mdx @@ -10,7 +10,7 @@ import lambdaFunctions from "./assets/lambdaFunctions.png"; ### Improved "Deploy Webiny Project" AWS CloudFormation Template ([#2856](https://github.com/webiny/webiny-js/pull/2856)) -In case you missed it, in our previous [5.33.2](/docs/release-notes/5.33.2/changelog#updated-deploy-webiny-project-cloud-formation-template-2773) release, we've revisited our `DeployWebinyProject` [AWS CloudFormation template](/docs/{version}/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template) and updated the set of permissions it deploys through multiple Amazon IAM policies. +In case you missed it, in our previous [5.33.2](/docs/release-notes/5.33.2/changelog#updated-deploy-webiny-project-cloud-formation-template-2773) release, we've revisited our `DeployWebinyProject` [AWS CloudFormation template](/docs/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template) and updated the set of permissions it deploys through multiple Amazon IAM policies. But, we didn't stop there! With this release, we've taken it even further and ensured that the template and the list of permissions it includes fully follows the [Principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege), making it more secure and easier for organizations to adopt it. @@ -18,13 +18,13 @@ To quickly check out the changes, you can visit our [GitHub repository](https:// -In case you missed it, in order to deploy your Webiny project in a more controlled and secure manner, you can utilize our `DeployWebinyProject` [AWS CloudFormation template](/docs/{version}/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template). The template deploys necessary ([least-privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege)) set of permissions into your AWS account, which also automatically get linked with an Amazon IAM user of your choosing (the user you plan to use upon running deployments). +In case you missed it, in order to deploy your Webiny project in a more controlled and secure manner, you can utilize our `DeployWebinyProject` [AWS CloudFormation template](/docs/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template). The template deploys necessary ([least-privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege)) set of permissions into your AWS account, which also automatically get linked with an Amazon IAM user of your choosing (the user you plan to use upon running deployments). ### Introduced Prefixed Cloud Infrastructure (Pulumi) Resource Names ([#2858](https://github.com/webiny/webiny-js/pull/2858)) -In order to make it easier to distinguish between Webiny-related deployed cloud infrastructure resources and other resources you already might have in your AWS account, apart from the [default tags](/docs/{version}/core-development-concepts/basics/project-deployment#tagged-resources), we're now also prefixing every resource name with the `wby-` prefix. For example, if we were to take a look at the list of deployed AWS Lambda functions, we'd be able to see the following: +In order to make it easier to distinguish between Webiny-related deployed cloud infrastructure resources and other resources you already might have in your AWS account, apart from the [default tags](/docs/core-development-concepts/basics/project-deployment#tagged-resources), we're now also prefixing every resource name with the `wby-` prefix. For example, if we were to take a look at the list of deployed AWS Lambda functions, we'd be able to see the following: -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.33.5/upgrade-guide.mdx b/docs/release-notes/5.33.5/upgrade-guide.mdx index ae636835e..b291b2b31 100644 --- a/docs/release-notes/5.33.5/upgrade-guide.mdx +++ b/docs/release-notes/5.33.5/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.0/changelog.mdx b/docs/release-notes/5.34.0/changelog.mdx index 800836d53..228080ea7 100644 --- a/docs/release-notes/5.34.0/changelog.mdx +++ b/docs/release-notes/5.34.0/changelog.mdx @@ -82,7 +82,7 @@ This field also pushed us to improve handling of field validators. Having a vali Users can now run the conditional (`AND` and `OR`) filtering in both DynamoDB and DynamoDB + Elasticsearch systems. -To find out more about the advanced filtering, read this [article](/docs/{version}/headless-cms/basics/using-graphql-api-advanced-filtering). +To find out more about the advanced filtering, read this [article](/docs/headless-cms/basics/using-graphql-api-advanced-filtering). ### Nested Object Field Filtering ([#2853](https://github.com/webiny/webiny-js/pull/2853)) ([#2905](https://github.com/webiny/webiny-js/pull/2905)) @@ -210,7 +210,7 @@ Until now, when some code error happened (for example: reading property of `null By default, we now output the error `message`, `code` and `data` properties in the response, but users can modify that if they want to. -To find out how to add your own error handler, please read [this article](/docs/{version}/core-development-concepts/extending-and-customizing/customizing-the-error-output). +To find out how to add your own error handler, please read [this article](/docs/core-development-concepts/extending-and-customizing/customizing-the-error-output). ### Infrastructure Deploy Preview diff --git a/docs/release-notes/5.34.0/page-builder-pe-rendering-engine-migration.mdx b/docs/release-notes/5.34.0/page-builder-pe-rendering-engine-migration.mdx index cb40ead17..aacaa2fe9 100644 --- a/docs/release-notes/5.34.0/page-builder-pe-rendering-engine-migration.mdx +++ b/docs/release-notes/5.34.0/page-builder-pe-rendering-engine-migration.mdx @@ -71,7 +71,7 @@ The project also doesn't have any customizations, like custom typography, colors -There's no need to run the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command +There's no need to run the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command immediately. We'll highlight when that's needed in one of the following sections. @@ -177,7 +177,7 @@ Any other styling is completely handled via the mentioned [Emotion](https://emot ### First Look - Not Exactly What We Expected -At this point, we should be able to start up our Admin app locally, via the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command: +At this point, we should be able to start up our Admin app locally, via the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command: ```bash yarn webiny watch admin --env dev diff --git a/docs/release-notes/5.34.0/upgrade-guide.mdx b/docs/release-notes/5.34.0/upgrade-guide.mdx index ed44ace97..0427a8f6f 100644 --- a/docs/release-notes/5.34.0/upgrade-guide.mdx +++ b/docs/release-notes/5.34.0/upgrade-guide.mdx @@ -72,7 +72,7 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.1/changelog.mdx b/docs/release-notes/5.34.1/changelog.mdx index 6b23dc1a9..d74562b4d 100644 --- a/docs/release-notes/5.34.1/changelog.mdx +++ b/docs/release-notes/5.34.1/changelog.mdx @@ -105,7 +105,7 @@ This has now been addressed. The generated application code should now work with Users can now add custom sort options into the Schema for user defined CMS Models. The support for custom sorting, we also added the plugins for both DynamoDB and DynamoDB + Elasticsearch systems. -To find out more about custom sorting, please read this [article](/docs/{version}/headless-cms/extending/custom-sorting). +To find out more about custom sorting, please read this [article](/docs/headless-cms/extending/custom-sorting). ### Control Whether a Referenced Field Value Is Populated ([#2987](https://github.com/webiny/webiny-js/pull/2987)) diff --git a/docs/release-notes/5.34.1/upgrade-guide.mdx b/docs/release-notes/5.34.1/upgrade-guide.mdx index 80f9bce12..f96a6627e 100644 --- a/docs/release-notes/5.34.1/upgrade-guide.mdx +++ b/docs/release-notes/5.34.1/upgrade-guide.mdx @@ -55,6 +55,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.2/upgrade-guide.mdx b/docs/release-notes/5.34.2/upgrade-guide.mdx index a706b0154..beafc4d6c 100644 --- a/docs/release-notes/5.34.2/upgrade-guide.mdx +++ b/docs/release-notes/5.34.2/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.3/changelog.mdx b/docs/release-notes/5.34.3/changelog.mdx index 41567f2a5..cc4c65b5f 100644 --- a/docs/release-notes/5.34.3/changelog.mdx +++ b/docs/release-notes/5.34.3/changelog.mdx @@ -40,7 +40,7 @@ In the page editor, reordering existing page elements via drag and drop method n ### Ability To Define Multiple Production Environments Via `webiny.application.ts` ([#3014](https://github.com/webiny/webiny-js/pull/3014)) -Upon running the [`webiny deploy`](/docs/{exact:5.34.x}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/{version}/architecture/deployment-modes/production). +Upon running the [`webiny deploy`](/docs/{exact:5.34.x}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/architecture/deployment-modes/production). But, if a user wanted to use the same mode for, say, `staging`, that would not be easily possible. diff --git a/docs/release-notes/5.34.3/upgrade-guide.mdx b/docs/release-notes/5.34.3/upgrade-guide.mdx index 6911f136c..53780c462 100644 --- a/docs/release-notes/5.34.3/upgrade-guide.mdx +++ b/docs/release-notes/5.34.3/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.4/upgrade-guide.mdx b/docs/release-notes/5.34.4/upgrade-guide.mdx index 47df76109..5cc526436 100644 --- a/docs/release-notes/5.34.4/upgrade-guide.mdx +++ b/docs/release-notes/5.34.4/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.5/upgrade-guide.mdx b/docs/release-notes/5.34.5/upgrade-guide.mdx index 718e544b7..11f7f12f7 100644 --- a/docs/release-notes/5.34.5/upgrade-guide.mdx +++ b/docs/release-notes/5.34.5/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.6/changelog.mdx b/docs/release-notes/5.34.6/changelog.mdx index acf8c30c6..48fdb9093 100644 --- a/docs/release-notes/5.34.6/changelog.mdx +++ b/docs/release-notes/5.34.6/changelog.mdx @@ -50,7 +50,7 @@ For all users that experienced this issue, deployment should start working corre ### Introduced `webiny build` Command ([#3074](https://github.com/webiny/webiny-js/pull/3074)) -As the name itself suggests, the new [`webiny build`](/docs/{version}/core-development-concepts/basics/webiny-cli#common-commands) command enables users to simply build their project application. The command can be useful when a project application needs to be just built, and not also deployed, which was previously not possible. +As the name itself suggests, the new [`webiny build`](/docs/core-development-concepts/basics/webiny-cli#common-commands) command enables users to simply build their project application. The command can be useful when a project application needs to be just built, and not also deployed, which was previously not possible. ### Improved Error Reporting When There's No Internal Workspace Folder ([#3075](https://github.com/webiny/webiny-js/pull/3075)) @@ -62,6 +62,6 @@ So, with this release, we've improved the error message, ensuring that the user ### Deploy Command - Always Execute Before/After Deploy Hooks ([#3078](https://github.com/webiny/webiny-js/pull/3078)) -Prior to this release, executing the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command with the `--preview` flag would cause the pre-deployment and post-deployment hooks not to be executed. In some cases, this could affect the result of the preview results, making them different from the deployment that would eventually happen. +Prior to this release, executing the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command with the `--preview` flag would cause the pre-deployment and post-deployment hooks not to be executed. In some cases, this could affect the result of the preview results, making them different from the deployment that would eventually happen. With this release, mentioned hooks will get triggered, no matter if the command was executed with the `--preview` flag or without it. diff --git a/docs/release-notes/5.34.6/upgrade-guide.mdx b/docs/release-notes/5.34.6/upgrade-guide.mdx index a9ffe6452..38a69b254 100644 --- a/docs/release-notes/5.34.6/upgrade-guide.mdx +++ b/docs/release-notes/5.34.6/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.34.7/upgrade-guide.mdx b/docs/release-notes/5.34.7/upgrade-guide.mdx index 5991a2a11..6729143d9 100644 --- a/docs/release-notes/5.34.7/upgrade-guide.mdx +++ b/docs/release-notes/5.34.7/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.35.0/changelog.mdx b/docs/release-notes/5.35.0/changelog.mdx index 284310053..e47f20e0f 100644 --- a/docs/release-notes/5.35.0/changelog.mdx +++ b/docs/release-notes/5.35.0/changelog.mdx @@ -55,7 +55,7 @@ import lexicalEditor from "./assets/lexical-editor.png"; ### Removed the Headless CMS AWS Lambda Function ([#2945](https://github.com/webiny/webiny-js/pull/2945)) -Prior to 5.35.0 version of Webiny, all remote GraphQL API HTTP requests were handled by two separate AWS Lambda functions. One function was responsible for serving the Default GraphQL API (accessible via the `/graphql` endpoint), while the other was responsible for serving the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api) (accessible via the `/cms/{type}/{locale}` endpoint). +Prior to 5.35.0 version of Webiny, all remote GraphQL API HTTP requests were handled by two separate AWS Lambda functions. One function was responsible for serving the Default GraphQL API (accessible via the `/graphql` endpoint), while the other was responsible for serving the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api) (accessible via the `/cms/{type}/{locale}` endpoint). Starting with 5.35.0, all remote GraphQL API HTTP requests are handled by a single AWS Lambda function. In other words, the function is responsible for serving both the Default and Headless CMS GraphQL APIs. Note that the mentioned `/graphql` and `/cms/{type}/{locale}` endpoints remain unchanged. @@ -175,7 +175,7 @@ By the default, the checkbox defining the default fields creation is checked, bu ### Model Icon ([#3142](https://github.com/webiny/webiny-js/pull/3142)) -We've introduced the ability to add an icon when creating or editing a content model. Within the Admin app, an icon picker will be shown when creating or editing content models. For models [defined via code](/docs/{version}/headless-cms/extending/content-models-via-code), users will need to type in the icon pack identifier and the icon identifier, in form of `packId/iconId`. For example, a newspaper icon is `fas/newspaper`. +We've introduced the ability to add an icon when creating or editing a content model. Within the Admin app, an icon picker will be shown when creating or editing content models. For models [defined via code](/docs/headless-cms/extending/content-models-via-code), users will need to type in the icon pack identifier and the icon identifier, in form of `packId/iconId`. For example, a newspaper icon is `fas/newspaper`. We have a few icon packs by default: `@fortawesome/free-brands-svg-icons` (`fab`), `@fortawesome/free-solid-svg-icons` (`fas`) and `@fortawesome/free-regular-svg-icons` (`far`). diff --git a/docs/release-notes/5.35.0/removing-the-headless-cms-lambda-function.mdx b/docs/release-notes/5.35.0/removing-the-headless-cms-lambda-function.mdx index ab26aef61..a315696af 100644 --- a/docs/release-notes/5.35.0/removing-the-headless-cms-lambda-function.mdx +++ b/docs/release-notes/5.35.0/removing-the-headless-cms-lambda-function.mdx @@ -14,7 +14,7 @@ Before starting with the migration, make sure you're using Webiny version 5.35.0 ## Introduction -Prior to 5.35.0 version of Webiny, remote GraphQL API HTTP requests were handled by two separate AWS Lambda functions. One function was responsible for serving the Default GraphQL API (accessible via the `/graphql` endpoint), while the other was responsible for serving the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api) (accessible via the `/cms/{type}/{locale}` endpoint). +Prior to 5.35.0 version of Webiny, remote GraphQL API HTTP requests were handled by two separate AWS Lambda functions. One function was responsible for serving the Default GraphQL API (accessible via the `/graphql` endpoint), while the other was responsible for serving the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api) (accessible via the `/cms/{type}/{locale}` endpoint). Starting with 5.35.0, all remote GraphQL API HTTP requests are handled by a single AWS Lambda function. In other words, the function is responsible for serving both the Default and Headless CMS GraphQL APIs. Note that the mentioned `/graphql` and `/cms/{type}/{locale}` endpoints remain unchanged. diff --git a/docs/release-notes/5.35.0/upgrade-guide.mdx b/docs/release-notes/5.35.0/upgrade-guide.mdx index b4d11bf29..258d02d7d 100644 --- a/docs/release-notes/5.35.0/upgrade-guide.mdx +++ b/docs/release-notes/5.35.0/upgrade-guide.mdx @@ -103,7 +103,7 @@ first deploy your changes into one of your pre-production environments, like `de Learn more about different deployment environments in the [CI/CD / -Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Environments](/docs/core-development-concepts/ci-cd/environments) key topic. @@ -248,7 +248,7 @@ With the new version, the following changes should be made: + const Heading = styled.div(({ theme }) => theme.styles.typography["heading1"]); ``` -Note that the upgrade command will try to detect legacy usages of the `theme` object and will try to adjust them automatically. However, if you have custom code that uses the `theme` object, you might need to make the necessary adjustments manually. You will notice this as, upon running the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command against the Admin or the Website application, errors will be reported. +Note that the upgrade command will try to detect legacy usages of the `theme` object and will try to adjust them automatically. However, if you have custom code that uses the `theme` object, you might need to make the necessary adjustments manually. You will notice this as, upon running the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command against the Admin or the Website application, errors will be reported. #### Default Form Layout Replaced diff --git a/docs/release-notes/5.35.1/upgrade-guide.mdx b/docs/release-notes/5.35.1/upgrade-guide.mdx index 3bb58f78c..0026a6768 100644 --- a/docs/release-notes/5.35.1/upgrade-guide.mdx +++ b/docs/release-notes/5.35.1/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.35.2/upgrade-guide.mdx b/docs/release-notes/5.35.2/upgrade-guide.mdx index bd707065f..ef5a7085a 100644 --- a/docs/release-notes/5.35.2/upgrade-guide.mdx +++ b/docs/release-notes/5.35.2/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.35.3/upgrade-guide.mdx b/docs/release-notes/5.35.3/upgrade-guide.mdx index 22df4f9ce..ef93618cb 100644 --- a/docs/release-notes/5.35.3/upgrade-guide.mdx +++ b/docs/release-notes/5.35.3/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.35.4/upgrade-guide.mdx b/docs/release-notes/5.35.4/upgrade-guide.mdx index 74e833aa0..a19e59740 100644 --- a/docs/release-notes/5.35.4/upgrade-guide.mdx +++ b/docs/release-notes/5.35.4/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.36.0/upgrade-guide.mdx b/docs/release-notes/5.36.0/upgrade-guide.mdx index e9981ee43..b12808f54 100644 --- a/docs/release-notes/5.36.0/upgrade-guide.mdx +++ b/docs/release-notes/5.36.0/upgrade-guide.mdx @@ -85,6 +85,6 @@ first deploy your changes into one of your pre-production environments, like `de Learn more about different deployment environments in the [CI/CD / -Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.36.1/changelog.mdx b/docs/release-notes/5.36.1/changelog.mdx index 7b9dd83ad..1a440915d 100644 --- a/docs/release-notes/5.36.1/changelog.mdx +++ b/docs/release-notes/5.36.1/changelog.mdx @@ -63,6 +63,6 @@ The fix specifically targets instances where the migration failed due to this pa ### `webiny info` Command Now Works As Expected ([#3331](https://github.com/webiny/webiny-js/pull/3331)) -Prior to this release, the [`webiny info`](/docs/{version}/core-development-concepts/basics/webiny-cli#common-commands) command would not work if an environment wasn't passed (in which case the command should internally retrieve a list of all environments). +Prior to this release, the [`webiny info`](/docs/core-development-concepts/basics/webiny-cli#common-commands) command would not work if an environment wasn't passed (in which case the command should internally retrieve a list of all environments). This issue has now been addressed. diff --git a/docs/release-notes/5.36.1/upgrade-guide.mdx b/docs/release-notes/5.36.1/upgrade-guide.mdx index bd3c6071b..0468c2d5f 100644 --- a/docs/release-notes/5.36.1/upgrade-guide.mdx +++ b/docs/release-notes/5.36.1/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.36.2/changelog.mdx b/docs/release-notes/5.36.2/changelog.mdx index 85b759f19..cc1f25708 100644 --- a/docs/release-notes/5.36.2/changelog.mdx +++ b/docs/release-notes/5.36.2/changelog.mdx @@ -66,7 +66,7 @@ On the back of the improvements listed in the [Page Builder](http://localhost:80 ### Fully Destroy Your Project With the Improved `webiny destroy` Command ([#3353](https://github.com/webiny/webiny-js/pull/3353)) -Prior to this release, in order to fully destroy a deployed Webiny project, users would need to destroy all four project applications (**Website**, **Admin**, **API**, and **Core**), by sequentially running four separate [`webiny destroy`](/docs/{version}/infrastructure/basics/destroy-cloud-infrastructure#the-destroy-command) commands. +Prior to this release, in order to fully destroy a deployed Webiny project, users would need to destroy all four project applications (**Website**, **Admin**, **API**, and **Core**), by sequentially running four separate [`webiny destroy`](/docs/infrastructure/basics/destroy-cloud-infrastructure#the-destroy-command) commands.

@@ -76,7 +76,7 @@ And although this was made a bit easier with the ability to [specify multiple ap

-So, with this release, users can now run the [`webiny destroy`](/docs/{version}/infrastructure/basics/destroy-cloud-infrastructure) command without specifying the project application. This will destroy all four applications in the correct order, and in a single command execution. In other words, the command will fully destroy your Webiny project, deployed into the specified environment. +So, with this release, users can now run the [`webiny destroy`](/docs/infrastructure/basics/destroy-cloud-infrastructure) command without specifying the project application. This will destroy all four applications in the correct order, and in a single command execution. In other words, the command will fully destroy your Webiny project, deployed into the specified environment. For example: diff --git a/docs/release-notes/5.36.2/upgrade-guide.mdx b/docs/release-notes/5.36.2/upgrade-guide.mdx index 884c5b5e1..bc6e7b964 100644 --- a/docs/release-notes/5.36.2/upgrade-guide.mdx +++ b/docs/release-notes/5.36.2/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.37.0/changelog.mdx b/docs/release-notes/5.37.0/changelog.mdx index c3dbfc085..5b27e19c8 100644 --- a/docs/release-notes/5.37.0/changelog.mdx +++ b/docs/release-notes/5.37.0/changelog.mdx @@ -79,8 +79,8 @@ The Headless CMS offers various default features that developers may want to twe With this release, we present developers with a fresh approach to engage with a few of the Headless CMS's core features: -1. [Entry List Filters](/docs/{version}/headless-cms/extending/customize-entry-list-filters) -2. [Entry Editor Actions](/docs/{version}/headless-cms/extending/customize-entry-editor-actions) +1. [Entry List Filters](/docs/headless-cms/extending/customize-entry-list-filters) +2. [Entry Editor Actions](/docs/headless-cms/extending/customize-entry-editor-actions) diff --git a/docs/release-notes/5.37.1/changelog.mdx b/docs/release-notes/5.37.1/changelog.mdx index 62ec658f7..662b13ab7 100644 --- a/docs/release-notes/5.37.1/changelog.mdx +++ b/docs/release-notes/5.37.1/changelog.mdx @@ -48,7 +48,7 @@ This has now been addressed. ### 5.37.0 Migration Improvement ([#3469](https://github.com/webiny/webiny-js/pull/3469)) -We've received a couple of reports of 5.37.0 migration sometimes failing for users using the [Amazon DynamoDB + Amazon ElasticSearch database setup](/docs/{version}/architecture/introduction#different-database-setups). Essentially, upon ElasticSearch index creation, the migration would fail with the `resource_already_exists_exception` error being thrown, and this was happening despite the fact that the existence of the index was properly checked prior to its creation. +We've received a couple of reports of 5.37.0 migration sometimes failing for users using the [Amazon DynamoDB + Amazon ElasticSearch database setup](/docs/architecture/introduction#different-database-setups). Essentially, upon ElasticSearch index creation, the migration would fail with the `resource_already_exists_exception` error being thrown, and this was happening despite the fact that the existence of the index was properly checked prior to its creation. In order to try to resolve this issue, we've added more robust checks for the existence of the index. diff --git a/docs/release-notes/5.37.1/upgrade-guide.mdx b/docs/release-notes/5.37.1/upgrade-guide.mdx index 8b7b188a0..3d9c5e38f 100644 --- a/docs/release-notes/5.37.1/upgrade-guide.mdx +++ b/docs/release-notes/5.37.1/upgrade-guide.mdx @@ -57,6 +57,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.37.2/upgrade-guide.mdx b/docs/release-notes/5.37.2/upgrade-guide.mdx index f5116012c..a7983e2e1 100644 --- a/docs/release-notes/5.37.2/upgrade-guide.mdx +++ b/docs/release-notes/5.37.2/upgrade-guide.mdx @@ -57,6 +57,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.37.3/upgrade-guide.mdx b/docs/release-notes/5.37.3/upgrade-guide.mdx index a0cde95c3..7dbabca7e 100644 --- a/docs/release-notes/5.37.3/upgrade-guide.mdx +++ b/docs/release-notes/5.37.3/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.37.4/upgrade-guide.mdx b/docs/release-notes/5.37.4/upgrade-guide.mdx index 9374be20c..dd2bfcbf0 100644 --- a/docs/release-notes/5.37.4/upgrade-guide.mdx +++ b/docs/release-notes/5.37.4/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.37.5/upgrade-guide.mdx b/docs/release-notes/5.37.5/upgrade-guide.mdx index 344cd417f..e9b8277ab 100644 --- a/docs/release-notes/5.37.5/upgrade-guide.mdx +++ b/docs/release-notes/5.37.5/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.37.6/upgrade-guide.mdx b/docs/release-notes/5.37.6/upgrade-guide.mdx index 542e15d2b..c74616581 100644 --- a/docs/release-notes/5.37.6/upgrade-guide.mdx +++ b/docs/release-notes/5.37.6/upgrade-guide.mdx @@ -51,6 +51,6 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/5.38.0/changelog.mdx b/docs/release-notes/5.38.0/changelog.mdx index 7f6994931..4f84d9af6 100644 --- a/docs/release-notes/5.38.0/changelog.mdx +++ b/docs/release-notes/5.38.0/changelog.mdx @@ -27,7 +27,7 @@ import fnShiftSelect from "./assets/fm-shift-select.mp4"; ### Removal of `WEBINY_ELASTICSEARCH_INDEX_LOCALE` Environment Variable ([#3672](https://github.com/webiny/webiny-js/pull/3672)) -Used only with [Amazon DynamoDB + Amazon ElasticSearch](/docs/{version}/architecture/introduction#different-database-setups) database setup, the `WEBINY_ELASTICSEARCH_INDEX_LOCALE` environment variable would allow users to choose whether they want their ElasticSearch indexes to include a locale code in their names. +Used only with [Amazon DynamoDB + Amazon ElasticSearch](/docs/architecture/introduction#different-database-setups) database setup, the `WEBINY_ELASTICSEARCH_INDEX_LOCALE` environment variable would allow users to choose whether they want their ElasticSearch indexes to include a locale code in their names. Today, there is really no reason to not set this to `true`, so we've decided to hide this environment variable altogether, and always include the locale code in the index name. @@ -211,7 +211,7 @@ Often, you need to import or export data to and from Webiny, but you only have, ### Revamped Watch Command Output -We've revamped the output for the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command. +We've revamped the output for the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command. {"Revamped diff --git a/docs/release-notes/5.39.0/changelog.mdx b/docs/release-notes/5.39.0/changelog.mdx index dadb9f304..eba7413fd 100644 --- a/docs/release-notes/5.39.0/changelog.mdx +++ b/docs/release-notes/5.39.0/changelog.mdx @@ -36,7 +36,7 @@ On top of that, searching for entries and sorting based on the date/time or iden -Content entries created with Webiny's Headless CMS are versioned. In other words, they consist of one or more revisions. For more info, check out the related [user guides](/docs/{version}/user-guides/headless-cms/essentials/glossary). +Content entries created with Webiny's Headless CMS are versioned. In other words, they consist of one or more revisions. For more info, check out the related [user guides](/docs/user-guides/headless-cms/essentials/glossary). @@ -46,7 +46,7 @@ Revision-specific fields contain the `revision` prefix in their name, and, as th On the other hand, entry-specific fields do not contain any prefix, and contain entry-level information. For example, the `createdOn` meta field contains the date/time when an entry was initially created. The value of this field will not change even if the entry is updated or new revisions are created. -For the full list of new meta fields and additional information, please refer to the new [Date/Time and Identity (On/By) Meta Fields](/docs/{version}/headless-cms/references/date-time-and-identity-meta-fields) reference article. +For the full list of new meta fields and additional information, please refer to the new [Date/Time and Identity (On/By) Meta Fields](/docs/headless-cms/references/date-time-and-identity-meta-fields) reference article. #### Backwards Compatibility @@ -187,7 +187,7 @@ Finally, note that, at the moment, we do not provide a migration path from Amazo -Visit the [Different Database Setups](/docs/{version}/architecture/introduction#different-database-setups) article to learn more +Visit the [Different Database Setups](/docs/architecture/introduction#different-database-setups) article to learn more about the different database setups Webiny supports. @@ -220,7 +220,7 @@ For example, if you wanted to have a Lambda function which handled the **S3** ev From now on, for all AWS events we support, you can use the `createHandler` function from `@webiny/handler-aws` package. You can still use the old way of importing specific handler factories (s3, dynamodb, etc...), so this change is completely backwards compatible. -To find out more about our Lambda event handlers, please read [this](/docs/{version}/core-development-concepts/basics/routes-and-events) article. +To find out more about our Lambda event handlers, please read [this](/docs/core-development-concepts/basics/routes-and-events) article. ### Webiny CLI - Introducing the `webiny open` Command @@ -236,11 +236,11 @@ yarn webiny open admin --env dev yarn webiny open website --env dev ``` -This way, it's a bit easier to open the Admin or Website app. Users no longer need to first retrieve relevant URLs via the [`webiny info`](/docs/{version}/core-development-concepts/basics/webiny-cli#common-commands) or [`webiny output`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-output-folder---env-env) command and then manually copy/paste them into the browser. +This way, it's a bit easier to open the Admin or Website app. Users no longer need to first retrieve relevant URLs via the [`webiny info`](/docs/core-development-concepts/basics/webiny-cli#common-commands) or [`webiny output`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-output-folder---env-env) command and then manually copy/paste them into the browser. -Note that, for local development, the apps are still spun up locally in the same way - via the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command. +Note that, for local development, the apps are still spun up locally in the same way - via the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command. diff --git a/docs/release-notes/5.39.0/date-time-and-identity-meta-fields.mdx b/docs/release-notes/5.39.0/date-time-and-identity-meta-fields.mdx index a1ddc1cd4..3e6b197fb 100644 --- a/docs/release-notes/5.39.0/date-time-and-identity-meta-fields.mdx +++ b/docs/release-notes/5.39.0/date-time-and-identity-meta-fields.mdx @@ -13,13 +13,13 @@ As mentioned in the [changelog](docs/release-notes/5.39.0/changelog#headless-cms Will these breaking changes affect you? It depends on if you've been adding custom code in your project, in which you are also relying on the existing content entry meta fields, like `ownedBy`, `publishedOn`, or `createdOn`. For example, you may have have been using these in your: 1. custom Headless CMS-related GraphQL API queries or mutations -2. custom Headless CMS-related JavaScript (TypeScript) code (for example, [lifecycle events](/docs/{version}/headless-cms/references/lifecycle-events)) +2. custom Headless CMS-related JavaScript (TypeScript) code (for example, [lifecycle events](/docs/headless-cms/references/lifecycle-events)) If you don't have any of the above, you can safely skip this article. Otherwise, please read on. To learn more about the new date/time and identity-related meta fields, please refer to the{" "} - + Entry Date/Time and Identity (On/By) Meta Fields {" "} guide. diff --git a/docs/release-notes/5.39.0/upgrade-guide.mdx b/docs/release-notes/5.39.0/upgrade-guide.mdx index 90fb5d6c2..972a4e1ec 100644 --- a/docs/release-notes/5.39.0/upgrade-guide.mdx +++ b/docs/release-notes/5.39.0/upgrade-guide.mdx @@ -50,7 +50,7 @@ As mentioned in the [changelog](docs/release-notes/5.39.0/changelog#headless-cms Will these breaking changes affect you? It depends on if you've been adding custom code in your project, in which you are also relying on the existing content entry meta fields, like `ownedBy`, `publishedOn`, or `createdOn`. For example, you may have have been using these in your: 1. custom Headless CMS-related GraphQL API queries or mutations -2. custom Headless CMS-related JavaScript (TypeScript) code (for example, [lifecycle events](/docs/{version}/headless-cms/references/lifecycle-events)) +2. custom Headless CMS-related JavaScript (TypeScript) code (for example, [lifecycle events](/docs/headless-cms/references/lifecycle-events)) If you don't have any of the above, you can safely skip this section. Otherwise, please take a look at the [Date/Time and Identity (On/By) Meta Fields](/docs/release-notes/5.39.0/date-time-and-identity-meta-fields) article. @@ -60,7 +60,7 @@ As mentioned in the [changelog](/docs/release-notes/5.39.0/changelog#deployments And despite the fact that, at the moment, the state machine is only utilized internally, this still means that, in order to deploy Webiny successfully, proper [AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/) permissions need to be in place. -For new users, this is not an issue because we've updated our [Deploy Webiny Project AWS CloudFormation template](/docs/{version}/infrastructure/aws/configure-aws-credentials#and-quot-deploy-webiny-project-and-quot-aws-cloud-formation-template) to include the required permissions. However, for existing users, this means that, in order to deploy Webiny successfully, they'll need to update the permissions attached to the IAM user or role they're using to deploy Webiny. +For new users, this is not an issue because we've updated our [Deploy Webiny Project AWS CloudFormation template](/docs/infrastructure/aws/configure-aws-credentials#and-quot-deploy-webiny-project-and-quot-aws-cloud-formation-template) to include the required permissions. However, for existing users, this means that, in order to deploy Webiny successfully, they'll need to update the permissions attached to the IAM user or role they're using to deploy Webiny. Ultimately, no matter if you're using the mentioned AWS CloudFormation template or not, the following additional permissions need to be attached to the IAM user or role you're using to deploy Webiny: @@ -87,7 +87,7 @@ custom Pulumi resource name prefix (set via `webiny.application.ts` files), you' For example, if using `my-123-prefix-` as the custom Pulumi resource name prefix, then the resource should be set to `arn:aws:states:*:*:stateMachine:my-123-prefix-*`. So, instead of ending with `wby-*`, the resource now ends with `my-123-prefix-*`. -For more information on custom Pulumi resource name prefixes, see [Pulumi Resource Name Prefixes](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure#pulumi-resource-name-prefixes). +For more information on custom Pulumi resource name prefixes, see [Pulumi Resource Name Prefixes](/docs/infrastructure/basics/modify-cloud-infrastructure#pulumi-resource-name-prefixes). diff --git a/docs/release-notes/5.39.13/changelog.mdx b/docs/release-notes/5.39.13/changelog.mdx index 0a88e462b..dad103f27 100644 --- a/docs/release-notes/5.39.13/changelog.mdx +++ b/docs/release-notes/5.39.13/changelog.mdx @@ -12,6 +12,6 @@ import { GithubRelease } from "@/components/GithubRelease"; ### Ensure Published Entries Are Fully Deleted ([#4265](https://github.com/webiny/webiny-js/pull/4265)) -With this release, we've resolved an issue where deleting a published revision of a content entry would not make the entry disappear when listing content entries via [Headless CMS's READ GraphQL API](/docs/{version}/headless-cms/basics/graphql-api#read). In other words, the entry would still remain visible in the list of entries, even though it was deleted. +With this release, we've resolved an issue where deleting a published revision of a content entry would not make the entry disappear when listing content entries via [Headless CMS's READ GraphQL API](/docs/headless-cms/basics/graphql-api#read). In other words, the entry would still remain visible in the list of entries, even though it was deleted. Now, when a published entry is deleted, it will no longer be visible in the list of entries returned by the READ API. diff --git a/docs/release-notes/5.39.2/changelog.mdx b/docs/release-notes/5.39.2/changelog.mdx index ee26bea28..c023bf8d4 100644 --- a/docs/release-notes/5.39.2/changelog.mdx +++ b/docs/release-notes/5.39.2/changelog.mdx @@ -62,7 +62,7 @@ With this release, upon defining content models programmatically, developers now Security Permissions Defined via the Security Application -The existing [Define Content Models via Code](/docs/{version}/headless-cms/extending/content-models-via-code#disable-authorization-for-content-models-and-entries) article has been updated to include this new feature. +The existing [Define Content Models via Code](/docs/headless-cms/extending/content-models-via-code#disable-authorization-for-content-models-and-entries) article has been updated to include this new feature. ### Addressing Invalid `TYPE` Field Value ([#3893](https://github.com/webiny/webiny-js/pull/3893)) diff --git a/docs/release-notes/5.39.9/changelog.mdx b/docs/release-notes/5.39.9/changelog.mdx index 08cf2330e..c85766792 100644 --- a/docs/release-notes/5.39.9/changelog.mdx +++ b/docs/release-notes/5.39.9/changelog.mdx @@ -26,7 +26,7 @@ This issue has been fixed, and now the published record is updated correctly whe - This improvement only applies to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/{version}/architecture/introduction#different-database-setups). + This improvement only applies to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/architecture/introduction#different-database-setups). @@ -40,7 +40,7 @@ Note that the errors we're referring to here are errors that are, in most cases, - These improvements only apply to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/{version}/architecture/introduction#different-database-setups). + These improvements only apply to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/architecture/introduction#different-database-setups). diff --git a/docs/release-notes/5.4.0/changelog.mdx b/docs/release-notes/5.4.0/changelog.mdx index f196b4807..21f330a56 100644 --- a/docs/release-notes/5.4.0/changelog.mdx +++ b/docs/release-notes/5.4.0/changelog.mdx @@ -32,7 +32,7 @@ In a couple of different scenarios, performing data filtering on boolean and num -Learn more about the Headless CMS GraphQL API in the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api) key topic. +Learn more about the Headless CMS GraphQL API in the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api) key topic. @@ -50,7 +50,7 @@ With this release, all of the static assets that you upload as part of the **Web -Learn more about the **Website** project application on the cloud infrastructure level in the [Cloud Infrastructure](/docs/{version}/architecture/website/overview) key topics section. +Learn more about the **Website** project application on the cloud infrastructure level in the [Cloud Infrastructure](/docs/architecture/website/overview) key topics section. diff --git a/docs/release-notes/5.4.0/upgrade-guide.mdx b/docs/release-notes/5.4.0/upgrade-guide.mdx index 7fcef1d42..dbf823a2c 100644 --- a/docs/release-notes/5.4.0/upgrade-guide.mdx +++ b/docs/release-notes/5.4.0/upgrade-guide.mdx @@ -101,7 +101,7 @@ As it was always the case, upon deploying **Website** and **Admin Area** project Due to website prerendering improvements that the 5.4.0 release brings, in the Amazon S3 bucket that's deployed as part of the **Website** project application, expect to have multiple `static-{RANDOM_ID}` folders - one for each deploy. If you're deploying frequently and you end up having a lot of folders, you might want to schedule a cleanup task, that will delete folders that are no longer in use. -Check out the [Cloud Infrastructure](/docs/{version}/architecture/website/prerendering-pages) key topics section to learn more about all of the resources included in the process. +Check out the [Cloud Infrastructure](/docs/architecture/website/prerendering-pages) key topics section to learn more about all of the resources included in the process. diff --git a/docs/release-notes/5.40.0/changelog.mdx b/docs/release-notes/5.40.0/changelog.mdx index f6ebcaa8b..7ab26847f 100644 --- a/docs/release-notes/5.40.0/changelog.mdx +++ b/docs/release-notes/5.40.0/changelog.mdx @@ -120,7 +120,7 @@ Content entry traverser allows you to traverse any given content entry using the This tool is very useful in situations when you need to, for example, extract specific values from an entry, send them to an external API for processing, and then inject the processed values back to their original position in the source entry, asynchronously (via webhooks, for example). -To learn how to use it, visit the [Content Entry Traverser](/docs/{version}/headless-cms/extending/content-entry-traverser) article. +To learn how to use it, visit the [Content Entry Traverser](/docs/headless-cms/extending/content-entry-traverser) article. ### Field Renderer Settings @@ -218,7 +218,7 @@ Furthermore, in order to make it easier for developers to create new extensions, Ultimately, the goal is to make the extension creation process as seamless as possible, enabling developers to quickly and efficiently extend Webiny to meet their specific requirements. With the new `extensions` folder and the **New Extension** scaffold, we believe we've taken a significant step in that direction. -For more information, please refer to the new [Extensions](/docs/{version}/core-development-concepts/basics/extensions) article. +For more information, please refer to the new [Extensions](/docs/core-development-concepts/basics/extensions) article. #### Note on Backward Compatibility @@ -265,7 +265,7 @@ In terms of existing documentation, we've already updated some of the articles t ### Webiny CLI and `create-webiny-project` ([#4045](https://github.com/webiny/webiny-js/pull/4045)) -With this release, we took some time to improve the [Webiny CLI](/docs/{version}/core-development-concepts/basics/webiny-cli) and the `create-webiny-project` CLI, which is used to create new Webiny projects. The focus was on improving the overall user experience and making the CLI tools more user-friendly. +With this release, we took some time to improve the [Webiny CLI](/docs/core-development-concepts/basics/webiny-cli) and the `create-webiny-project` CLI, which is used to create new Webiny projects. The focus was on improving the overall user experience and making the CLI tools more user-friendly. In the following sections, we cover some of the user-facing improvements that were made. For a full list of changes, check out the [linked pull request](https://github.com/webiny/webiny-js/pull/4045). @@ -304,7 +304,7 @@ Prior to this release, the project details would need to be fetched manually by #### Improved `webiny about` Command -The [`webiny about`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-about) command has been improved to provide more information about the Webiny project you're working on. The command now also includes the following information: +The [`webiny about`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-about) command has been improved to provide more information about the Webiny project you're working on. The command now also includes the following information: 1. the database setup the project is using 2. user's current version of NPM. @@ -314,7 +314,7 @@ The [`webiny about`](/docs/{version}/core-development-concepts/basics/webiny-cli #### Refreshed `webiny info` Command -The [`webiny info`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-info-env-env) command has been visually refreshed a bit. +The [`webiny info`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-info-env-env) command has been visually refreshed a bit. @@ -328,7 +328,7 @@ Although no breaking changes are expected, we've still compiled a list of all of ### Preventing Production Deployments with Locally Stored State Files ([#4119](https://github.com/webiny/webiny-js/pull/4119)) -We've seen a couple of cases where uses would still use locally stored [Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) state files with their production environments. This is not recommended, so we've made it a bit harder to do so. +We've seen a couple of cases where uses would still use locally stored [Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi) state files with their production environments. This is not recommended, so we've made it a bit harder to do so. In case a production deployment with locally stored state files is detected, the deployment will fail with an error message. Still, if the user wishes to bypass this check, they can append the new `--allow-local-state-files` flag to the deployment command. @@ -341,7 +341,7 @@ The `env` object contains two properties: - `name` - the name of the environment - `isProduction` - a boolean value indicating whether the environment is considered a production environment -Note that the `isProduction` value is calculated based on the list of production environment names that are defined via the existing [`productionEnvironments`](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure#defining-multiple-production-environments) property in the `webiny.project.ts` file. +Note that the `isProduction` value is calculated based on the list of production environment names that are defined via the existing [`productionEnvironments`](/docs/infrastructure/basics/modify-cloud-infrastructure#defining-multiple-production-environments) property in the `webiny.project.ts` file. An example of how the `env` object can be used is shown below: diff --git a/docs/release-notes/5.40.0/pulumi-v6.mdx b/docs/release-notes/5.40.0/pulumi-v6.mdx index 3ca3159f1..5d36e3217 100644 --- a/docs/release-notes/5.40.0/pulumi-v6.mdx +++ b/docs/release-notes/5.40.0/pulumi-v6.mdx @@ -24,7 +24,7 @@ Note that, on top of the changes listed in this article, you should pay extra at To deploy necessary cloud infrastructure resources, by default, Webiny relies on Pulumi, a modern infrastructure as -code framework. Find out more in the following [IaC with Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) +code framework. Find out more in the following [IaC with Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi) article. @@ -32,7 +32,7 @@ article. With the 5.40.0 release, by default, the deployment (Pulumi) logs [are hidden](/docs/release-notes/5.40.0/changelog#pulumi-output-hidden-by-default) when deploying from local machines. To see -the logs, you can append the `--deployment-logs` flag upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command. +the logs, you can append the `--deployment-logs` flag upon running the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command. diff --git a/docs/release-notes/5.40.5/changelog.mdx b/docs/release-notes/5.40.5/changelog.mdx index 51983d037..a7fb4ccf0 100644 --- a/docs/release-notes/5.40.5/changelog.mdx +++ b/docs/release-notes/5.40.5/changelog.mdx @@ -45,7 +45,7 @@ Note that we will slowly be updating our documentation to include this feature i ### `webiny about` Command Now Showing Correct `@pulumi/pulumi` Package Version ([#4216](https://github.com/webiny/webiny-js/pull/4216)) -By [updating Pulumi package versions](#updated-pulumi-package-versions-4216), we've also fixed an issue with the [`webiny about`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-about) command, which would incorrectly report the `@pulumi/pulumi` package version. +By [updating Pulumi package versions](#updated-pulumi-package-versions-4216), we've also fixed an issue with the [`webiny about`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-about) command, which would incorrectly report the `@pulumi/pulumi` package version. webiny about Command Now Showing Correct @pulumi/pulumi Package Version}/> @@ -59,7 +59,7 @@ With this release, we've ported the following changes from the [5.39.9 release]( - This improvement only applies to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/{version}/architecture/introduction#different-database-setups). + This improvement only applies to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/architecture/introduction#different-database-setups). @@ -73,7 +73,7 @@ Note that the errors we're referring to here are errors that are, in most cases, - These improvements only apply to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/{version}/architecture/introduction#different-database-setups). + These improvements only apply to projects that use [Amazon DynamoDB + Amazon OpenSearch database setup](/docs/architecture/introduction#different-database-setups). diff --git a/docs/release-notes/5.40.7/changelog.mdx b/docs/release-notes/5.40.7/changelog.mdx index 4b5269a50..f9d419b34 100644 --- a/docs/release-notes/5.40.7/changelog.mdx +++ b/docs/release-notes/5.40.7/changelog.mdx @@ -14,7 +14,7 @@ Upon deploying API, Admin, and Website applications, Webiny deploys Amazon Cloud - Learn more about Webiny's cloud architecture in the [Cloud Architecture](/docs/{version}/architecture/introduction) documentation. + Learn more about Webiny's cloud architecture in the [Cloud Architecture](/docs/architecture/introduction) documentation. diff --git a/docs/release-notes/5.41.0/changelog.mdx b/docs/release-notes/5.41.0/changelog.mdx index 0d47f8352..9f4e8ecd1 100644 --- a/docs/release-notes/5.41.0/changelog.mdx +++ b/docs/release-notes/5.41.0/changelog.mdx @@ -101,7 +101,7 @@ At this stage, real-time status updates on background tasks are not supported. U When upgrading to version 5.41.X, it is crucial to review and update any custom bulk actions you have implemented. The new background task processing introduces changes that may impact how your bulk actions function, potentially causing unexpected behaviour if not updated. To ensure compatibility, you need to either: -- **Add a Bulk Action Task**: Implement background task support. Detailed guidance is available in [the documentation](/docs/{version}/headless-cms/extending/customize-entry-list-bulk-actions#bulk-action-via-background-task). +- **Add a Bulk Action Task**: Implement background task support. Detailed guidance is available in [the documentation](/docs/headless-cms/extending/customize-entry-list-bulk-actions#bulk-action-via-background-task). - **Handle "Select All" Scenarios**: If users select all entries in the current view, prevent the immediate execution of the bulk action by disabling the trigger. Use the `worker.isSelectedAll` flag to check whether all entries are selected before proceeding. ## Page Builder @@ -123,7 +123,7 @@ We'll be monitoring the situation closely, and if we see that the issue persists To learn more about the prerendering process Webiny's Page Builder app users to prerender published pages, check out -the [Prerendering Pages](https://www.webiny.com/docs/{version}/architecture/website/prerendering-pages) article. +the [Prerendering Pages](https://www.webiny.com/docs/architecture/website/prerendering-pages) article. @@ -169,7 +169,7 @@ know](https://www.webiny.com/slack). -From the early days, in order to perform both backend and frontend development, Webiny users would use the [`webiny watch`](/docs/{version}/core-development-concepts/basics/watch-command) command. And while this command works fine when it comes to frontend development (Admin, public website), we've come to a conclusion that it's not the best solution for backend development. +From the early days, in order to perform both backend and frontend development, Webiny users would use the [`webiny watch`](/docs/core-development-concepts/basics/watch-command) command. And while this command works fine when it comes to frontend development (Admin, public website), we've come to a conclusion that it's not the best solution for backend development. One of the reasons is the fact that, whenever a backend code change is made, the code needs to redeployed to AWS Lambda, which can take anywhere from 5 seconds, up to a minute, and even more. This can be a real productivity killer, especially when you're working on a feature that requires a lot of backend changes. Another reason is the inability to properly debug the backend code, as the `webiny watch` command doesn't provide a way to debug the code running in AWS Lambda. @@ -221,7 +221,7 @@ getaddrinfo ENOTFOUND xyz123abc-ats.iot.eu-central-1.amazonaws.com... You can fix it by just waiting a bit for the underlying infrastructure to be fully set up. This is a one-time issue, and you shouldn't see it again after the first deployment. -With all of these steps completed, you should be able to see the new watch command in action. To learn more, we've also created a new section in our existing [`watch command`](/docs/{version}/core-development-concepts/basics/watch-command) article, which explains how to use this new feature. +With all of these steps completed, you should be able to see the new watch command in action. To learn more, we've also created a new section in our existing [`watch command`](/docs/core-development-concepts/basics/watch-command) article, which explains how to use this new feature. We hope you'll find this new feature useful, and we're looking forward to hearing your feedback! @@ -264,7 +264,7 @@ With this release, we've addressed a couple of issues related to missing or inco Learn more about the **Deploy Webiny Project** AWS CloudFormation template in our [Configure AWS -Credentials](/docs/{version}/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template) +Credentials](/docs/infrastructure/aws/configure-aws-credentials#deploy-webiny-project-aws-cloud-formation-template) article. @@ -281,7 +281,7 @@ As we can see, we've only bumped the patch versions of these packages, which mea Webiny projects are deployed with Pulumi - a modern infrastructure as code (IaC) solution. Check out the [Iac with -Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) topic to learn more. +Pulumi](/docs/infrastructure/pulumi-iac/iac-with-pulumi) topic to learn more. @@ -289,7 +289,7 @@ Pulumi](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi) topic to lear In this release we have added the ability to make Webiny share indexes via Pulumi configuration. -To find out more about shared indexes, please read [this](/docs/{version}/core-development-concepts/extending-and-customizing/how-to-customize-elasticsearch-index) article. +To find out more about shared indexes, please read [this](/docs/core-development-concepts/extending-and-customizing/how-to-customize-elasticsearch-index) article. To make Elasticsearch share indexes, you need to add the following configuration to your `apps/core/webiny.aplication.ts` file: diff --git a/docs/release-notes/5.41.1/changelog.mdx b/docs/release-notes/5.41.1/changelog.mdx index f7d8ba53c..aebf1bab7 100644 --- a/docs/release-notes/5.41.1/changelog.mdx +++ b/docs/release-notes/5.41.1/changelog.mdx @@ -123,11 +123,11 @@ As already mentioned above, in the same fashion, the extension can be accessed v ### Improved Error Messages ([#4341](https://github.com/webiny/webiny-js/pull/4341)) -Prior to this release, in case a user immediately tried to [watch](/docs/{version}/core-development-concepts/basics/watch-command) the **Admin** or **Website** frontend applications, but the **Core** and **API** applications weren't deployed, they would receive an error message that wasn't very helpful. We've improved this error message to provide more context and help users understand what's going on. +Prior to this release, in case a user immediately tried to [watch](/docs/core-development-concepts/basics/watch-command) the **Admin** or **Website** frontend applications, but the **Core** and **API** applications weren't deployed, they would receive an error message that wasn't very helpful. We've improved this error message to provide more context and help users understand what's going on. ### The `webiny extension` Command -Up until now, in order to scaffold a new extension, users had to run the `yarn webiny scaffold` command, and then select **New Extension** from the list of all available scaffolds. And although this isn't a big deal, still, since extensions are becoming more and more important in the last couple of releases, we've decided to introduce a new command called [`webiny extension`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-extension). +Up until now, in order to scaffold a new extension, users had to run the `yarn webiny scaffold` command, and then select **New Extension** from the list of all available scaffolds. And although this isn't a big deal, still, since extensions are becoming more and more important in the last couple of releases, we've decided to introduce a new command called [`webiny extension`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-extension). Essentially, everything stays the same, but now, instead of running `yarn webiny scaffold`, users can run `yarn webiny extension` to scaffold a new extension. diff --git a/docs/release-notes/5.41.2/changelog.mdx b/docs/release-notes/5.41.2/changelog.mdx index a9485f422..51d45253d 100644 --- a/docs/release-notes/5.41.2/changelog.mdx +++ b/docs/release-notes/5.41.2/changelog.mdx @@ -71,7 +71,7 @@ Upon deploying Admin and Website applications, Webiny deploys a couple of Cloudf - Learn more about Webiny's cloud architecture in the [Cloud Architecture](/docs/{version}/architecture/introduction) documentation. + Learn more about Webiny's cloud architecture in the [Cloud Architecture](/docs/architecture/introduction) documentation. @@ -89,7 +89,7 @@ To fix this, we had to internally instruct Pulumi to ignore changes in the `stag ### Skip "First Deployment" Check When In CI Environment ([#4408](https://github.com/webiny/webiny-js/pull/4408)) -When users deploy their project for the first time via the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, Webiny shows the following short message: +When users deploy their project for the first time via the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) command, Webiny shows the following short message: First Deployment Message @@ -105,7 +105,7 @@ We've added basic error logging during the execution of lifecycle event handlers This will help users debug issues because. Not only will they be able to see the newly added logs in their [Amazon CloudWatch logs](https://webiny.link/cloudwatch), but also, in their browser. -The following example shows a log that happened because of an error that occurred during the [`onEntryBeforePublish`](/docs/{version}/headless-cms/references/lifecycle-events#on-entry-before-publish) lifecycle event: +The following example shows a log that happened because of an error that occurred during the [`onEntryBeforePublish`](/docs/headless-cms/references/lifecycle-events#on-entry-before-publish) lifecycle event: Error Logging Event Handlers @@ -113,7 +113,7 @@ The following example shows a log that happened because of an error that occurre In case you missed it, with the `DEBUG` env variable set to `true`, all the logs that occur during a single GraphQL HTTP request are actually forwarded to user's browser console. - To learn more about the `DEBUG` environment variable, check out the [Environment Variables](/docs/{version}/core-development-concepts/basics/environment-variables#debug) documentation. + To learn more about the `DEBUG` environment variable, check out the [Environment Variables](/docs/core-development-concepts/basics/environment-variables#debug) documentation. diff --git a/docs/release-notes/5.41.4/changelog.mdx b/docs/release-notes/5.41.4/changelog.mdx index c0ac8ef58..0a42e76dc 100644 --- a/docs/release-notes/5.41.4/changelog.mdx +++ b/docs/release-notes/5.41.4/changelog.mdx @@ -39,7 +39,7 @@ We've introduced a new type of an extension called **Page Builder element** exte Once run, the extension will make sure a users ends up with all of the required files and configurations for a new Page Builder element plugin. This will make it easier for users to start developing new Page Builder elements. -The extension can be accessed like any other extension, via the [`webiny extension`](/docs/{version}/core-development-concepts/basics/webiny-cli#yarn-webiny-extension) command, by then selecting **Page Builder Element** from the list of all available extensions. +The extension can be accessed like any other extension, via the [`webiny extension`](/docs/core-development-concepts/basics/webiny-cli#yarn-webiny-extension) command, by then selecting **Page Builder Element** from the list of all available extensions. ### New Page Element Plugins ([#4340](https://github.com/webiny/webiny-js/pull/4340)) diff --git a/docs/release-notes/5.42.0/changelog.mdx b/docs/release-notes/5.42.0/changelog.mdx index 061dc1186..1bd0bdc40 100644 --- a/docs/release-notes/5.42.0/changelog.mdx +++ b/docs/release-notes/5.42.0/changelog.mdx @@ -61,7 +61,7 @@ We have added a new `Logger` into to the system. This logger is primarily for ou -If you want to use logger in your project, you can read about it in [this article](/docs/{version}/core-development-concepts/basics/logger). +If you want to use logger in your project, you can read about it in [this article](/docs/core-development-concepts/basics/logger). ### Updated Dependencies ([#4353](https://github.com/webiny/webiny-js/pull/4353) [#4338](https://github.com/webiny/webiny-js/pull/4338) [#4426](https://github.com/webiny/webiny-js/pull/4426) [#4430](https://github.com/webiny/webiny-js/pull/4430)) @@ -69,7 +69,7 @@ We have updated a number of Webiny dependencies in this release. We will not lis If there are any out of date (out of sync) packages in our users project, they will be informed about that during the upgrade process, and will be given an option to update them to the same version Webiny uses. -To find out more about that part of the upgrade process, please read [this article](/docs/{version}/core-development-concepts/basics/user-project-upgrade). +To find out more about that part of the upgrade process, please read [this article](/docs/core-development-concepts/basics/user-project-upgrade). ### Removed `apps/api/graphql/src/types.ts` File (New Projects Only) @@ -121,7 +121,7 @@ Of course, if needed, you can further modify these limits in your `webiny.applic - Check out the [Modify Cloud Infrastructure](/docs/{version}/infrastructure/basics/modify-cloud-infrastructure) to learn more about modifying the cloud infrastructure that Webiny deploys. + Check out the [Modify Cloud Infrastructure](/docs/infrastructure/basics/modify-cloud-infrastructure) to learn more about modifying the cloud infrastructure that Webiny deploys. diff --git a/docs/release-notes/5.42.1/changelog.mdx b/docs/release-notes/5.42.1/changelog.mdx index bcbecde12..dd00c3bc7 100644 --- a/docs/release-notes/5.42.1/changelog.mdx +++ b/docs/release-notes/5.42.1/changelog.mdx @@ -14,13 +14,13 @@ import { Alert } from "@/components/Alert"; ### Consolidation of Headless CMS Backend Plugin Naming ([#4502](https://github.com/webiny/webiny-js/pull/4502)) -We noticed there were some naming-related inconsistencies in Headless CMS backend plugins. For example, when defining a new [content model](/docs/{version}/headless-cms/extending/content-models-via-code), users would use the `createCmsModelPlugin` factory function. On the other hand, when defining a [single entry model](/docs/release-notes/5.40.6/changelog#introducing-single-entry-models-beta-4228-4298-4296), they would use the `createSingleEntryModel` factory function. +We noticed there were some naming-related inconsistencies in Headless CMS backend plugins. For example, when defining a new [content model](/docs/headless-cms/extending/content-models-via-code), users would use the `createCmsModelPlugin` factory function. On the other hand, when defining a [single entry model](/docs/release-notes/5.40.6/changelog#introducing-single-entry-models-beta-4228-4298-4296), they would use the `createSingleEntryModel` factory function. This PR not only consolidates the naming of these plugins but also exports them all via the `@webiny/api-serverless-cms` package. This way, users can import all CMS-related plugins from a single package. - The existing [Define Content Models via Code](/docs/{version}/headless-cms/extending/content-models-via-code) article has been updated to reflect these changes. + The existing [Define Content Models via Code](/docs/headless-cms/extending/content-models-via-code) article has been updated to reflect these changes. @@ -61,7 +61,7 @@ With this release, we've fixed an issue where these Admin User entries were not ### Fixed VPC Configuration for Production Deployment ([#4521](https://github.com/webiny/webiny-js/pull/4521)) -In case you missed it, Webiny can be deployed into two [deployment modes](/docs/{version}/architecture/deployment-modes/introduction): development and production. As the names suggest, the development mode is used for development and testing purposes, while the production mode is used for live applications. +In case you missed it, Webiny can be deployed into two [deployment modes](/docs/architecture/deployment-modes/introduction): development and production. As the names suggest, the development mode is used for development and testing purposes, while the production mode is used for live applications. When comparing the two, the main difference is the usage of Amazon VPC (Virtual Private Cloud). In production mode, eligible cloud resources are deployed within a VPC, which provides an additional layer of security and isolation. @@ -84,7 +84,7 @@ When not using the `/enterprise` version, the VPC configuration would be applied ### Refreshing the CI/CD Scaffold ([#4526](https://github.com/webiny/webiny-js/pull/4526)) -We've refreshed the [GitHub Actions CI/CD](/docs/{version}/core-development-concepts/ci-cd/setup#git-hub-actions) scaffold to ensure it's up-to-date with the latest changes. One of the main changes is the update of Node.js version that was used to run the CI/CD pipeline. The version has been updated from 14 all the way to 20. +We've refreshed the [GitHub Actions CI/CD](/docs/core-development-concepts/ci-cd/setup#git-hub-actions) scaffold to ensure it's up-to-date with the latest changes. One of the main changes is the update of Node.js version that was used to run the CI/CD pipeline. The version has been updated from 14 all the way to 20. ## Other diff --git a/docs/release-notes/5.42.3/changelog.mdx b/docs/release-notes/5.42.3/changelog.mdx index 64378d39b..ffeb3afdc 100644 --- a/docs/release-notes/5.42.3/changelog.mdx +++ b/docs/release-notes/5.42.3/changelog.mdx @@ -27,7 +27,7 @@ These plugins allow fine-grained control, such as targeting specific models. For more details, check out the related documentation: -- [Adding custom fields to CMS folders](/docs/{version}/headless-cms/extending/customize-folder-fields) +- [Adding custom fields to CMS folders](/docs/headless-cms/extending/customize-folder-fields) - [Adding custom fields to Page Builder folders](/docs/page-builder/extending/customize-folder-fields) - [Adding custom fields to File Manager folders](/docs/file-manager/extending/customize-folder-fields) diff --git a/docs/release-notes/5.43.0/upgrade-guide.mdx b/docs/release-notes/5.43.0/upgrade-guide.mdx index fc885c355..5e87d40b9 100644 --- a/docs/release-notes/5.43.0/upgrade-guide.mdx +++ b/docs/release-notes/5.43.0/upgrade-guide.mdx @@ -110,7 +110,7 @@ Once you have updated your Webiny project configuration, you will need to redepl Note that, during deployment, the VPC configuration will now be correctly attached to the Amazon OpenSearch cluster. As a result, the previously deployed cluster will be **DESTROYED** and a new one created. This will result in the **loss of all data from the previous cluster**❗ -Luckily, the data can be recreated. Once the new cluster is deployed, the recreation can be done via the [Amazon OpenSearch - Reindexing Background Task](/docs/{version}/core-development-concepts/background-tasks/built-in-background-tasks#amazon-open-search-reindexing-background-task), which can be triggered via the GraphQL API or via a custom plugin. This can also be done manually, or alternatively, via a [post-deployment hook](https://www.webiny.com/docs/{version}/infrastructure/basics/build-and-deploy-hooks) script that you can add to your Webiny project. +Luckily, the data can be recreated. Once the new cluster is deployed, the recreation can be done via the [Amazon OpenSearch - Reindexing Background Task](/docs/core-development-concepts/background-tasks/built-in-background-tasks#amazon-open-search-reindexing-background-task), which can be triggered via the GraphQL API or via a custom plugin. This can also be done manually, or alternatively, via a [post-deployment hook](https://www.webiny.com/docs/infrastructure/basics/build-and-deploy-hooks) script that you can add to your Webiny project. In case you need more help with this, especially when it comes to planning and executing the data migration, please reach out to us via our [community Slack](https://webiny.com/slack). diff --git a/docs/release-notes/5.43.2/changelog.mdx b/docs/release-notes/5.43.2/changelog.mdx index 65cb7ec68..e63638a0f 100644 --- a/docs/release-notes/5.43.2/changelog.mdx +++ b/docs/release-notes/5.43.2/changelog.mdx @@ -16,7 +16,7 @@ A new **confirmation dialog** has been introduced when users move folders via dr By enabling the new `DropConfirmation` configuration under the `Browser.Folder` namespace, users will now be prompted to confirm the action, helping prevent accidental folder moves. -This feature is available in the [CMS](/docs/{version}/headless-cms/extending/confirmation-dialog-for-folder-drag-and-drop), [File Manager](/docs/file-manager/extending/confirmation-dialog-for-folder-drag-and-drop) and [Page Builder](/docs/page-builder/extending/confirmation-dialog-for-folder-drag-and-drop) apps. +This feature is available in the [CMS](/docs/headless-cms/extending/confirmation-dialog-for-folder-drag-and-drop), [File Manager](/docs/file-manager/extending/confirmation-dialog-for-folder-drag-and-drop) and [Page Builder](/docs/page-builder/extending/confirmation-dialog-for-folder-drag-and-drop) apps. By default, the confirmation is disabled (`false`) and can be turned on by setting `DropConfirmation` to `true` in the relevant app config. diff --git a/docs/release-notes/5.5.0/changelog.mdx b/docs/release-notes/5.5.0/changelog.mdx index f6d461ae8..c16f3645b 100644 --- a/docs/release-notes/5.5.0/changelog.mdx +++ b/docs/release-notes/5.5.0/changelog.mdx @@ -30,7 +30,7 @@ The brand new `webiny watch` command brings local development experience to a wh #### How We Currently Do It -Let’s say you wanted to expand the default GraphQL API, that’s deployed as part of the [API](/docs/{version}/architecture/api/overview) project application. At the moment, in order to do that, you’d have to do the following: +Let’s say you wanted to expand the default GraphQL API, that’s deployed as part of the [API](/docs/architecture/api/overview) project application. At the moment, in order to do that, you’d have to do the following: - start a watch session on relevant packages using the `webiny workspaces run` command - make your code changes @@ -59,7 +59,7 @@ This basically means **no more digging** through [Amazon CloudWatch](https://aws -To learn more about the new `webiny watch` command, check out the newly added [Use the Watch Command](/docs/{version}/core-development-concepts/basics/watch-command) guide. +To learn more about the new `webiny watch` command, check out the newly added [Use the Watch Command](/docs/core-development-concepts/basics/watch-command) guide. @@ -95,7 +95,7 @@ Now you have to define access to specific content model groups first, and based ### Rich Text Content Renderer ([#1566](https://github.com/webiny/webiny-js/pull/1566)) -Up until now, you had to manually render rich text content that comes from the Headless CMS. To make it a lot easier for you, we've finally introduced a dedicated component to do the heavy lifting. For details, see the [how-to guide on rendering the rich text content](/docs/{version}/headless-cms/extending/render-rich-text-content). +Up until now, you had to manually render rich text content that comes from the Headless CMS. To make it a lot easier for you, we've finally introduced a dedicated component to do the heavy lifting. For details, see the [how-to guide on rendering the rich text content](/docs/headless-cms/extending/render-rich-text-content). ### Filtering by Reference Field Id ([#1567](https://github.com/webiny/webiny-js/pull/1567)) @@ -162,7 +162,7 @@ All the changes can be automatically applied in your existing Webiny project via #### 1. `.pulumi` Folders Moved To Project Root -By default, the Pulumi cloud infrastructure [state files](/docs/{version}/infrastructure/pulumi-iac/iac-with-pulumi#state-files) are stored locally - in `.pulumi` folders located in your project applications folders: +By default, the Pulumi cloud infrastructure [state files](/docs/infrastructure/pulumi-iac/iac-with-pulumi#state-files) are stored locally - in `.pulumi` folders located in your project applications folders: ```bash api/.pulumi @@ -206,7 +206,7 @@ Every project application now has its own `webiny.application.js` file. Think of -Learn more about project applications in the [Project Applications](/docs/{version}/core-development-concepts/project-organization/project-applications) guide. +Learn more about project applications in the [Project Applications](/docs/core-development-concepts/project-organization/project-applications) guide. diff --git a/docs/release-notes/5.5.0/upgrade-guide.mdx b/docs/release-notes/5.5.0/upgrade-guide.mdx index ee94a1197..69af544ae 100644 --- a/docs/release-notes/5.5.0/upgrade-guide.mdx +++ b/docs/release-notes/5.5.0/upgrade-guide.mdx @@ -49,7 +49,7 @@ Running this command will apply a minor fix to the `webiny upgrade` command that -This release includes a couple of smaller changes on the project organization level. To make it easier, we provide a simple [Webiny CLI](/docs/{version}/core-development-concepts/basics/webiny-cli) command that will automatically make all the necessary adjustments for you. +This release includes a couple of smaller changes on the project organization level. To make it easier, we provide a simple [Webiny CLI](/docs/core-development-concepts/basics/webiny-cli) command that will automatically make all the necessary adjustments for you. Once you've run the above upgrade command, run the following: @@ -68,7 +68,7 @@ Before running the `webiny upgrade` command, we recommend that you commit any ac Once the `webiny upgrade` command has finished, a couple of manual steps remain to be completed, after which, your project should be completely updated. -You can then proceed by committing the changes to your working branch and trying to [deploy](/docs/{version}/core-development-concepts/basics/project-deployment) the project to one of the development or pre-production environment. +You can then proceed by committing the changes to your working branch and trying to [deploy](/docs/core-development-concepts/basics/project-deployment) the project to one of the development or pre-production environment. #### 1. Add `apolloLinks.ts` file (located in your Website project application) diff --git a/docs/release-notes/5.6.0/changelog.mdx b/docs/release-notes/5.6.0/changelog.mdx index 7a80e7a81..27af9ad40 100644 --- a/docs/release-notes/5.6.0/changelog.mdx +++ b/docs/release-notes/5.6.0/changelog.mdx @@ -105,7 +105,7 @@ So, from now on, you can expect all of the project applications (meaning all clo As you may have already known, every Webiny project, by default, comes with three project application: **API** (`api`), **Admin Area** (`apps/admin`), and **Website** (`apps/website`). These consist of application code, and, more importantly, of necessary cloud infrastructure that needs to be deployed in order for them to work as intended. -Read more about project organization in the [Project Organization](/docs/{version}/core-development-concepts/project-organization/project-applications-and-packages) key topics section. +Read more about project organization in the [Project Organization](/docs/core-development-concepts/project-organization/project-applications-and-packages) key topics section. diff --git a/docs/release-notes/5.7.0/changelog.mdx b/docs/release-notes/5.7.0/changelog.mdx index ed0c0ad7a..e31261ac9 100644 --- a/docs/release-notes/5.7.0/changelog.mdx +++ b/docs/release-notes/5.7.0/changelog.mdx @@ -26,17 +26,17 @@ With this release, we're introducing a brand new CI/CD scaffold, which will set Currently, you can set up your CI/CD via [GitHub Actions](https://github.com/features/actions) only. But note that in the future, we would certainly like to bring support for more providers, depending on the interest from the community. -For more information on how to use the new scaffold, make sure to check out the also new [Set up CI/CD](/docs/{version}/core-development-concepts/ci-cd/setup) how-to guide. +For more information on how to use the new scaffold, make sure to check out the also new [Set up CI/CD](/docs/core-development-concepts/ci-cd/setup) how-to guide. -If you plan to use a different CI/CD provider, you can still create your workflows manually, by following all of the recommendations outlined in the new [CI/CD](/docs/{version}/core-development-concepts/ci-cd/introduction) key topics section. Also, if you think your provider should be supported out of the box, please [open an issue](https://github.com/webiny/webiny-js/issues/new) or [contact us](https://www.webiny.com/slack). +If you plan to use a different CI/CD provider, you can still create your workflows manually, by following all of the recommendations outlined in the new [CI/CD](/docs/core-development-concepts/ci-cd/introduction) key topics section. Also, if you think your provider should be supported out of the box, please [open an issue](https://github.com/webiny/webiny-js/issues/new) or [contact us](https://www.webiny.com/slack). ### Improved `--debug` Argument (`webiny deploy` and `webiny destroy` Commands) ([#1624](https://github.com/webiny/webiny-js/pull/1624), [@ankurvr](https://github.com/ankurvr)) -From this release, passing the `--debug` flag upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) and [`webiny destroy`](/docs/{version}/infrastructure/basics/destroy-cloud-infrastructure) commands will also include additional deployment-related information and logs. +From this release, passing the `--debug` flag upon running the [`webiny deploy`](/docs/core-development-concepts/basics/project-deployment) and [`webiny destroy`](/docs/infrastructure/basics/destroy-cloud-infrastructure) commands will also include additional deployment-related information and logs. The following example shows how you can use it with the `webiny deploy` command: @@ -80,11 +80,11 @@ Starting with this `5.7.0` release, we'll be experimenting more and more in this ### New CI/CD Key Topics -We've just published the brand new [CI/CD](/docs/{version}/core-development-concepts/ci-cd/introduction) key topics section, which, as you might've already guessed, covers everything that there is to know about setting up a CI/CD workflow for your Webiny projects. +We've just published the brand new [CI/CD](/docs/core-development-concepts/ci-cd/introduction) key topics section, which, as you might've already guessed, covers everything that there is to know about setting up a CI/CD workflow for your Webiny projects. ### Security Framework Key Topics -We've finally put together several articles explaining what [Webiny Security Framework](/docs/{version}/core-development-concepts/security-framework/introduction) is and how everything is tied together on both API and React side. +We've finally put together several articles explaining what [Webiny Security Framework](/docs/core-development-concepts/security-framework/introduction) is and how everything is tied together on both API and React side. ### Multi-Tenancy Key Topic diff --git a/docs/release-notes/5.7.0/upgrade-guide.mdx b/docs/release-notes/5.7.0/upgrade-guide.mdx index 43d2b00dd..ec08e8dfe 100644 --- a/docs/release-notes/5.7.0/upgrade-guide.mdx +++ b/docs/release-notes/5.7.0/upgrade-guide.mdx @@ -307,4 +307,4 @@ export default () => [ ## Redeploy! -Now you're ready to redeploy your API and apps. By now, you're most likely familiar with the deployment process, but if you need a refresher, visit our [Deploy Your Project](/docs/{version}/core-development-concepts/basics/project-deployment) guide for everything related to deployments. +Now you're ready to redeploy your API and apps. By now, you're most likely familiar with the deployment process, but if you need a refresher, visit our [Deploy Your Project](/docs/core-development-concepts/basics/project-deployment) guide for everything related to deployments. diff --git a/docs/release-notes/5.8.0/changelog.mdx b/docs/release-notes/5.8.0/changelog.mdx index 4bd7aa190..23c6dbb89 100644 --- a/docs/release-notes/5.8.0/changelog.mdx +++ b/docs/release-notes/5.8.0/changelog.mdx @@ -20,11 +20,11 @@ Please check the [Webiny 5.8.0 migration guide](/docs/release-notes/5.8.0/upgrad ### Filtering of Content Entries by `createdBy` and `ownedBy` Fields ([#1641](https://github.com/webiny/webiny-js/issues/1641)) -Via the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api), existing content entries can now be filtered by `createdBy` and `ownedBy` fields. This can be useful when in need to retrieve content entries created or owned by a specific user. For example: +Via the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api), existing content entries can now be filtered by `createdBy` and `ownedBy` fields. This can be useful when in need to retrieve content entries created or owned by a specific user. For example: ![Filtering of Content Entries by createdBy Field](./createdBy.png) -The filtering can be utilized in any of the [three Headless CMS GraphQL API types](/docs/{version}/headless-cms/basics/graphql-api#graphql-api-types) - manage, preview, and read. +The filtering can be utilized in any of the [three Headless CMS GraphQL API types](/docs/headless-cms/basics/graphql-api#graphql-api-types) - manage, preview, and read. ### Filtering of Content Entries by `entryId` ([#1660](https://github.com/webiny/webiny-js/pull/1660)) @@ -36,13 +36,13 @@ With Webiny Headless CMS, users first define content models, for example **Blog -Via the [Headless CMS GraphQL API](/docs/{version}/headless-cms/basics/graphql-api), this structure of content entry IDs allows users to retrieve a specific revision of a content entry. For example, here we are retrieving the revision number three (note the `#0003` in the value passed to the `id` input field): +Via the [Headless CMS GraphQL API](/docs/headless-cms/basics/graphql-api), this structure of content entry IDs allows users to retrieve a specific revision of a content entry. For example, here we are retrieving the revision number three (note the `#0003` in the value passed to the `id` input field): ![Filtering of Content Entries by id Field](./retrieveById.png) But still, we've seen cases in which users just want to retrieve the currently published revision of a particular content entry, making the actual revision number irrelevant. -So, starting from this release, you can also query content entries by `entryId`. It is a new GraphQL input field which, depending on the Headless CMS GraphQL API [type](/docs/{version}/headless-cms/basics/graphql-api#graphql-api-types), applies the following filtering: +So, starting from this release, you can also query content entries by `entryId`. It is a new GraphQL input field which, depending on the Headless CMS GraphQL API [type](/docs/headless-cms/basics/graphql-api#graphql-api-types), applies the following filtering: - **manage** and **preview** - will look for the **latest** content entry revision - **read** - will look for the **published** content entry revision diff --git a/docs/release-notes/5.9.0/changelog.mdx b/docs/release-notes/5.9.0/changelog.mdx index 2b92a4feb..bb2a63e13 100644 --- a/docs/release-notes/5.9.0/changelog.mdx +++ b/docs/release-notes/5.9.0/changelog.mdx @@ -32,7 +32,7 @@ To learn more about the changes we made and the reasoning behind them, check out -To learn more about scaffolding and all of the available scaffolds, check out the [Scaffolding](/docs/{version}/core-development-concepts/scaffolding/introduction) how-to guides section. +To learn more about scaffolding and all of the available scaffolds, check out the [Scaffolding](/docs/core-development-concepts/scaffolding/introduction) how-to guides section. diff --git a/docs/release-notes/5.9.0/upgrade-guide.mdx b/docs/release-notes/5.9.0/upgrade-guide.mdx index 2af5a81c4..143fb2d98 100644 --- a/docs/release-notes/5.9.0/upgrade-guide.mdx +++ b/docs/release-notes/5.9.0/upgrade-guide.mdx @@ -87,7 +87,7 @@ As stated in the [Upgrade Webiny](/docs/release-notes/upgrade-webiny#pre-product -Learn more about different deployment environments in the [CI/CD / Environments](/docs/{version}/core-development-concepts/ci-cd/environments) key topic. +Learn more about different deployment environments in the [CI/CD / Environments](/docs/core-development-concepts/ci-cd/environments) key topic. diff --git a/docs/release-notes/upgrade-webiny.mdx b/docs/release-notes/upgrade-webiny.mdx index f88684e33..093b66826 100644 --- a/docs/release-notes/upgrade-webiny.mdx +++ b/docs/release-notes/upgrade-webiny.mdx @@ -21,7 +21,7 @@ Whenever you're doing an upgrade, we recommended that you first deploy your chan -Learn how to deploy your project into multiple environments with the [`deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command. +Learn how to deploy your project into multiple environments with the [`deploy`](/docs/core-development-concepts/basics/project-deployment) command. @@ -61,7 +61,7 @@ Please note that it's possible to skip only **patch versions**. For example, if ### Once upgraded, do we need to re-deploy the Webiny project in order to see the changes? -Yes, once you've completed the upgrade steps, in order to actually see the new features and fixes online, you need to re-deploy you project. Which project applications you need to re-deploy? It depends on the released fixes and features, but the easiest approach would be just to deploy the entire project, using the [`yarn webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment#the-deploy-command) command. +Yes, once you've completed the upgrade steps, in order to actually see the new features and fixes online, you need to re-deploy you project. Which project applications you need to re-deploy? It depends on the released fixes and features, but the easiest approach would be just to deploy the entire project, using the [`yarn webiny deploy`](/docs/core-development-concepts/basics/project-deployment#the-deploy-command) command. Additionally, before you re-deploy the changes into the production environment, it's recommended that you re-deploy the changes into one of your test or preview environments first. @@ -92,4 +92,4 @@ npx create-webiny-project@beta my-project --tag=5.40.0-beta.5 Additionally, set the environment variable `WEBINY_VERSION=5.40.0`. Feel free to update the tag version to your intended beta version. -Please note, we do not recommend using beta versions for production projects. However, if you want to try out features available early in a beta release, you can set up a beta version. +Please note, we do not recommend using beta versions for production projects. However, if you want to try out features available early in a beta release, you can set up a beta version. \ No newline at end of file diff --git a/docs/user-guides/5.39.x/security/essentials/assign-team.mdx b/docs/user-guides/5.39.x/security/essentials/assign-team.mdx index 59ac3e0a7..6d2ff7629 100644 --- a/docs/user-guides/5.39.x/security/essentials/assign-team.mdx +++ b/docs/user-guides/5.39.x/security/essentials/assign-team.mdx @@ -17,7 +17,7 @@ In this tutorial, we will learn how to assign a team to a user. - Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/{version}/enterprise/aacl/teams) article. + Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/enterprise/aacl/teams) article. diff --git a/docs/user-guides/5.39.x/security/essentials/team-creation.mdx b/docs/user-guides/5.39.x/security/essentials/team-creation.mdx index 12b5245fb..1d0219dd5 100644 --- a/docs/user-guides/5.39.x/security/essentials/team-creation.mdx +++ b/docs/user-guides/5.39.x/security/essentials/team-creation.mdx @@ -17,7 +17,7 @@ Webiny enables you to define a team for a group of users in your application. Yo - Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/{version}/enterprise/aacl/teams) article. + Note that the Teams feature is part of our enterprise offering. To learn more, please check out the [Teams](/docs/enterprise/aacl/teams) article. diff --git a/docs/user-guides/6.0.x/assets/webiny-overview.mp4 b/docs/user-guides/6.0.x/assets/webiny-overview.mp4 deleted file mode 100644 index 43d1f2a0b..000000000 Binary files a/docs/user-guides/6.0.x/assets/webiny-overview.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/organizing-files/organizing-files.mp4 b/docs/user-guides/6.0.x/file-manager/essentials/assets/organizing-files/organizing-files.mp4 deleted file mode 100644 index 33308f9d6..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/organizing-files/organizing-files.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/organizing-files/snowboard.jpg b/docs/user-guides/6.0.x/file-manager/essentials/assets/organizing-files/snowboard.jpg deleted file mode 100644 index 4b14abb3a..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/organizing-files/snowboard.jpg and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/filter-files-by-tag.mp4 b/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/filter-files-by-tag.mp4 deleted file mode 100644 index 50dc32be5..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/filter-files-by-tag.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/snowboard.jpg b/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/snowboard.jpg deleted file mode 100644 index 4b14abb3a..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/snowboard.jpg and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/tagging-a-file.mp4 b/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/tagging-a-file.mp4 deleted file mode 100644 index ce9ec30c6..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/tagging-a-file.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/tagging-multiple-files.mp4 b/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/tagging-multiple-files.mp4 deleted file mode 100644 index 41a3cc6c8..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/tagging-files/tagging-multiple-files.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-file-drag-and-drop.mp4 b/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-file-drag-and-drop.mp4 deleted file mode 100644 index a2937bd1c..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-file-drag-and-drop.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-file-file-explorer.mp4 b/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-file-file-explorer.mp4 deleted file mode 100644 index 22661921f..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-file-file-explorer.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-image-example.png b/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-image-example.png deleted file mode 100644 index de580a3d9..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-image-example.png and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-multiple-files.mp4 b/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-multiple-files.mp4 deleted file mode 100644 index be7d73a53..000000000 Binary files a/docs/user-guides/6.0.x/file-manager/essentials/assets/upload-file/upload-multiple-files.mp4 and /dev/null differ diff --git a/docs/user-guides/6.0.x/file-manager/essentials/organizing-files.mdx b/docs/user-guides/6.0.x/file-manager/essentials/organizing-files.mdx deleted file mode 100644 index 907a0a961..000000000 --- a/docs/user-guides/6.0.x/file-manager/essentials/organizing-files.mdx +++ /dev/null @@ -1,99 +0,0 @@ ---- -id: 2f7200c3 -title: Organizing Files -description: Learn how to organize files in folders and sub-folders in File Manager. ---- - -import { Alert } from "@/components/Alert"; -import organizingFilesVideo from "./assets/organizing-files/organizing-files.mp4"; - - - -- how to create folders and sub-folders -- how to move files and folders - - - - -Webiny simplifies content organization by allowing users to create folders and sub-folders, making it easier to manage. In this tutorial, we will learn how to organize your files in folders and sub-folders in the File Manager. We will do this in a few steps: - -- Step 1: Create a folder -- Step 2: Create a sub-folder -- Step 3: Move a folder into a parent folder -- Step 4: Upload an image - -