Merge branch 'master' into patch-95

Author: dobooth

src/cloud/project/log-locations.md

@@ -13,7 +13,7 @@ Logs are useful for troubleshooting problems related to {{site.data.var.ece}} [b
 Magento-specific logs are in the `<magento-root-dir>/var/` directory. See [Magento Logging][configlog] in the _Configuration guide_.
 
 {:.bs-callout-tip}
-You can [set up log-based Slack and email notifications][slacklog] when configuring your Cloud environment.
+When you configure your Cloud environment, you can [set up log-based Slack and email notifications][slacklog] for build and deploy actions.
 
 ## Viewing logs
 

src/cloud/project/project-upgrade.md

@@ -6,25 +6,25 @@ functional_areas:
   - Upgrade
 ---
 
-You can upgrade the core {{site.data.var.ee}} code base to a newer version. It is best to review the summary of the updated [technology stack] before upgrading your project. If you need to upgrade from a version older than 2.1, you must upgrade to a supported version first. See [Upgrades and patches] for upgrade path details.
+You can upgrade the core {{site.data.var.ee}} code base to a newer version. Before upgrading your project, review the [{{site.data.var.ece}} service versions][version compatibility matrix] information for the latest software version requirements. If you need to upgrade from a version older than 2.1, you must upgrade to a supported version first. See [Upgrades and patches] for upgrade path details.
 
 {% include cloud/note-upgrade.md %}
 
 {% include cloud/note-ece-tools-package.md %}
 
-## Upgrading from older versions of the Magento application
+## Upgrade from older versions of the Magento application
 
-If you are upgrading from 2.1.4 or later to 2.2.x or later, review the [Magento technology stack requirements]. Your upgrade tasks may include the following:
+If you are upgrading from 2.1.4 or later to 2.2.x or later, review the [{{site.data.var.ece}} service versions][version compatibility matrix] information for the latest software version requirements. Your upgrade tasks may include the following:
 
 -  Upgrade your PHP version
 -  Convert an older configuration management file
 -  Update the `.magento.app.yaml` file with new settings for hooks and environment variables
--  Upgrade to the latest supported version of Fastly
+-  Upgrade third-party extensions to the latest supported version
 -  Update the `.gitignore` file
 
 ### Configuration management
 
-If you are upgrading from 2.1.4 or later to 2.2.x or later and use [Configuration Management], you need to migrate the `config.local.php` file. Older versions used a `config.local.php` file for Configuration Management, but version 2.2.0 and later use the `config.php` file. This file works exactly as the `config.local.php` file, with additional settings that include a list of your enabled modules, additional configurations, and a different name.
+If you are upgrading from 2.1.4 or later to 2.2.x or later and use [Configuration Management], you need to migrate the `config.local.php` file. Older versions used a `config.local.php` file for Configuration Management, but version 2.2.0 and later use the `config.php` file. This file works exactly like the `config.local.php` file, but it has different configuration settings that include a list of your enabled modules and additional configuration options.
 
 {:.procedure}
 To create a temporary `config.php` file:
@@ -86,9 +86,9 @@ To update the `.magento.app.yaml` file:
 
 1. Continue with the upgrade process.
 
-## Upgrading the Magento application
+## Upgrade the Magento application
 
-Review the [Magento technology stack requirements] before upgrading your Magento application.
+Review the [service versions][version compatibility matrix] information for the latest software version requirements before upgrading your Magento application.
 
 ### Back up the database
 
@@ -173,7 +173,7 @@ To create a system-specific configuration file:
 {:.bs-callout-warning}
 For an upgrade, you delete the `config.php` file. Once this file is added to your code, you should **not** delete it. If you need to remove or edit settings, you must edit the file manually.
 
-### Upgrading extensions
+### Upgrade extensions
 
 Review your third-party extension and module pages in Marketplace or other company sites to verify support for {{site.data.var.ee}} and {{site.data.var.ece}}. If you need to upgrade any third-party extensions and modules, we recommend working in a new Integration branch with your extensions disabled.
 
@@ -197,7 +197,9 @@ To verify and upgrade your extensions:
 1. Push to the Staging environment to test in a pre-production environment.
 
 We strongly recommend upgrading your Production environment _before_ including the upgraded extensions in your go-live process.
-We also recommend upgrading to the latest version of the Fastly CDN module for Magento 2.
+
+{:.bs-callout-info}
+When you upgrade your Magento version, the upgrade process updates to the latest version of the [Fastly CDN module for Magento 2] automatically.
 
 ## Troubleshoot upgrade
 
@@ -222,11 +224,11 @@ To resolve the error:
    git add -A && git commit -m "Fixed deployment failure" && git push magento <branch-name>
    ```
 
-[technology stack]: {{site.baseurl}}/guides/v2.3/install-gde/system-requirements-tech.html
+[version compatibility matrix]: {{site.baseurl}}/cloud/project/project-conf-files_services.html#service-versions
 [Upgrades and patches]: {{site.baseurl}}/cloud/project/project-upgrade-parent.html
-[Magento technology stack requirements]: {{site.baseurl}}/guides/v2.3/install-gde/system-requirements-tech.html
 [Configuration Management]: {{site.baseurl}}/cloud/live/sens-data-over.html
 [extensions section of the .magento.app.yaml file]: {{site.baseurl}}/cloud/project/project-conf-files_magento-app.html#configure-php-options
 [.magento.app.yaml]: {{site.baseurl}}/cloud/project/project-conf-files_magento-app.html
 [version constraint syntax]: {{site.baseurl}}/cloud/project/ece-tools-upgrade-project.html#metapackage
+[Fastly CDN module for Magento 2]: {{site.baseurl}}/cloud/cdn/cloud-fastly.html#fastly-cdn-module-for-magento-2
 [Examine the logs]: {{site.baseurl}}/cloud/project/log-locations.html

src/cloud/requirements/cloud-requirements.md

@@ -62,7 +62,7 @@ You cannot upgrade the software, but you can configure the following services:
 *  [Elasticsearch]({{ site.baseurl }}/cloud/project/project-conf-files_services-elastic.html)
 
  {:.bs-callout-info}
-See [Magento technology stack requirements]({{ site.baseurl }}/guides/v2.3/install-gde/system-requirements-tech.html) for the latest software version requirements.
+See the [{{site.data.var.ece}} service versions][version compatibility matrix] information for the latest software version requirements.
 
 For Staging and Production environments, you use the Fastly CDN module for Magento 2 for CDN and caching services. See [Configure Fastly services]({{ site.baseurl }}/cloud/cdn/cloud-fastly.html#fastly-cdn-module-for-magento-2).
 
@@ -133,3 +133,6 @@ Your {{site.data.var.ee}} account must *authenticate* using any of the following
 *  Bitbucket
 *  Google
 *  Create your own Cloud account
+
+<!--link definitions-->
+[version compatibility matrix]: {{site.baseurl}}/cloud/project/project-conf-files_services.html#service-versions

src/common/images/body-class-result.png

@@ -445,7 +445,7 @@ Next, register the sample file for our entity.
 
 ```xml
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_ImportExport:etc/import.xsd">
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <type name="Magento\ImportExport\Model\Import\SampleFileProvider">
         <arguments>
             <argument name="samples" xsi:type="array">

src/guides/v2.3/ext-best-practices/tutorials/custom-import-entity.md

@@ -23,7 +23,7 @@ Following are some common module directories:
 *  `etc`: contains configuration files; in particular, `module.xml`, which is required.
 *  `Model`: contains PHP model classes as part of MVC vertical implementation of module logic.
 *  `Setup`: contains classes for module database structure and data setup which are invoked when installing or upgrading.
-*  `ViewModel`: contains PHP model clasees as part of a model-view-viewmodel (MVVM) implementation. It allows developers to offload features and business logic from block classes into separate classes that are easier to maintain, test, and reuse.
+*  `ViewModel`: contains PHP model classes as part of a model-view-viewmodel (MVVM) implementation. It allows developers to offload features and business logic from block classes into separate classes that are easier to maintain, test, and reuse.
 
 #### Additional directories
 {:.no_toc}

src/guides/v2.3/extension-dev-guide/build/module-file-structure.md

@@ -127,6 +127,9 @@ The `observer` [xml](https://glossary.magento.com/xml) element has the following
 *  `disabled` - Determines whether this observer is active or not. Default value is false.
 *  `shared` - Determines the [lifestyle]({{ page.baseurl }}/extension-dev-guide/build/di-xml-file.html#object-lifestyle-configuration) of the class. Default is `true`.
 
+{: .bs-callout .bs-callout-warning}
+The observer name must be unique, or an override will occur.
+
 Below is an example of how to assign observers to watch certain events:
 
 ```xml

src/guides/v2.3/extension-dev-guide/events-and-observers.md

@@ -6,10 +6,81 @@ functional_areas:
   - System
 ---
 
-When Magento is launched, the store's configuration is loaded and copied into memory. Magento uses that copy in memory for queue message transactions. When the store's configuration is updated in the admin, the copy in memory does not automatically refresh, resulting in an outdated in-memory object state.
+When Magento is launched, the store's configuration is loaded into memory. Magento uses the in-memory configuration for queue message transactions. When the store's configuration is updated in the admin, the copy in memory does not refresh automatically, resulting in an outdated in-memory object state.
 
-To ensure the copy in memory is re-instantiated after an update, use the `PoisonPill` interface available in the MessageQueue module. Before a new message is processed, the implementation of the `PoisonPillCompareInterface` compares the version of the in-memory copy to the latest in the database. If the versions are different, the in-memory copy is destroyed and a new copy is created when the next `cron:run` job executes.
+To ensure the copy in memory is re-instantiated after an update, use the `PoisonPill` interfaces available in the MessageQueue module.
+There are three type of the `PoisonPill` interfaces:
 
-In addition to changes in the configuration, a new store view or a new website also trigger the `PoisonPill` interface.
+*. `Magento\Framework\MessageQueue\PoisonPill\PoisonPillPutInterface` - The interface contains the `put` method. An implementation of the method puts a new version of poison pill inside the database.
+*. `Magento\Framework\MessageQueue\PoisonPill\PoisonPillReadInterface` - The interface contains the `getLatestVersion` method. An implementation of the method gets and returns get latest version of the poison pill.
+*. `Magento\Framework\MessageQueue\PoisonPill\PoisonPillCompareInterface` - The interface contains the `isLatestVersion` method. An implementation of the method checks if the version of current poison pill is the latest.
+
+Before a new message is processed, the `PoisonPillCompareInterface` compares the version of the in-memory copy to the latest in the database. If the versions are different, the in-memory copy is destroyed and a new copy is created when the next `cron:run` job executes.
+
+In addition to changes in the configuration, a new store view or a new website can also trigger the `PoisonPill` interface.
 
 If `PoisonPill` determines the copy of the in-memory state needs to be re-instantiated and you have set up a `consumers_runner` cron job, Magento will automatically restart all consumers on the next run of the job. If you did not set up the cron job, you will need to manually restart any consumers that were terminated by `PoisonPill`.
+
+### How to use `PoisonPill` interfaces in Magento {#how-to-use}
+
+The method `put` of `PoisonPillPutInterface` using in the `Magento\Store\Model\Website`
+
+```php
+ /**
+  * Clear configuration cache after creation website
+  * @return $this
+  * @since 100.2.0
+  */
+ public function afterSave()
+ {
+   ...
+   $this->pillPut->put();
+   return parent::afterSave();
+ }
+```
+
+The method `getLatestVersion` of `PoisonPillReadInterface` using in the `Magento\Framework\MessageQueue\CallbackInvoker`:
+
+```php
+ /**
+  * Run short running process
+  * @param QueueInterface $queue
+  * @param int $maxNumberOfMessages
+  * @param \Closure $callback
+  * @return void
+  */
+ public function invoke(QueueInterface $queue, $maxNumberOfMessages, $callback)
+ {
+   $this->poisonPillVersion = $this->poisonPillRead->getLatestVersion();
+   ...
+ }
+```
+
+The method `isLatestVersion` of `PoisonPillCompareInterface` using in the `Magento\Framework\MessageQueue\CallbackInvoker`:
+
+```php
+ /**
+  * Run short running process
+  *
+  * @param QueueInterface $queue
+  * @param int $maxNumberOfMessages
+  * @param \Closure $callback
+  * @return void
+  */
+ public function invoke(QueueInterface $queue, $maxNumberOfMessages, $callback)
+ {
+     $this->poisonPillVersion = $this->poisonPillRead->getLatestVersion();
+     for ($i = $maxNumberOfMessages; $i > 0; $i--) {
+         do {
+             $message = $queue->dequeue();
+             // phpcs:ignore Magento2.Functions.DiscouragedFunction
+            } while ($message === null && (sleep(1) === 0));
+         if (false === $this->poisonPillCompare->isLatestVersion($this->poisonPillVersion)) {
+             $queue->reject($message);
+             // phpcs:ignore Magento2.Security.LanguageConstruct.ExitUsage
+             exit(0);
+         }
+         $callback($message);
+     }
+ }
+```

src/guides/v2.3/extension-dev-guide/message-queues/refresh-config.md

@@ -109,7 +109,7 @@ To extend a Module's styles in your theme:
    │   ├── web/
    │   │   ├── css/
    │   │   │   ├── source/
-               ├──_extend.less
+                  ├──_extend.less
    ...
    ```
 

src/guides/v2.3/frontend-dev-guide/css-guide/css_quick_guide_approach.md

@@ -229,13 +229,13 @@ To set attributes for the HTML `body` tag use the `<attribute>` instruction.
 **Example:** Add a new class to the `body` tag.
 
 ```xml
-<page>
     <body>
         <attribute name="class" value="my-new-body-class"/>
     </body>
-</page>
 ```
 
+![Block Class]({{ site.baseurl }}/common/images/body-class-result.png)
+
 **Example:** Add a custom attribute to the `body` tag.
 
 ```xml

src/guides/v2.3/frontend-dev-guide/layouts/xml-manage.md

@@ -221,32 +221,6 @@ Syntax option | Description
 `@doc(description)` | Describes the purpose of the mutation
 `@deprecated(reason: "description")` | Use `@deprecated` to mark a query, mutation, or attribute as deprecated
 
-{:.bs-callout-tip}
-It is a good practice to define separate types for input and output data. This practice permits additional extension points, so every input and output type can be extended by adding additional fields to the definition.
-
-#### Example
-
-**Wrong approach:**
-
-```text
-type Mutation {
-    mutationQueryName(param1: String, param2: Int, ...): MutationQueryOutput @resolver(class: "Magento\\<module_name>\\Model\\Resolver\\MutationResolverModel") @doc(description:"Mutation query description")
-}
-```
-
-**Correct approach:**
-
-```text
-type Mutation {
-    mutationQueryName(inputParam: InputParamsType): MutationQueryOutput @resolver(class: "Magento\\<module_name>\\Model\\Resolver\\MutationResolverModel") @doc(description:"Mutation query description")
-}
-
-type InputParamsType {
-    param1: String
-    param2: Int
-}
-```
-
 ### Resolver class
 
 Use the following sample code as a template for the GraphQL resolver mutation class: