Merge branch 'master' into update_errors

dobooth · web-flow · commit 7835b0d10f38 · 2021-12-03T08:15:22.000-05:00
diff --git a/src/_data/toc/page-builder.yml b/src/_data/toc/page-builder.yml
@@ -90,8 +90,8 @@ pages:
           url: /page-builder/docs/content-types/create/add-icon.html
           versionless: true
 
-        - label: Workflow tips
-          url: /page-builder/docs/content-types/create/Troubleshooting.html
+        - label: Troubleshooting
+          url: /page-builder/docs/content-types/create/troubleshooting.html
           versionless: true
 
     - label: 'Customize'
diff --git a/src/_data/whats-new.yml b/src/_data/whats-new.yml
@@ -4,9 +4,10 @@ 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 Nov 22 15:39:00 2021
+updated: Mon Nov 29 15:40:15 2021
 entries:
-- description: Added the 'Reindexing in parallel mode` section to the [Manage the indexers](https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-index.html)
+- description: Added the 'Reindexing in parallel mode` section to the [Manage the
+    indexers](https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-index.html)
     topic.
   versions: 2.3.x, 2.4.x
   type: Major Update
diff --git a/src/_includes/cloud/note-env-config-redeploy-warning.md b/src/_includes/cloud/note-env-config-redeploy-warning.md
@@ -0,0 +1,2 @@
+{:.bs-callout-warning}
+Updating the environment configuration triggers a redeployment, which takes your site offline until deployment completes. For Production environments, Adobe recommends completing this work during off-peak hours to avoid service disruptions. See [Working with variables]({{site.baseurl}}/cloud/env/working-with-variables.html).
diff --git a/src/cloud/project/new-relic.md b/src/cloud/project/new-relic.md
@@ -106,8 +106,7 @@ To connect a Cloud environment to New Relic, add the New Relic license key to th
 
 For Starter environments, enable the New Relic integration by adding the New Relic license key to the environment configuration. We recommend adding the key to the Staging and Production (master) environments and one other environment of your choice. Only the New Relic license key is required for configuration. You can find information about additional configuration options in the [New Relic reporting] topic in the _{{site.data.var.ee}} User Guide_.
 
-{:.bs-callout-warning}
-Updating the environment configuration triggers a redeployment, which takes your site offline until deployment completes. For Production environments, we recommend completing this work during off-peak hours to avoid service disruptions. See [Working with variables].
+{% include cloud/note-env-config-redeploy-warning.md%}
 
 **Prerequisites:**
 
@@ -393,4 +392,3 @@ See [Alerts concepts and workflow] in the New Relic documentation for more detai
 [Update the account owner]: https://docs.newrelic.com/docs/accounts/accounts/roles-permissions/change-account-owner
 [Update policies or conditions]: https://docs.newrelic.com/docs/alerts/new-relic-alerts/configuring-alert-policies/update-or-disable-policies-conditions
 [View your license key]: https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/license-key#finding
