Merge branch 'master' into DOC-516-swat-agent

Author: jeff-matthews

.github/workflows/linter.yml

@@ -55,7 +55,7 @@ jobs:
       # Run Linter against code base #
       ################################
       - name: Lint Code Base
-        uses: github/super-linter@v4
+        uses: github/super-linter@v4.8.7
         env:
           VALIDATE_ALL_CODEBASE: false
           DEFAULT_BRANCH: master

Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/magento-devdocs/devdocs-theme.git
-  revision: 841025f8b27b7b66cb4a2661f0112d3151f49fa1
+  revision: f0516a2e640bbaf04472fc0cbb206432441a674f
   specs:
-    devdocs (16)
+    devdocs (17)
       jekyll (>= 4.0)
 
 GEM

src/_data/toc/extension-best-practices.yml

@@ -1,3 +1,4 @@
+---
 label: Extension Best Practices
 pages:
     - label: Introduction
@@ -7,91 +8,94 @@ pages:
       url: /ext-best-practices/admin/admin-best-practices.html
       children:
 
-        - label: Admin Panel Placement and Design
-          url: /ext-best-practices/admin/placement-and-design.html
+          - label: Admin Panel Placement and Design
+            url: /ext-best-practices/admin/placement-and-design.html
 
-        - label: Admin FAQ
-          url: /ext-best-practices/admin/ext-best-practices_admin_FAQ.html
+          - label: Admin FAQ
+            url: /ext-best-practices/admin/ext-best-practices_admin_FAQ.html
 
     - label: Extension Coding
       url: /ext-best-practices/extension-coding/coding-best-practices.html
       children:
 
-        - label: Programming best practices
-          url: /ext-best-practices/extension-coding/common-programming-bp.html
+          - label: Programming best practices
+            url: /ext-best-practices/extension-coding/common-programming-bp.html
 
-        - label: Working with the Architecture
-          url: /ext-best-practices/extension-coding/working-with-arch-bp.html
+          - label: Working with the Architecture
+            url: /ext-best-practices/extension-coding/working-with-arch-bp.html
 
-        - label: Security, performance, and data handling
-          url: /ext-best-practices/extension-coding/security-performance-data-bp.html
+          - label: Security, performance, and data handling
+            url: /ext-best-practices/extension-coding/security-performance-data-bp.html
 
-        - label: Observers best practices
-          url: /ext-best-practices/extension-coding/observers-bp.html
+          - label: Observers best practices
+            url: /ext-best-practices/extension-coding/observers-bp.html
 
-        - label: Coding FAQ
-          url: /ext-best-practices/extension-coding/coding-faq.html
+          - label: Coding FAQ
+            url: /ext-best-practices/extension-coding/coding-faq.html
 
     - label: PHPStorm plugin
       url: /ext-best-practices/phpstorm/introduction.html
       children:
 
-        - label: Code generation
-          url: /ext-best-practices/phpstorm/code-generation.html
+          - label: Code generation
+            url: /ext-best-practices/phpstorm/code-generation.html
 
-        - label: Code inspection
-          url: /ext-best-practices/phpstorm/code-inspection.html
+          - label: Code inspection
+            url: /ext-best-practices/phpstorm/code-inspection.html
 
-        - label: Adding code inspections
-          url: /ext-best-practices/phpstorm/adding-code-inspections.html
+          - label: Adding code inspections
+            url: /ext-best-practices/phpstorm/adding-code-inspections.html
 
-        - label: New features
-          url: /ext-best-practices/phpstorm/new-features.html
+          - label: New features
+            url: /ext-best-practices/phpstorm/new-features.html
 
-        - label: Issue reporting
-          url: /ext-best-practices/phpstorm/issue-reporting.html
+          - label: Issue reporting
+            url: /ext-best-practices/phpstorm/issue-reporting.html
 
-        - label: Run the Upgrade Compatibility Tool
-          url: /ext-best-practices/phpstorm/uct-run-configuration.html
+          - label: Run the Upgrade Compatibility Tool
+            url: /ext-best-practices/phpstorm/uct-run-configuration.html
 
-        - label: The built-in Upgrade Compatibility Tool (MVP)
-          url: /ext-best-practices/phpstorm/built-in-upgrade-compatibility-tool.html
+          - label: The built-in Upgrade Compatibility Tool (MVP)
+            url: /ext-best-practices/phpstorm/built-in-upgrade-compatibility-tool.html
 
     - label: Storefront
       url: /ext-best-practices/storefront/storefront-best-practices.html
 
     - label: Security
       children:
 
-        - label: Writing secure code
-          url: /ext-best-practices/security/writing-secure-code.html
+          - label: Writing secure code
+            url: /ext-best-practices/security/writing-secure-code.html
 
     - label: Tutorials
       children:
 
