Merge branch 'develop' of github.com:magento/devdocs_internal into ds…

…_MAGEDOC-2854_MFTF-2.2.0 # Conflicts: # package-lock.json
magento · Apr 26, 2018 · 073a9ee · 073a9ee
2 parents 99f02fd + 205d52c
commit 073a9ee
Show file tree

Hide file tree

Showing 28 changed files with 3,963 additions and 3,511 deletions.
diff --git a/README.md b/README.md
@@ -79,8 +79,31 @@ Once you have completed preparing your environment, you can build locally and re
 > Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output immediately. Changing the `_config.yml` file requires a fresh build. Using the `--incremental` option limits re-builds to posts and pages that have changed.
 
 ## Build using Docker
+This repository comes with the necessary configuration files for building a local copy of the Magento DevDocs with [Docker](https://docs.docker.com/), using [Docker Compose](https://docs.docker.com/compose/overview/).
 
-[This Docker container](https://github.com/magento-devdocs/docker-for-devdocs) contains everything necessary to run Jekyll3 for working with Magento DevDocs.
+To use Docker and Docker Compose, first download and install Docker for the appropriate operating system, and then install Docker Compose to execute the `docker-compose.yml` configuration file.
+
+### Docker for Mac
+- Refer [here](https://docs.docker.com/docker-for-mac/install/) for the official installation instructions.
+
+### Docker for Windows
+- Refer [here](https://docs.docker.com/docker-for-windows/install/) for the official installation instructions.
+
+### Docker Compose
+- Refer [here](https://docs.docker.com/compose/install/) for the official installation instructions.
+
+### Execution Steps
+1. Using [git](https://git-scm.com/), [clone](https://help.github.com/articles/cloning-a-repository/) this repository.
+2. Navigate to the resulting directory.
+3. Run `docker-compose up` to initialize the build process. Refer [here](https://docs.docker.com/compose/gettingstarted/#step-build-and-run-your-app-with-compose) for more details on the use of `docker-compose`.
+4. Visit `http://localhost:4000/` in a web browser, and you should be presented with a local copy of the Magento DevDocs. The configuration for the local port (`4000` by default) is found in the [docker-compose.yml](https://github.com/magento/devdocs/blob/develop/docker-compose.yml) file. If another port is desired, please refer [here](https://docs.docker.com/compose/compose-file/compose-file-v2/#ports) for further details regarding Docker Compose port mapping.
+
+### Addressing Problems With Docker Build
+1. Verify that the Docker engine is installed for the appropriate operating system.
+2. Verify that Docker Compose is installed.
+3. Verify that this repository has been cloned.
+4. Verify that the correct Docker Compose command(s) have been used in the same directory as the `docker-compose.yml` file.
+5. If there are still problems, please open an [Issue](https://help.github.com/articles/creating-an-issue/) on this repository.
 
 ## Build using Vagrant
 

diff --git a/_data/toc/cloud-guide.yml b/_data/toc/cloud-guide.yml
@@ -168,6 +168,10 @@ pages:
               url: /cloud/env/log-handlers.html
               versions: ["2.1","2.2","2.3"]
 
+            - label: Smart wizards
+              url: /cloud/env/smart-wizards.html
+              versions: ["2.1","2.2","2.3"]
+
         - label: Environment variables
           url: /cloud/env/variables-intro.html
           children:

diff --git a/_data/toc/payments-integrations.yml b/_data/toc/payments-integrations.yml
@@ -28,6 +28,10 @@ pages:
         - label: Response Handler
           url: /payments-integrations/payment-gateway/response-handler.html
 
+        - label: Error Code Mapping
+          versions: ["2.2", "2.3"]
+          url: /payments-integrations/payment-gateway/error-code-mapper.html
+
     - label: Adding a new payment integration (payment method)
       versions: ["2.1","2.2", "2.3"]
       url: /payments-integrations/base-integration/integration-intro.html

diff --git a/common/js/app.min.js b/common/js/app.min.js
diff --git a/css/app.css b/css/app.css
diff --git a/guides/v2.1/cloud/composer-packages/ece-tools.md b/guides/v2.1/cloud/composer-packages/ece-tools.md
@@ -12,9 +12,25 @@ functional_areas:
 
 {% include cloud/ece-tools.md %}
 
+## v2002.0.11
+
+#### New features
+
+- **Configuring read-only connections to non-master nodes**—This release adds the ability to configure a read-only connection to a non-master node to receive read-only traffic (for <!--MAGECLOUD-143 -->[Redis]({{page.baseurl}}/cloud/env/variables-deploy.html#redisuseslaveconnection) and for <!--MAGECLOUD-143 --> [MariaDB]({{page.baseurl}}/cloud/env/variables-deploy.html#mysqluseslaveconnection)).
+-  <!--MAGECLOUD-1910 -->**Configuration Wizard**—Added a new wizard to help verify your configuration for static content deployment. See [Smart wizards]({{page.baseurl}}/cloud/env/smart-wizards.html).
+-  <!-- MAGECLOUD-1966-->**Symfony Console support**—Added support for Symfony Console 4 with Magento 2.3.
+-  <!-- MAGECLOUD-1607 -->**Cron scheduling optimizations**—Improved the queue management and enhanced logging to help with debugging cron-related issues.
+
+#### Fixed issues
+
+-  <!-- MAGECLOUD-1221 -->Deployment validation fails if an `ADMIN_EMAIL` or `ADMIN_USERNAME` value is the same as an existing Magento administrator account.
+-  <!-- MAGECLOUD-1489 -->The first installation of the Staging & Production environments of a PRO project now includes different index prefixes for ElasticSearch to prevent possible conflicts while identifying records belonging to each environment.
+-  <!-- MAGECLOUD-1819 -->You can now use the `VERBOSE_COMMANDS` environment variable during both _build_ and _deploy_ phases.
+-  <!-- MAGECLOUD-2021 -->Fixed an issue that interrupted the build phase for legacy architecture when using static content deployment.
+
 ## v2002.0.10
 
-### New features
+#### New features
 
 -  <!-- MAGECLOUD-1285 -->**Static Content Deployment (SCD)**—There is a new, alternative deployment process to generate static content when requested (on-demand). This decreases downtime and improves cache handling by generating the most critical assets.
     -  <!-- MAGECLOUD-1738 -->**New environment variable**—Added the new `SCD_ON_DEMAND` global environment variable to generate static content when requested.
@@ -30,7 +46,7 @@ functional_areas:
     -  <!-- MAGECLOUD-1738 -->`SCD_ON_DEMAND`—_Global_ environment variable to generate static content when requested.
     -   `WARM_UP_PAGES`—You can list the pages to use to pre-load the cache. Available in the new [Post-deploy variables](http://devdocs.magento.com/guides/v2.1/cloud/env/variables-post-deploy.html).
 
-### Fixed issues
+#### Fixed issues
 
 -  <!-- MAGECLOUD-982 -->We fixed an issue that involved a locally applied patch breaking the deployment on an instance. Now, ECE-Tools can detect that a patch has been applied.
 
@@ -46,7 +62,7 @@ functional_areas:
 You must [upgrade the {{site.data.var.ece}} metapackage](http://devdocs.magento.com/guides/v2.1/cloud/project/project-upgrade-parent.html) to get this and all future updates.
 </div>
 
-### New features
+#### New features
 -   <!-- MAGECLOUD-1086 -->**ece-tools**—The `ece-tools` package now supports Magento 2.1.x. You must [upgrade to ece-tools](http://devdocs.magento.com/guides/v2.1/cloud/project/project-patch.html#upgrade-to-ece-tools) to use these features.
 
 -   <!-- MAGECLOUD-1552 -->**Redis configuration**—You can now [configure Redis](http://devdocs.magento.com/guides/v2.1/cloud/env/working-with-variables.html#redis) page and default cache and Redis session storage using an environment variable.
@@ -61,7 +77,7 @@ You must [upgrade the {{site.data.var.ece}} metapackage](http://devdocs.magento.
 
 -   <!-- MAGECLOUD-1674 -->**Logging**—We simplified logging around built-in patching operations.
 
-### Fixed issues
+#### Fixed issues
 -   <!-- MAGECLOUD-1615 -->We removed `developer` mode support and the `APPLICATION_MODE` environment variable because they were causing unexpected behavior.
 
 -   <!-- MAGECLOUD-1630 -->We fixed an issue that was causing static content deployment failures related to Redis. Now, multi-threaded static content deployment runs as designed.
@@ -75,7 +91,7 @@ You must [upgrade the {{site.data.var.ece}} metapackage](http://devdocs.magento.
 We merged `vendor/magento/ece-patches` with `vendor/magento/ece-tools` in this release. You no longer need to update the `vendor/magento/ece-patches` package separately.
 </div>
 
-### New features
+#### New features
 -   <!-- MAGECLOUD-1253 -MAGECLOUD-1495-->**Improved logging**
     -   We improved log messaging to provide better explanations when the build or deploy process overrides an environment variable.
     -   You can now view installation and upgrade progress in real time. Tail the `install_update.log` file to view progress. For example,
@@ -94,8 +110,7 @@ We merged `vendor/magento/ece-patches` with `vendor/magento/ece-tools` in this r
 
 -   <!--MAGECLOUD-1090-->We implemented smart patching. Now the package applies patches based not on {{site.data.var.ece}} version, but on patched package version.
 
-
-### Fixed issues
+#### Fixed issues
 -   <!-- MAGECLOUD-1162 -->We fixed a logging issue that was causing build errors.
 
 -   <!-- MAGECLOUD-1389 -->We fixed an issue that was causing timeout exceptions when running deployments in interactive mode.
@@ -116,23 +131,22 @@ We merged `vendor/magento/ece-patches` with `vendor/magento/ece-tools` in this r
 
 -   <!--MAGECLOUD-1033-->Removed patch; fixing bug in `colinmollenhour/credis` v1.6 to enable support for {{site.data.var.ece}} 2.2.1. Not available in 2.1.
 
-
 ## v2002.0.7
 
-### Fixed issues
+#### Fixed issues
 -   <!-- MAGECLOUD-1454-->We removed `var/view_preprocessed` symlinking to fix an issue that was causing JavaScript minification conflicts.
 
 ## v2002.0.6
 
-### Fixed issues
+#### Fixed issues
 -   <!-- MAGECLOUD-1413 -->We fixed an issue that was causing `gzip` errors when a file or directory name contains spaces.
 
 -   <!-- MAGECLOUD-1424 -->We fixed an issue that was preventing deployment scripts from properly recognizing and enabling module dependencies.
 
 
 ## v2002.0.5
 
-### New features
+#### New features
 -   **Configure a cron consumer with an environment variable**—You can now configure cron consumers using the new `CRON_CONSUMERS_RUNNER` environment variable.
 
 -   **Configuration scanning**—We now scan for critical components during the build/deploy process and halt the process if the scan fails, which prevents unnecessary downtime due to the site being in maintenance mode.
@@ -151,7 +165,7 @@ We merged `vendor/magento/ece-patches` with `vendor/magento/ece-tools` in this r
 
 -   **Cron interval limitations lifted**—The default cron interval for all environments provisioned in the us-3, eu-3, and ap-3 regions is 1 minute. The default cron interval in all other regions is 5 minutes for Pro Integration environments and 1 minute for Pro Staging and Production environments. To modify your existing cron jobs, edit your settings in `.magento.app.yaml` or create a support ticket for Production/Staging environments. Refer to [Set up cron jobs](http://devdocs.magento.com/guides/v2.1/cloud/configure/setup-cron-jobs.html) for more information.
 
-### Fixed issues
+#### Fixed issues
 -   <!-- MAGECLOUD-1327 -->We fixed an issue that was causing long deploy times due to the deploy process invoking the `cache-clean` operation before static content deployment.
 
 -   <!-- MAGECLOUD-1322 -->We fixed an issue causing errors during the static content generation step of deployment on Production environments.
@@ -170,27 +184,27 @@ We merged `vendor/magento/ece-patches` with `vendor/magento/ece-tools` in this r
 
 ## v2002.0.4
 
-### Fixed issues
+#### Fixed issues
 -   <!-- MAGECLOUD-1355 -->You can now [manually reset stuck Magento cron jobs](http://devdocs.magento.com/guides/v2.2/cloud/configure/setup-cron-jobs.html#reset-cron-jobs) using a CLI command in all environments via SSH access. The deployment process automatically resets cron jobs. Not available in 2.1.
 
 ## v2002.0.3
 
-### Fixed issues
+#### Fixed issues
 -   <!--MAGECLOUD-1311-->We fixed an issue that was causing pages to time out because Redis was taking too long to read/write. You can now use the `disable_locking` parameter in Redis configurations to prevent this issue.
 
 ## v2002.0.2
 
-### Fixed issues
+#### Fixed issues
 -   <!--MAGECLOUD-1246-->The RabbitMQ configuration process now obtains all required parameters automatically.
 
 ## v2002.0.1
 
-### New features
+#### New features
 -   <!--- MAGECLOUD-1057 -->{{site.data.var.ece}} now supports scopes and [static content deployment strategies](http://devdocs.magento.com/guides/v2.2/config-guide/cli/config-cli-subcommands-static-deploy-strategies.html). We have added the `–s` parameter with a default setting of `quick` for the static content deployment strategy. You can use the environment variable [SCD_STRATEGY](http://devdocs.magento.com/guides/v2.2/cloud/env/environment-vars_magento.html) to customize and use these strategies with your build and deploy actions. This variable supports the options `standard`, `quick`, or `compact`. If you select `compact`, we override the `STATIC_CONTENT_THREADS` value with `1`, which can slow deployment, especially in production environments. Not available in 2.1.
 
 -   <!--- MAGECLOUD-1014 & MAGECLOUD-1023 -->We have created a new log file on environments to capture and compile build and deploy actions. The file is located in the `var/log/cloud.log` file inside the Magento root application directory.
 
-### Fixed issues
+#### Fixed issues
 -   <!-- MAGECLOUD-919 & MAGECLOUD-1030-->Refactored the `ece-tools` package to make it compatible with {{site.data.var.ece}} 2.2.0 and higher.
 
 -   <!-- MAGECLOUD-1186-->We fixed an issue that was preventing `ece-tools` from halting execution and throwing an exception if no patches can be applied.

diff --git a/guides/v2.1/cloud/env/log-handlers.md b/guides/v2.1/cloud/env/log-handlers.md
@@ -10,7 +10,7 @@ functional_areas:
   - Configuration
 ---
 
-You can configure logging handlers to send messages to a remote logging server. Logging handler push build and deploy logs to othere systems, similarly to the way you can push logs to Slack and email. Simply enable a _syslog_ handler, which is ideal for logging messages related to hardware, or a Graylog Extended Log Format (GELF) handler, which is ideal for logging messages from software applications.
+You can configure logging handlers to send messages to a remote logging server. Logging handler pushes build and deploy logs to other systems, similarly to the way you can push logs to Slack and email. Simply enable a _syslog_ handler, which is ideal for logging messages related to hardware, or a Graylog Extended Log Format (GELF) handler, which is ideal for logging messages from software applications.
 
 The following example configures both of these handlers by adding the configuration to the `.magento.env.yaml` file. For the minimum logging level (`min_level`), see [Set up notifications—Log levels]({{page.baseurl}}/cloud/env/setup-notifications.html#log-levels).
 

diff --git a/guides/v2.1/cloud/env/smart-wizards.md b/guides/v2.1/cloud/env/smart-wizards.md
@@ -0,0 +1,43 @@
+---
+layout: default
+group: cloud
+title: Smart wizards
+version: 2.1
+github_link: cloud/env/smart-wizards.md
+functional_areas:
+  - Cloud
+  - Setup
+  - Configuration
+---
+
+The smart wizards can assist you in determining if your Cloud configuration follows best practices by verifying the following:
+
+-  Enabled SCD on-demand
+-  Enabled SCD for the build stage
+-  Enabled SCD for the deploy stage
+<!-- -  Enabled the master-slave connections for database and Redis service configuration -->
+
+Each of the smart wizard commands provides a verification response and, if applicable, a recommendation for the proper configuration.
+
+Command | Description
+------- | -----------
+`wizard:scd-on-demand` | Check if the `SCD_ON_DEMAND` global environment variable is set to `true`.
+`wizard:scd-on-build ` | Check if the `SCD_ON_DEMAND` global environment variable is set to `false` and the `SKIP_SCD` environment variable is set to `false` for the build stage. Verifies the `config.php` file contains information for stores, store groups, and websites.
+`wizard:scd-on-deploy` | Check if the `SCD_ON_DEMAND` global environment variable is set to `false` and the `SKIP_SCD` environment variable is set to `false` for the deploy stage. Verifies the `config.php` file does _NOT_ contain the list of stores, store groups, and websites with related information.
+
+For example, to verify your configuration properly enables the SCD on-demand feature:
+
+```bash
+./vendor/bin/ece-tools wizard:scd-on-demand
+```
+
+A successful configuration returns:
+```
+SCD on demand is enabled
+```
+
+A failed configuration returns:
+
+```
+SCD on demand is disabled
+```
diff --git a/guides/v2.1/cloud/env/variables-build.md b/guides/v2.1/cloud/env/variables-build.md
@@ -9,13 +9,20 @@ functional_areas:
   - Configuration
 ---
 
-The following _build_ variables control actions in the build phase and can inherit and override values from the [Global stage]({{page.baseurl}}/cloud/env/variables-intro.html#global-variables). See [Manage build and deploy actions](http://devdocs.magento.com/guides/v2.1/cloud/project/magento-env-yaml.html) for more information about using these options in the `.magento.env.yaml` file.
+The following _build_ variables control actions in the build phase and can inherit and override values from the [Global stage]({{page.baseurl}}/cloud/env/variables-intro.html#global-variables). Insert these variables in the `build` stage of the `.magento.env.yaml` file:
 
-For information on the build and deploy process, see [Deployment process]({{page.baseurl}}/cloud/reference/discover-deploy.html).
+```yaml
+stage:
+  build:
+    BUILD_VARIABLE_NAME: value
+```
+
+For more information about customizing the build and deploy process:
 
-<div class="bs-callout bs-callout-info" markdown="1">
-You can still use the `build_options.ini` file, but we recommend using the `.magento.env.yaml` file instead because it centralizes the management of build and deploy actions across all of your environments—including Pro Staging and Production—without requiring a support ticket.
-</div>
+-  [Manage build and deploy actions](http://devdocs.magento.com/guides/v2.1/cloud/project/magento-env-yaml.html)
+-  [Deployment process]({{page.baseurl}}/cloud/reference/discover-deploy.html)
+
+{% include note.html type="info" content="You can still use the `build_options.ini` file, but we recommend using the `.magento.env.yaml` file instead because it centralizes the management of build and deploy actions across all of your environments—including Pro Staging and Production—without requiring a support ticket." %}
 
 ### `EXCLUDE_THEMES`
 
@@ -26,8 +33,10 @@ When enabled, this option does not generate static content for the specified the
 
 For example, the Luma theme is included with all {{site.data.var.ece}} projects. You may not need to constantly generate static content for this theme, which adds time to your build. To exclude the theme, use the following:
 
-```
-exclude_themes=magento/luma,magento/my-theme
+```yaml
+stage:
+  build:
+    exclude_themes=magento/luma,magento/my-theme
 ```
 
 ### `SCD_COMPRESSION_LEVEL`
@@ -73,3 +82,9 @@ If you are already deploying static content during the build phase with [Configu
 
 We do not recommend using this option, because running static content deployment during the deployment phase can greatly increase deployment times and downtime for your live site.
 
+### `VERBOSE_COMMANDS`
+
+-  **Default**—`disabled`
+-  **Version**—Magento 2.1.4 and later
+
+ Enables or disables the [Symfony](https://symfony.com/doc/current/console/verbosity.html){:target="\_blank"} debug verbosity level for your logs. Be aware, if you enable this verbosity, the logs will be deeply detailed.