-[Working with variables]: {{site.baseurl}}/cloud/env/working-with-variables.html
diff --git a/src/cloud/project/project-webint-basic.md b/src/cloud/project/project-webint-basic.md
@@ -13,6 +13,7 @@ functional_areas:
 The {{site.data.var.ece}} [Project Web Interface](https://account.magento.com/customer/account/login/) enables you to do the following for all Starter and Pro environments:
 
 -  [Access projects](#project-access)
+-  [Configure environment settings](#configure-environment-settings)
 -  [Add users and manage access]({{ site.baseurl }}/cloud/project/user-admin.html)
 -  [Manage Git branches]({{ site.baseurl }}/cloud/project/project-webint-branch.html)
 
@@ -56,76 +57,145 @@ You can set the following configuration options for each environment:
    </tr>
    <tr>
       <td>Outgoing emails</td>
-      <td>Setting to <strong>On</strong> means that code in your environment can send and receive e-mails (for example, using PHP <code>mail()</code> function. </td>
+      <td>Setting this option <strong>On</strong> enables support for sending emails from the environment using the SMTP protocol.</td>
    </tr>
    <tr>
       <td>HTTP access control</td>
-      <td>Setting to <strong>On</strong> enables you to configure security for the project's Web Interface using a login and also IP address access control.</td>
+      <td>Setting this option <strong>On</strong> enables you to configure security for the Project Web Interface using a login and also IP address access control.</td>
    </tr>
 </table>
 
 ### Configure emails for testing {#email}
 
-One of these environment variables enables or disables outgoing emails for the environment. If you wanted to test email notifications for the environment, you need to set this option On.
+By default, email support is **disabled** on Staging and Production environments. You must enable email support on an environment to send emails including Welcome, password reset, and two-factor authentication emails for Cloud project users.
 
-1. [Access your project](#project-access) and select a specific environment.
-1. Select the Settings tab.
-1. For the **Outgoing emails** option, select the toggle to On.
+You can manage email support for each Cloud project environment from the Project Web Interface or from the command line.
+
+-  On master and integration branches, use the *Outgoing emails* toggle in the Project Web interface to enable or disable email support.
+
+-  On Production and Staging environments or other environments where the *Outgoing emails toggle* is not available in the Project Web Interface, you can check the current configuration from the Project Web Interface, but you can only change the configuration from the command line using the [Cloud CLI for Commerce]({{ site.baseurl }}/cloud/reference/cli-ref-topic.html) `environment:info` command to set the `enable_smtp` property.
+
+   Enabling SMTP updates the `MAGENTO_CLOUD_SMTP_HOST` environment variable with the IP address of the SMTP host for sending mail.
+
+{% include cloud/note-env-config-redeploy-warning.md%}
+
+{:.procedure}
+To manage email support from the Project Web Interface:
+
+1. [Access your project](#project-access) and select the environment to configure.
+
+1. Select **Configure environment**, and then select the **Variables** tab.
+
+1. To enable or disable outgoing emails, toggle *Outgoing emails* **On** or **Off**.
+
+   ![Set outgoing emails]({{ site.baseurl }}/common/images/cloud/cloud-env-outgoing-emails-config.png){:width="650px"}
+
+After you change the setting, the environment builds and deploys with the new configuration.
+
+{:.procedure}
+To manage email support from the command line:
+
+1. Check the current email configuration in the Project Web Interface.
+
+   ![Check outgoing email configuration]({{ site.baseurl }}/common/images/cloud/cloud-env-outgoing-emails-current-setting.png){:width="650px"}
+
+1. If needed, change the email configuration.
+
+1. From the command line, change to the directory where you [cloned your Cloud project]({{ site.baseurl }}/cloud/before/before-setup-env-2_clone.html#clone-the-project).
+
+1. Log in to the project.
+
+   ```bash
+   magento-cloud login
+   ```
+
+1. If you do not have the project ID and environment ID for the environment, use the following commands to get the values.
+
+   ```bash
+   magento-cloud project:list
+   ```
+
+   ```bash
+   magento-cloud environments -p <project-id>
+   ```
+
+1. Change the email support configuration by setting the `enable_smtp` environment variable to `true` or `false`.
+
+   ```bash
+   magento-cloud environment:info --refresh -p <project-id> -e <environment-id> enable_smtp true
+   ```
+
+   Wait for the environment to build and deploy.
+
+1. Verify that email is working:
+
+   -  Use SSH to connect to your environment.
+
+   -  Check that the `MAGENTO_CLOUD_SMTP_HOST` value is set.
 
-   ![Set outgoing emails]({{ site.baseurl }}/common/images/cloud/cloud_project-conf-env.png)
+      ```bash
+      printenv MAGENTO_CLOUD_SMTP_HOST
+      ```
 
-Configure your email notifications, services, and more as needed through the Admin and test emails.
+   -  Send a test email to your email address or another address you can check.
 
-## Set environment and project variables {#project-conf-env-var}
+      ```bash
+      php -r 'mail("mail@example.com", "test message", "just testing", "From: tester@example.com");'
+      ```
 
-You can set project wide and environment specific variables through the Project Web Interface. Variables can be either text or JSON format. For more information, see [Environment variables]({{ site.baseurl }}/cloud/env/variables-intro.html).
+## Set project and environment variables {#project-conf-env-var}
 
-For an example of variables, we walk you through creating Admin variables through Onboarding and project creation tasks. You may want to add _environment variables_ for sensitive data like payment method information. _Project variables_ are set across all branches and environments.
+You can set project wide and environment specific variables through the Project Web Interface. Variables can be either text or JSON format. _Project variables_ are set across all branches and environments. Use _environment variables_ for sensitive data like payment method information. For more information, see [Environment variables]({{ site.baseurl }}/cloud/env/variables-intro.html).
 
 To view or edit environment variables, you must have at minimum the project reader role with [environment admin]({{ site.baseurl }}/cloud/project/user-admin.html) privileges.
 
 {% include cloud/wings-variables.md %}
 
-### Environment variable {#env}
+### Project variables {#project}
 
-To set environment specific variables in the Project Web Interface:
+To set project variables in the Project Web Interface:
+
+1. [Access your project](#project-access).
+1. Select the Settings icon, and then select the **Variables** tab.
+
+   ![Configure project variables]({{ site.baseurl }}/common/images/cloud/cloud-config-project-variables.png){:width="650px"}
 
-1. [Access your project](#project-access) and select a specific environment.
-1. Select the Variables tab.
 1. Click **Add Variable**.
-1. In the **Name** field, enter a variable name. For example, to set the Admin default account password, enter `ADMIN_PASSWORD`.
+1. In the **Name** field, enter a variable name. For example, to set the Admin email for the default account, enter `ADMIN_EMAIL`.
 1. In the **Value** field, enter the value for the variable. For example, enter a valid email address accessible for reset email notifications.
 
-   ![Set environment variables]({{ site.baseurl }}/common/images/cloud/cloud_env-var.png)
+   ![Set project variables]({{ site.baseurl }}/common/images/cloud/cloud_project_variable.png)
 
-1. As needed, select options for **JSON value**, **Enabled**, **Inheritable by child environments** and **Sensitive**. If you do not have Super User access, you may only see the JSON value option.
+1. As needed, select options for **JSON value**, **Visible during build**, and **Visible during runtime**. If you do not have Super User access, you may only see the JSON value option.
 1. Click **Add Variable**. After you add the variable, the environment will deploy. Wait until deployment completes before more edits.
 
-{:.bs-callout-warning}
-If you are attempting to [override configuration settings]({{ site.baseurl }}
-), you must prepend `env:` to the variable name. For example:
-![Environment variable example]({{ site.baseurl }}/common/images/cloud/cloud_env_var_example.png)
+### Environment variables {#env}
 
-### Project variable {#project}
-
-To set project variables in the Project Web Interface:
+To set environment specific variables in the Project Web Interface:
 
 1. [Access your project](#project-access) and select a specific environment.
-1. Select the Variables tab.
+1. Select **Configure environment**.
+1. Select the **Variables** tab.
 1. Click **Add Variable**.
-1. In the **Name** field, enter a variable name. For example, to set the Admin email for the default account, enter `ADMIN_EMAIL`.
+1. In the **Name** field, enter a variable name. For example, to set the Admin default account password, enter `ADMIN_PASSWORD`.
 1. In the **Value** field, enter the value for the variable. For example, enter a valid email address accessible for reset email notifications.
 
-   ![Set project variables]({{ site.baseurl }}/common/images/cloud/cloud_project_variable.png)
+   ![Set environment variables]({{ site.baseurl }}/common/images/cloud/cloud_env-var.png){:width="650px"}
 
-1. As needed, select options for **JSON value**, **Visible during build**, and **Visible during runtime**. If you do not have Super User access, you may only see the JSON value option.
+1. As needed, select options for **JSON value**, **Enabled**, **Inheritable by child environments** and **Sensitive**. If you do not have Super User access, you may only see the JSON value option.
 1. Click **Add Variable**. After you add the variable, the environment will deploy. Wait until deployment completes before more edits.
 
+{:.bs-callout-warning}
+If you are attempting to [override configuration settings]({{ site.baseurl }}
+), you must prepend `env:` to the variable name. For example:
+![Environment variable example]({{ site.baseurl }}/common/images/cloud/cloud_env_var_example.png)
+
 ## Configure routes {#project-conf-env-route}
 
 Routes allow you to set redirects or upstream settings for applications for your specific environment. For full details on routes, see [routes.yaml]({{ site.baseurl }}/cloud/project/routes.html). These routes (or URLs) are used to access your storefront.
 
 1. [Access your project](#project-access) and select a specific environment.
+1. Select **Configure environment**.
 1. Select the Routes tab.
 1. Select **Add Route**.
 1. Enter a URL. You can use `{default}` in the URL, which is a placeholder for the default domain.
@@ -141,7 +211,7 @@ Routes allow you to set redirects or upstream settings for applications for your
 1. To configure a Redirect, enter a URL to **Redirect to**. You can use `{default}` in the URL, which is a placeholder for the default domain.
 1. Click **Add Route** to save. The setting is saved and deployed to the environment.
 
-   ![Configure a route]({{ site.baseurl }}/common/images/cloud/cloud_routes.png)
+   ![Configure a route]({{ site.baseurl }}/common/images/cloud/cloud_routes.png){:width="650px"}
 
 ## View environment history {#project-conf-hist}
 
@@ -152,19 +222,19 @@ An environment's history includes:
 -  Syncs and merges
 -  Code pushes
 
-To view the history for an environment, log in to your project and select the environment. The page displays a general history of actions completed on the page. For a detailed list of completed actions during build and deployment, we recommend reviewing logs directly on the servers. See [View logs]({{ site.baseurl }}/cloud/project/log-locations.html).
+To view the history for an environment, log in to your project and select the environment. The page displays a general history of actions completed on the page. For a detailed list of completed actions during build and deployment, Adobe recommends reviewing logs directly on the servers. See [View logs]({{ site.baseurl }}/cloud/project/log-locations.html).
 
 The following figure shows a sample history.
 
-![Sample environment history]({{ site.baseurl }}/common/images/cloud/cloud_environment-history.png)
+![Sample environment history]({{ site.baseurl }}/common/images/cloud/cloud_environment-history.png){:width="800px"}
 
 The history shows, from oldest to newest:
 
 -  Environment branched from `FeatureX`
 -  Environment synced with the parent
 -  Environment snapshot created
 
-We recommend [creating a snapshot]({{ site.baseurl }}/cloud/project/project-webint-snap.html) before you make any code changes.
+Adobe recommends [creating a snapshot]({{ site.baseurl }}/cloud/project/project-webint-snap.html) before you make any code changes.
 
 -  Environment variable added
 -  Environment snapshot created
diff --git a/src/common/images/cloud/cloud-config-project-variables.png b/src/common/images/cloud/cloud-config-project-variables.png
diff --git a/src/common/images/cloud/cloud-env-outgoing-emails-config.png b/src/common/images/cloud/cloud-env-outgoing-emails-config.png
diff --git a/src/common/images/cloud/cloud-env-outgoing-emails-current-setting.png b/src/common/images/cloud/cloud-env-outgoing-emails-current-setting.png
diff --git a/src/guides/v2.3/get-started/bk-get-started-api.md b/src/guides/v2.3/get-started/bk-get-started-api.md
@@ -14,7 +14,7 @@ functional_areas:
 
 The Magento web [API](https://glossary.magento.com/api) framework provides integrators and developers the means to use web services that communicate with the Magento system. Key features include:
 
-*  Support for both [REST]({{ page.baseurl }}/rest/bk-rest.html) (Representational State Transfer) and [SOAP]({{ page.baseurl }}/soap/bk-soap.html) (Simple Object Access Protocol). In Magento 2, the [web API](https://glossary.magento.com/web-api) coverage is the same for both REST and SOAP.
+*  Support for [GraphQL]({{page.baseurl}}/graphql/index.html), [REST]({{ page.baseurl }}/rest/bk-rest.html) (Representational State Transfer) and [SOAP]({{ page.baseurl }}/soap/bk-soap.html) (Simple Object Access Protocol). In Magento 2, the [web API](https://glossary.magento.com/web-api) coverage is the same for both REST and SOAP.
 
 *  Three types of [authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication.html):
    *  Third-party applications authenticate with [OAuth 1.0a]({{ page.baseurl }}/get-started/authentication/gs-authentication-oauth.html).
diff --git a/src/guides/v2.4/extension-dev-guide/routing.md b/src/guides/v2.4/extension-dev-guide/routing.md
@@ -71,7 +71,7 @@ define the `match()` function in this class to use your own route matching logic
 
 If you need route configuration data, use the Route [`Config`] class.
 
-To add your custom router to the list of routers for the `FrontController`, add the following entry in your module's `di.xml` file:
+To add your custom router to the list of routers for the `FrontController`, add the following entry in your module's `frontend/di.xml` file:
 
 ```xml
 <type name="Magento\Framework\App\RouterList">

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+{:.bs-callout-warning}`
	`2`	`+Updating the environment configuration triggers a redeployment, which takes your site offline until deployment completes. For Production environments, Adobe recommends completing this work during off-peak hours to avoid service disruptions. See [Working with variables]({{site.baseurl}}/cloud/env/working-with-variables.html).`