-        - label: Copying fieldsets
-          url: /ext-best-practices/tutorials/copy-fieldsets.html
+          - label: Copying fieldsets
+            url: /ext-best-practices/tutorials/copy-fieldsets.html
 
-        - label: Serialized to JSON data upgrade
-          url: /ext-best-practices/tutorials/serialized-to-json-data-upgrade.html
+          - label: Serialized to JSON data upgrade
+            url: /ext-best-practices/tutorials/serialized-to-json-data-upgrade.html
 
-        - label: Modify Image Library folder permissions
-          url: /ext-best-practices/tutorials/modify-image-library-permissions/
+          - label: Modify Image Library folder permissions
+            url: /ext-best-practices/tutorials/modify-image-library-permissions/
 
-        - label: Creating an admin page
-          url: /ext-best-practices/extension-coding/example-module-adminpage.html
+          - label: Creating an admin page
+            url: /ext-best-practices/extension-coding/example-module-adminpage.html
 
-        - label: Creating a dynamic row system config
-          url: /ext-best-practices/tutorials/dynamic-row-system-config.html
+          - label: Creating a dynamic row system config
+            url: /ext-best-practices/tutorials/dynamic-row-system-config.html
 
-        - label: Creating a custom import entity
-          url: /ext-best-practices/tutorials/custom-import-entity.html
+          - label: Creating a custom import entity
+            url: /ext-best-practices/tutorials/custom-import-entity.html
 
-        - label: Creating a custom widget
-          url: /ext-best-practices/tutorials/custom-widget.html
+          - label: Creating a custom widget
+            url: /ext-best-practices/tutorials/custom-widget.html
 
-        - label: Creating an Access Control List (ACL) rule
-          url: /ext-best-practices/tutorials/create-access-control-list-rule.html
+          - label: Creating an Access Control List (ACL) rule
+            url: /ext-best-practices/tutorials/create-access-control-list-rule.html
 
-        - label: Creating an integration with an external API
-          url: /ext-best-practices/tutorials/create-integration-with-api.html
+          - label: Creating an integration with an external API
+            url: /ext-best-practices/tutorials/create-integration-with-api.html
+
+          - label: Create a custom REST API
+            url: /ext-best-practices/tutorials/create-custom-rest-api.html

src/_data/toc/installation-guide.yml

@@ -28,6 +28,10 @@ pages:
           exclude_versions: ["2.3"]
           children:
 
+            - label: Using AWS Elasticsearch
+              url: /install-gde/prereq/es-aws.html
+              exclude_versions: ["2.3"]
+
             - label: Configure nginx and Elasticsearch
               url: /install-gde/prereq/es-config-nginx.html
               exclude_versions: ["2.3"]

src/_data/whats-new.yml

@@ -4,8 +4,91 @@ description: This page contains recent changes that we think you'd like to know
   We exclude from this list proofreading, spelling checks, and all minor updates.
 link: "/whats-new.html"
 thread: "/whatsnew-feed.xml"
-updated: Mon Jan 17 15:38:41 2022
+updated: Mon Jan 31 15:38:42 2022
 entries:
+- description: Added the [Create a custom REST API](https://devdocs.magento.com/guides/v2.4/ext-best-practices/tutorials/create-custom-rest-api.html)
+    topic.
+  versions: 2.3.x, 2.4.x
+  type: New Topic
+  date: January 27, 2022
+  link: https://github.com/magento/devdocs/pull/9300
+  merge_commit: 5fd0d57992aea22a2952b4c20701b3368d455383
+  contributor: nitish-ranjan05
+  membership: false
+  labels:
+  - 2.3.x
+  - partners-contribution
+  - New Topic
+  - 'Partner: Ziffity'
+  - 2.4.x
+  - 'Progress: done'
+- description: Published [release notes](https://devdocs.magento.com/quality-patches/release-notes.html)
+    for the 1.1.9 Quality Patches Tool (QPT) package release.
+  versions: 2.x
+  type: Major Update
+  date: January 24, 2022
+  link: https://github.com/magento-commerce/devdocs/pull/2751
+  merge_commit: 599ee42938d2929cfedef767695443f2c87555fd
+  contributor: agorbivskyi
+  membership: true
+  labels:
+  - 2.x
+  - Major Update
+- description: Updated the [release schedule](https://devdocs.magento.com/release/).
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: January 24, 2022
+  link: https://github.com/magento/devdocs/pull/9328
+  merge_commit: c1653953f4e26420c0eab621f45d72eb8bee63a4
+  contributor: misuadobe
+  membership: false
+  labels:
+  - Major Update
+  - 2.3.x
+  - 2.4.x
+  - 'Progress: done'
+- description: Restored 2.3.x [Upgrade Guide](https://devdocs.magento.com/guides/v2.3/comp-mgr/bk-compman-upgrade-guide.html)
+    topics and redirected only the 2.4.x topics to the migrated guide on [Experience
+    League](https://experienceleague.adobe.com/docs/commerce-operations/upgrade-guide/overview.html).
+  versions: 2.3.x, 2.4.x
+  type: Major Update
+  date: January 21, 2022
+  link: https://github.com/magento-commerce/devdocs/pull/2749
+  merge_commit: f73452c4b7575cfca7beb37dab422d1547a8a8ef
+  contributor: jeff-matthews
+  membership: true
+  labels:
+  - Major Update
+  - 2.3.x
+  - 2.4.x
+- description: Updated the Cloud guide to [clarify log rotation tip](https://devdocs.magento.com/cloud/project/log-locations.html),
+    [delete custom VCL snippets](http://devdocs.magento.com/cloud/cdn/fastly-vcl-bypass-to-origin.html#delete-the-custom-vcl-snippet),
+    and provide an additional example with multiple themes and locales for the [SCD_MATRIX
+    build variable](https://devdocs.magento.com/cloud/env/variables-build.html#scd_matrix).
+  versions: 2.x
+  type: Technical
+  date: January 20, 2022
+  link: https://github.com/magento-commerce/devdocs/pull/2736
+  merge_commit: bb55fd340360edd73af89dfc02628bb169843593
+  contributor: hguthrie
+  membership: true
+  labels:
+  - 2.x
+  - Technical
+  - imported
+- description: Added [extended support](https://devdocs.magento.com/release/lifecycle-policy.html)
+    date for 2.3.
+  versions: 2.3.x
+  type: Major Update
+  date: January 20, 2022
+  link: https://github.com/magento/devdocs/pull/9329
+  merge_commit: 9c12b816643b303e5bcf07252d3402a1b5115b33
+  contributor: misuadobe
+  membership: false
+  labels:
+  - Major Update
+  - 2.3.x
+  - 'Progress: done'
 - description: Added the [contactUs](https://devdocs.magento.com/guides/v2.4/graphql/mutations/contact-us.html)
     mutation topic.
   versions: 2.4.x

src/cloud/project/ece-tools-upgrade-project.md

@@ -71,14 +71,14 @@ To upgrade project to use ece-tools:
        # We run build hooks before your application has been packaged.
        build: |
            set -e
-           php ./vendor/bin/ece-tools build:generate
-           php ./vendor/bin/ece-tools build:transfer
+           php ./vendor/bin/ece-tools run scenario/build/generate.xml
+           php ./vendor/bin/ece-tools run scenario/build/transfer.xml
        # We run deploy hook after your application has been deployed and started.
        deploy: |
-           php ./vendor/bin/ece-tools deploy
+           php ./vendor/bin/ece-tools run scenario/deploy.xml
        # We run post deploy hook to clean and warm the cache. Available with ECE-Tools 2002.0.10.
        post_deploy: |
-           php ./vendor/bin/ece-tools post-deploy
+           php ./vendor/bin/ece-tools run scenario/post-deploy.xml
    ```
 
 1. Check for and remove the [deprecated packages](#remove-deprecated-packages). The deprecated packages can prevent a successful upgrade.

src/cloud/project/project-upgrade.md

@@ -64,14 +64,14 @@ To update the `.magento.app.yaml` file:
        # We run build hooks before your application has been packaged.
        build: |
            set -e
-           php ./vendor/bin/ece-tools build:generate
-           php ./vendor/bin/ece-tools build:transfer
+           php ./vendor/bin/ece-tools run scenario/build/generate.xml
+           php ./vendor/bin/ece-tools run scenario/build/transfer.xml
        # We run deploy hook after your application has been deployed and started.
        deploy: |
-           php ./vendor/bin/ece-tools deploy
+           php ./vendor/bin/ece-tools run scenario/deploy.xml
        # We run post deploy hook to clean and warm the cache. Available with ECE-Tools 2002.0.10.
        post_deploy: |
-           php ./vendor/bin/ece-tools post-deploy
+           php ./vendor/bin/ece-tools run scenario/post-deploy.xml
    ```
 
 1. Add the following environment variables to the end of the `magento.app.yaml` file.

src/cloud/project/services-mysql.md

@@ -13,12 +13,12 @@ The `mysql` service provides persistent data storage based on [MariaDB](https://
 {% include install/maria-db.md %}
 
 {:.bs-callout-warning}
-Be careful when upgrading MariaDB from version 10.1 to 10.2.
-MariaDB 10.1 is the last version that supports XtraDB as the storage engine. Version 10.2 uses InnoDB for the storage engine. Once you upgrade from 10.1 to 10.2, you cannot rollback the change. {{site.data.var.ee}} supports both storage engines; however, you must check extensions and other systems used by your project to make sure they are compatible with MariaDB 10.2. Read about this [backwards incompatible change](https://mariadb.com/kb/en/upgrading-from-mariadb-101-to-mariadb-102/#incompatible-changes-between-101-and-102).
+Be careful when upgrading MariaDB from version 10.1 to 10.2. MariaDB 10.1 is the last version that supports _XtraDB_ as the storage engine.  MariaDB 10.2 uses _InnoDB_ for the storage engine. After you upgrade from 10.1 to 10.2, you cannot roll back the change. {{site.data.var.ee}} supports both storage engines; however, you must check extensions and other systems used by your project to make sure they are compatible with MariaDB 10.2. See [Incompatible Changes Between 10.1 and 10.2](https://mariadb.com/kb/en/upgrading-from-mariadb-101-to-mariadb-102/#incompatible-changes-between-101-and-102).
 
 {% include cloud/service-config-integration-starter.md %}
 
-## Enable MySQL
+{:.procedure}
+To enable MySQL:
 
 1. Add the required name, type, and disk value (in MB) to the `.magento/services.yaml` file.
 
@@ -41,21 +41,40 @@ MariaDB 10.1 is the last version that supports XtraDB as the storage engine. Ver
 1. Add, commit, and push your code changes.
 
    ```bash
-   git add -A && git commit -m "Enable mysql service" && git push   origin <branch-name>
+   git add -A && git commit -m "Enable mysql service" && git push origin <branch-name>
    ```
 
 1. [Verify the service relationships]({{ site.baseurl }}/cloud/project/services.html#service-relationships).
 
    {%include cloud/tip-change-installed-service-version.md%}
 
-## Set up multiple database users
+## Configure MySQL database
 
-Optionally, you can set up multiple databases and multiple users with different permissions.
+You have the following options when configuring the MySQL database:
 
-An _endpoint_ is a set of credentials (or users) with specific privileges. By default, there is one endpoint named `mysql` that has administrator access to all defined databases. To set up multiple database users, you must define multiple endpoints in the services.yaml file and declare the relationships in the `.magento.app.yaml` file. For Pro Staging and Production environments, submit a Support ticket to request the additional user.
+-  **`schemas`**—A schema defines a database. The default schema is the `main` database.
+-  **`endpoints`**—Each endpoint represents a credential with specific privileges. The default endpoint is `mysql`, which has `admin` access to the `main` database.
+-  **`properties`**—Properties are used to define additional database configurations.
 
-{:.bs-callout-warning}
-You cannot use multiple _databases_ with {{site.data.var.ee}}, but you **can** create multiple endpoints to restrict access to the `main` database.
+The following is a basic example configuration in the `.magento/services.yaml` file:
+
+```yaml
+mysql:
+    type: mysql:10.4
+    disk: 5120
+    configuration:
+        properties:
+            optimizer_switch: "rowid_filter=off"
+            optimizer_use_condition_selectivity: 1
+```
+
+The `properties` in the above example modifies the default `optimizer` settings as [recommended in the Performance Best Practices guide]({{ site.baseurl }}{{ site.gdeurl }}/performance-best-practices/configuration.html#indexers).
+
+### Set up multiple database users
+
+Optionally, you can set up multiple users with different permissions for accessing the `main` database.
+
+By default, there is one endpoint named `mysql` that has administrator access to the database. To set up multiple database users, you must define multiple endpoints in the `services.yaml` file and declare the relationships in the `.magento.app.yaml` file. For Pro Staging and Production environments, submit a Support ticket to request the additional user.
 
 Use a nested array to define the endpoints for specific user access. Each endpoint can designate access to one or more schemas (databases) and different levels of permission on each.
 
@@ -65,11 +84,11 @@ The valid permission levels are:
 -  `rw`: SELECT queries and INSERT, UPDATE, and DELETE queries are allowed.
 -  `admin`: All queries are allowed, including DDL queries (CREATE TABLE, DROP TABLE, and so on).
 
-If no endpoints are defined, a single endpoint named `mysql` has `admin` access to the `main` database. For example:
+For example:
 
 ```yaml
 mysql:
-    type: mysql:10.3
+    type: mysql:10.4
     disk: 5120
     configuration:
         schemas:
@@ -85,6 +104,9 @@ mysql:
             importer:
                 privileges:
                     main: rw
+        properties:
+            optimizer_switch: "rowid_filter=off"
+            optimizer_use_condition_selectivity: 1
 ```
 
 In the preceding example, the `admin` endpoint provides admin-level access to the `main` database, the `reporter` endpoint provides read-only access, and the `importer` endpoint provides read-write access, which means: