+```
{: .bs-callout .bs-callout-warning}
-Every time you add or modify a variable using the web interface or the CLI, the branch will redeploy automatically.
-
-### Add variables using the CLI {#cli}
-
-To set variables using the CLI (with example values used):
-
-1. To set the administrator's username to `admin_A456` in the `master` environment, enter:
-
- magento-cloud variable:set ADMIN_USERNAME admin_A456 -e master
-2. Wait for the project to redeploy.
-3. To set the administrator's password to `admin_A456`, enter:
-
- magento-cloud variable:set ADMIN_PASSWORD admin_A456 -e master
-4. Wait for the project to redeploy.
-5. To set the {% glossarytooltip 29ddb393-ca22-4df9-a8d4-0024d75739b1 %}Admin{% endglossarytooltip %} URI to `magento_A8v10`, enter:
-
- magento-cloud variable:set ADMIN_URL magento_A8v10 -e master
-6. Wait for the project to redeploy.
-7. Log in to the Magento Admin using the values you just changed.
+Every time you add or modify a variable using the web interface or the CLI, the branch automatically redeploys.
- The simplest way to do that is to use the environment routes that display when you redeploy the `master` branch. The following example uses these values:
+#### To add variables using the Project Web Interface:
+Alternatively, you can add or update variables in the Project Web Interface.
- Building application 'mymagento' (runtime type: php:7.0, tree: 07263ba)
- Slug already built for this tree id, skipping.
+1. Log in to [your {{site.data.var.ece}} account](https://accounts.magento.cloud).
- Re-deploying environment k4wtvm7ogzr5s-master.
- Environment configuration:
-
- mymagento (type: php:7.0, size: S, disk: 2048)
- mysql (type: mysql:10.0, size: S, disk: 2048)
- redis (type: redis:3.0, size: S)
- solr (type: solr:4.10, size: S, disk: 1024)
-
- Environment routes:
- http://master-k4wtvm7ogzr5s.us.magentosite.cloud/ is served by application `mymagento`
-
- In the preceding example, go to `http://master-k4wtvm7ogzr5s.us.magentosite.cloud/magento_A8v10` and log in using the username `admin_A456` and password `admin_A456`
-
-8. After the project redeploys, take a snapshot of the master branch:
-
- magento-cloud snapshot:create -e master
-
-### Add variables using the Project Web Interface {#web}
-
-To set variables using the Project Web Interface:
-
-1. Log in to [your {{site.data.var.ece}} account](https://accounts.magento.cloud).
-2. Click the Configure environment gear icon  next to the Project name. If you are asked to create the project, click **Continue Later**.
+1. Click the **Configure environment** gear icon  next to the Project name.
-4. Select the **Variables** tab.
-5. Click **Add Variable**.
-6. For the **Name**, enter `ADMIN_EMAIL`. For the **Value**, enter your Project Owner email address or another accessible email for resetting the password for the default admin account.
+1. Select the **Variables** tab.
- 
+1. Click **Add Variable**.
-7. Click **Add variable**. After you add the variable, the environment will deploy. Wait until deployment completes.
+1. Enter the **Name** and **Value** for the variable. For example, enter `ADMIN_EMAIL` and your Project Owner email address or another accessible email for resetting the password for the default admin account.
-Repeat to optionally add the following variables using the examples above:
+ 
-* Name: `ADMIN_USERNAME`, Value: admin_A456
-* Name: `ADMIN_PASSWORD`, Value: admin_A456
-* Name: `ADMIN_URL`, Value: magento_A8v10
+1. Click **Add variable**. After you add the variable, wait until deployment completes.
-## Branch an environment {#branch}
+## Create a branch for development {#branch}
-With your project cloned and Magento administrator account configured, you can branch for development.
+After cloning your project and updating the Magento administrator account configuration, you can branch for development. As stated earlier, you must create an environment using the `magento-cloud environment:branch ` command or the Project Web Interface for the environment to become _active_.
-* For [Starter]({{ page.baseurl }}/cloud/basic-information/starter-develop-deploy-workflow.html#clone-branch), consider creating a branch for `staging`, than branch from `staging` for development.
-* For [Pro]({{ page.baseurl }}/cloud/architecture/pro-develop-deploy-workflow.html), create branches in the Integration environment for your development.
+- For [Starter]({{ page.baseurl }}/cloud/basic-information/starter-develop-deploy-workflow.html#clone-branch), consider creating a branch for `staging`, then create a development branch based on the `staging` branch.
+* For [Pro]({{ page.baseurl }}/cloud/architecture/pro-develop-deploy-workflow.html), create development branches based on the Integration environment.
-To branch from master:
+#### To branch from master:
-1. Do any of the following:
+1. Do one of the following from the CLI.
- * To create a new environment, enter the following command:
+ - To create a new environment:
- magento-cloud environment:branch
- * To check out an existing environment, enter the following command:
+ ```bash
+ magento-cloud branch
+ ```
- magento-cloud environment:checkout
+ - To check out an existing environment:
- For example, to create a new branch named `sprint1` from master, enter:
+ ```bash
+ magento-cloud checkout
+ ```
- magento-cloud environment:branch sprint1 master
+1. Update dependencies.
-2. After the command completes, update dependencies:
+ ```bash
+ composer --no-ansi --no-interaction install --no-progress --prefer-dist --optimize-autoloader
+ ```
- composer --no-ansi --no-interaction install --no-progress --prefer-dist --optimize-autoloader
-3. Create a [snapshot]({{ page.baseurl }}/cloud/project/project-webint-snap.html) of the environment.
+1. Create a [snapshot]({{ page.baseurl }}/cloud/project/project-webint-snap.html) of the environment.
- magento-cloud snapshot:create -e
+ ```bash
+ magento-cloud snapshot:create -e
+ ```
#### Next step:
[Install Magento]({{ page.baseurl }}/cloud/before/before-setup-env-install.html)
diff --git a/guides/v2.1/cloud/before/before-workspace-cloud-account.md b/guides/v2.1/cloud/before/before-workspace-cloud-account.md
index 19f783c6ad5..82d8a02ef80 100644
--- a/guides/v2.1/cloud/before/before-workspace-cloud-account.md
+++ b/guides/v2.1/cloud/before/before-workspace-cloud-account.md
@@ -12,7 +12,7 @@ menu_node:
To begin working with a project and develop your store, you should have received an e-mail invitation to [create a Mangento Enterprise Cloud Edition account](https://accounts.magento.cloud). The account provides access to your project for Magento development and deployment across all supported environments.
-You should receive an e-mail invitation to verify and access the account. If you don't see the invitation, check your junk e-mail folder. Click the **Verify my account** option in the email to verify and access your account.
+You should receive an e-mail invitation to verify and access the account. If you do not see the invitation, check your junk e-mail folder. Click the **Verify my account** option in the email to verify and access your account.
When logged in, you should see a project named and ready to access.
diff --git a/guides/v2.1/cloud/before/before-workspace-file-sys-owner.md b/guides/v2.1/cloud/before/before-workspace-file-sys-owner.md
index ba799ec6a68..6e771fa9a13 100644
--- a/guides/v2.1/cloud/before/before-workspace-file-sys-owner.md
+++ b/guides/v2.1/cloud/before/before-workspace-file-sys-owner.md
@@ -33,7 +33,7 @@ To give the user a password, enter the following command as a user with `root` p
Follow the prompts on your screen to create a password for the user.
{: .bs-callout .bs-callout-warning}
-If you do not have `root` privileges on your Magento server, you can use another local user account. Make sure the user has a strong password and continue with [Put the Magento file system owner in the web server group](#install-update-depend-user-add2group).
+If you do not have `root` privileges on your Magento server, you can use another local user account. Confirm that the user has a strong password and continue with [Put the Magento file system owner in the web server group](#install-update-depend-user-add2group).
For example, to create a user named `magento_user` and give the user a password, enter:
@@ -41,7 +41,7 @@ For example, to create a user named `magento_user` and give the user a password,
sudo passwd magento_user
{: .bs-callout .bs-callout-warning}
-Because the point of creating this user is to provide added security, make sure you create a strong password.
+Because the point of creating this user is to provide added security, it is essential that you create a strong password.
## Find the web server user's group {#install-update-depend-user-findgroup}
diff --git a/guides/v2.1/cloud/before/before-workspace-magento-prereqs.md b/guides/v2.1/cloud/before/before-workspace-magento-prereqs.md
index d49d8b255a0..5ac41890bbd 100644
--- a/guides/v2.1/cloud/before/before-workspace-magento-prereqs.md
+++ b/guides/v2.1/cloud/before/before-workspace-magento-prereqs.md
@@ -77,7 +77,7 @@ When you're working with the Magento Cloud CLI, local environment settings come
To set `memory_limit`:
-Before working with your {{site.data.var.ece}} project, make sure you set the PHP `memory_limit` to at least `1G` for normal use or at least `2G` for debugging.
+Before working with your {{site.data.var.ece}} project, set the PHP `memory_limit` to at least `1G` for normal use or at least `2G` for debugging.
1. Find your `php.ini` file using the following command:
diff --git a/guides/v2.1/cloud/before/before-workspace.md b/guides/v2.1/cloud/before/before-workspace.md
index a184001889d..436d63eaba3 100644
--- a/guides/v2.1/cloud/before/before-workspace.md
+++ b/guides/v2.1/cloud/before/before-workspace.md
@@ -19,13 +19,13 @@ functional_areas:
To develop, deploy, and test {{site.data.var.ece}}, you need to setup your local environment and clone your project's master Git branch. This local environment provides a development system for your custom code, extensions, and configurations to push for active testing in one of the Integration environments.
-This section walks through the steps for first time merchants with Magento, Magento SIs, and existing Magento merchants moving to the cloud. If you have already completed some of these steps or have an existing Magento developer environment, make sure to review the expected results to continue to the next. Some configurations and workflows differ for {{site.data.var.ee}} than a typical Enterprise Edition installation.
+This section walks through the steps for first time merchants with Magento, Magento SIs, and existing Magento merchants moving to the cloud. If you already completed some of these steps or have an existing Magento developer environment, review the following for expected results and continue to the next step. Some configurations and workflows differ for {{site.data.var.ee}} than a typical Enterprise Edition installation.
## Set up an account {#newaccount}
To begin working with a project and develop your store, you should have received an e-mail invitation to [create a {{site.data.var.ece}} account](https://accounts.magento.cloud). The account provides access to your project for Magento development and deployment across all supported environments.
-You should receive an e-mail invitation to verify and access the project. If you don't see the invitation, check your junk e-mail folder. Click the **Verify my account** option in the email to verify and access your project account.
+You should receive an e-mail invitation to verify and access the project. If you do not see the invitation, check your junk e-mail folder. Click the **Verify my account** option in the email to verify and access your project account.
When logged in, your project should open with a `master` branch to work with.
diff --git a/guides/v2.1/cloud/configure/configure-best-practices.md b/guides/v2.1/cloud/configure/configure-best-practices.md
index b6dc2367384..6447941c208 100644
--- a/guides/v2.1/cloud/configure/configure-best-practices.md
+++ b/guides/v2.1/cloud/configure/configure-best-practices.md
@@ -27,7 +27,7 @@ The following are tips to help create, update, and manage promotions and campaig
* A promotion can be part of a campaign. A campaign cannot be a part of a promotion. You can have lists of promotions as price rules to use multiples times, with multiple campaigns.
* When you create a promotion, it will always create an initial campaign that is inactive. It will have a start date but not an end date. You can ignore this initial campaign. You can Schedule a New Update with the correct campaign schedule and make it active.
* A campaign has a start and end date, not a promotion. The Scheduler that appears when you create a promotion does not configure the start and end dates for the promotion. It allows you so schedule your campaign this promotion is associated with while you are on the promotion’s configuration page.
-* You cannot directly edit in Staged Content. If you need to edit settings and options in the campaign, you will need to edit the original or a replica and push to overwrite in Staged Content. For example, if you don't an end date for a campaign, you must edit the original and push to update.
+* You cannot directly edit in Staged Content. If you need to edit settings and options in the campaign, you will need to edit the original or a replica and push to overwrite in Staged Content. For example, if you do not an end date for a campaign, you must edit the original and push to update.
## Advanced Pricing and Staged Content {#adv-pricing}
diff --git a/guides/v2.1/cloud/configure/setup-cron-jobs.md b/guides/v2.1/cloud/configure/setup-cron-jobs.md
index a8d977c75aa..f64922bdefa 100644
--- a/guides/v2.1/cloud/configure/setup-cron-jobs.md
+++ b/guides/v2.1/cloud/configure/setup-cron-jobs.md
@@ -128,4 +128,4 @@ We manage cron jobs on Pro plan Staging and Production environments using Jenkin
If you need to change or update your cron jobs, update the crons section in your `.magento.app.yaml` file. Push the file to your Git branch and deploy across environments.
-For Pro plan Staging and Production environments, please [enter a ticket to Support]({{ page.baseurl }}/cloud/trouble/trouble.html) to review, remove, or modify these cron jobs. To update a cron job, we recommend pushing the updates through to the Integration `master` branch in the `.magento.app.yaml` file. Cron jobs for Pro plan Staging and Production environments are not available through a Cron tab.
+For Pro plan Staging and Production environments, [enter a ticket to Support]({{ page.baseurl }}/cloud/trouble/trouble.html) to review, remove, or modify these cron jobs. To update a cron job, we recommend pushing the updates through to the Integration `master` branch in the `.magento.app.yaml` file. Cron jobs for Pro plan Staging and Production environments are not available through a Cron tab.
diff --git a/guides/v2.1/cloud/deploy/continuous-deployment.md b/guides/v2.1/cloud/deploy/continuous-deployment.md
index b9b514f03a3..f49a84a08c3 100644
--- a/guides/v2.1/cloud/deploy/continuous-deployment.md
+++ b/guides/v2.1/cloud/deploy/continuous-deployment.md
@@ -26,9 +26,9 @@ We recommend the following best practices for {{site.data.var.ece}} environments
* Keep your branches updated with the latest code for all developers to access and pull
* Maintain commit comments to share with your developers and track branch work
* Keep Staging as close to Production as possible with configurations, code, services, and data
-* Don't overfill a branch of development work, keep it streamlined to carefully implement and test code, extensions, etc
+* Do not overfill a branch of development work, keep it streamlined to carefully implement and test code, extensions, etc
* Keep track of the order you follow for adding extensions to your code. Some extensions require very specific installation orders.
-* Don't push all of your extensions at once into Staging and Production. Add, push, and test extensions in groups to ensure they are stable.
+* Do not push all of your extensions at once into Staging and Production. Add, push, and test extensions in groups to ensure they are stable.
* Use Magento Configuration Management to ensure configuration consistency
## Deployment best practices
diff --git a/guides/v2.1/cloud/env/environments-ssh.md b/guides/v2.1/cloud/env/environments-ssh.md
index eac2fd380b1..69b3141d1fb 100644
--- a/guides/v2.1/cloud/env/environments-ssh.md
+++ b/guides/v2.1/cloud/env/environments-ssh.md
@@ -22,7 +22,7 @@ To use SSH, you need to:
You create an SSH key pair including a public and private key:
* The _public key_ is safe to provide for accessing a site, [SSH](#ssh), and [sFTP](#sftp).
-* The _private key_ should remain private on your workspace that you use for remote accessing environments. **Never share your private key.** Don't add it to a ticket, copy it to a chat, or attach it to emails.
+* The _private key_ should remain private on your workspace that you use for remote accessing environments. **Never share your private key.** Do not add it to a ticket, copy it to a chat, or attach it to emails.
## How SSH keys work {#work}
diff --git a/guides/v2.1/cloud/howtos/custom-theme.md b/guides/v2.1/cloud/howtos/custom-theme.md
index 908597b3d13..9793e576a33 100644
--- a/guides/v2.1/cloud/howtos/custom-theme.md
+++ b/guides/v2.1/cloud/howtos/custom-theme.md
@@ -41,7 +41,7 @@ To install a theme manually, you must have the theme's code, either in a compres
To install a theme manually:
-1. Copy the theme's code under `/app/design/frontend` for a storefront theme or `/app/design/adminhtml` for an Admin theme. Make sure the top-level directory is ``; otherwise, the theme won't install properly.
+1. Copy the theme's code under `/app/design/frontend` for a storefront theme or `/app/design/adminhtml` for an Admin theme. Verify that the top-level directory is ``; otherwise, the theme will not install properly.
For example:
diff --git a/guides/v2.1/cloud/howtos/debug.md b/guides/v2.1/cloud/howtos/debug.md
index bd2eb95e5c1..fa3960536dc 100644
--- a/guides/v2.1/cloud/howtos/debug.md
+++ b/guides/v2.1/cloud/howtos/debug.md
@@ -10,7 +10,7 @@ functional_areas:
- Setup
---
-We recommend using Xdebug for your PHP debugging. The following sections detail how to configure Xdebug and PhpStorm to work locally with settings in your environments. You can use any IDE of your choice. Please see the vendor documentation for those applications for further configuration information.
+We recommend using Xdebug for your PHP debugging. The following sections detail how to configure Xdebug and PhpStorm to work locally with settings in your environments. You can use any IDE of your choice. See the vendor documentation for those applications for further configuration information.
To set up Xdebug, you need to [configure](#configure) a file in your Git repo, configure your IDE PhpStorm, and set up port forwarding. You will configure settings in the `magento.app.yaml` file. After editing, you can push the Git changes across all Starter environments and Pro Integration environments to enable Xdebug. To push these settings to Pro plan Staging and Production environments, you must enter a ticket.
@@ -144,11 +144,11 @@ To troubleshoot the connection:
#### Port forwarding on Windows {#portwindows}
-To set up port forwarding (SSH tunneling) on Windows, you will configure your Windows terminal application. For this example, we walk through creating an SSH tunnel using [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html). You can use other applications such as Cygwin. For more information on other applications, please see the vendor documentation provided with those applications.
+To set up port forwarding (SSH tunneling) on Windows, you must configure your Windows terminal application. For this example, we walk through creating an SSH tunnel using [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html). You can use other applications such as Cygwin. For more information on other applications, see the vendor documentation provided with those applications.
To set up an SSH tunnel on Windows using Putty:
-1. If you haven't already done so, download [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html).
+1. If you have not already done so, download [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html).
2. Start Putty.
3. In the Category pane, click **Session**.
4. Enter the following information:
@@ -204,7 +204,7 @@ For example,
To use Xdebug specifically on Pro plan Staging and Production environment, you create a separate SSH tunnel and web session only you have access to. This usage differs from typical access, only providing access to you and not to all users.
-You will need the following:
+You need the following:
* SSH commands for accessing the environments. You can get this information, through the [Project Web Interface]({{ page.baseurl }}/cloud/project/projects.html) and your project spreadsheet.
* The `xdebug_key` value we set when configuring the Staging and Pro environments
@@ -231,7 +231,8 @@ To start debugging, use the following commands with the environment URL:
?XDEBUG_SESSION_STOP=KEY
-Please note, `XDEBUG_SESSION_START`passed by `POST` requests are not supported at this time.
+{: .bs-callout .bs-callout-info}
+The `XDEBUG_SESSION_START` passed by `POST` requests are not supported at this time.
## Debug CLI commands {#debugcli}
@@ -288,7 +289,7 @@ The method you choose is up to you. You have the following options:
* Check out code from Git and run `composer install`
- This method works unless `composer.json` references packages in private repositories to which you don't have access. This method results in getting the entire Magento codebase.
+ This method works unless `composer.json` references packages in private repositories to which you do not have access. This method results in getting the entire Magento codebase.
* Copy the `vendor`, `app`, `pub`, `lib`, and `setup` directories
diff --git a/guides/v2.1/cloud/howtos/environment-tutorial-env-merge.md b/guides/v2.1/cloud/howtos/environment-tutorial-env-merge.md
index 85a35340fbf..2186f9d9647 100644
--- a/guides/v2.1/cloud/howtos/environment-tutorial-env-merge.md
+++ b/guides/v2.1/cloud/howtos/environment-tutorial-env-merge.md
@@ -49,7 +49,7 @@ To merge an environment:
## Optionally delete the environment {#tut-env-delete}
-Before you delete an environment, make sure you don't need it anymore. You cannot recover a deleted environment later.
+You need to verify that you do not need an environment before you delete it. You cannot recover a deleted environment later.
{:.bs-callout .bs-callout-info}
You cannot delete the `master` environment of any project.
diff --git a/guides/v2.1/cloud/howtos/install-components.md b/guides/v2.1/cloud/howtos/install-components.md
index 5d59155af78..5090ece7109 100644
--- a/guides/v2.1/cloud/howtos/install-components.md
+++ b/guides/v2.1/cloud/howtos/install-components.md
@@ -80,7 +80,7 @@ When installing and adding the module, you must add the `composer.lock` file to
### Step 3: Verify the extension {#verify}
-To verify the extension installed properly, you can check its functionality in the Magento Admin or you can make sure it is enabled as follows:
+To verify the extension installed properly, you can check its functionality in the Magento Admin or you can view enabled modules using the CLI:
1. Open a terminal.
1. [Checkout the branch]({{ page.baseurl }}/cloud/before/before-setup-env-2_clone.html#branch) where the module is installed.
@@ -161,7 +161,7 @@ You can use CLI commands or directly edit `app/etc/config.php` to enable or disa
### Modify configurations {#configure}
-For projects using {{site.data.var.ece}} **before 2.1.4**, to change settings for your extensions and modules, you should make those changes in all environments as needed. We recommend using similar or matching settings between Staging and Production to fully test functionality. If you have an extension or module using sandbox credentials and settings, you make sure to switch those to live settings if in Production.
+For projects using {{site.data.var.ece}} **before 2.1.4**, to change settings for your extensions and modules, you should make those changes in all environments as needed. We recommend using similar or matching settings between Staging and Production to fully test functionality. If you have an extension or module using sandbox credentials and settings, you must switch those to live settings if in Production.
For projects **2.1.4 and later**, you will update configurations according to [Configuration Management]({{ site.baseurl }}/guides/v2.1/cloud/live/sens-data-over.html#cloud-clp-settings) for `config.local.php`.
diff --git a/guides/v2.1/cloud/howtos/sample-data.md b/guides/v2.1/cloud/howtos/sample-data.md
index 09ad82d2e0d..c2cac3deef1 100644
--- a/guides/v2.1/cloud/howtos/sample-data.md
+++ b/guides/v2.1/cloud/howtos/sample-data.md
@@ -12,7 +12,7 @@ functional_areas:
If you need some example data when developing your store, you can install our sample data. This data simulates an active Magento store including customers, products, and other data. This sample data works best with a new "blank site" {{site.data.var.ece}} template installation when creating your project in your Integration environment.
-We recommend installing sample data in your local Integration branches and environments. If you use this data in Staging or Production, make sure to clear out the information and products before going live.
+We recommend installing sample data in your local Integration branches and environments. If you use this data in Staging or Production, you need to remove the information and products before going live.
## Get started in a branch {#branch}
diff --git a/guides/v2.1/cloud/live/launch-steps.md b/guides/v2.1/cloud/live/launch-steps.md
index 8916c9e7522..b879be224b7 100644
--- a/guides/v2.1/cloud/live/launch-steps.md
+++ b/guides/v2.1/cloud/live/launch-steps.md
@@ -34,7 +34,7 @@ To cut over to the new site:
## Test the live store {#test}
-Complete a few UAT tests in your live store to make sure everything is loading and actions complete correctly. For a list of tests, see [Test deployment]({{ page.baseurl }}/cloud/live/stage-prod-test.html).
+Complete a few UAT tests in your live store to confirm everything is loading and actions complete correctly. For a list of tests, see [Test deployment]({{ page.baseurl }}/cloud/live/stage-prod-test.html).
## Post-Launch {#postlaunch}
diff --git a/guides/v2.1/cloud/live/live-sanity-check.md b/guides/v2.1/cloud/live/live-sanity-check.md
index 4cc0352c376..f22e89be9ac 100644
--- a/guides/v2.1/cloud/live/live-sanity-check.md
+++ b/guides/v2.1/cloud/live/live-sanity-check.md
@@ -53,7 +53,7 @@ To remove these test builds, you can use the `magento-cloud local:clean` command
## Push code to Git and Integration {#push}
-Before you continue, make sure you push all current code to the remote Cloud server so that, in event of issues, you can recover the state of the Magento application.
+Before you continue, push all current code to the remote Cloud server so that, in event of issues, you can recover the state of the Magento application.
#### To prepare your code and branch:
diff --git a/guides/v2.1/cloud/live/live.md b/guides/v2.1/cloud/live/live.md
index 7c1b18b51a5..8b764ee701e 100644
--- a/guides/v2.1/cloud/live/live.md
+++ b/guides/v2.1/cloud/live/live.md
@@ -30,8 +30,8 @@ We strongly recommend testing in these environments due to the complexity of you
* Staging supports all Production services, features, database data, technology stack, architecture, and more. It mirrors Production, which means if errors occur in Staging, you have a **warning before it occurs in Production**.
* Extensions may need to be installed and configured in a specific order. Some extensions touch similar pieces of code in the back and frontend, sometimes clashing and causing errors.
* Extensions typically are heavily tested in [Developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html), not Production mode. When you move to Staging and use Production mode, you may find error and surprises between extensions, your custom code, and Magento.
-* Configurations and code may work great in your developer Integration environments and run into issues in Staging and Production. Working in your local doesn't confirm it works perfectly in production.
-* Integration environments don't have all the incredible services available in Staging and Production, like Fastly, New Relic, and Blackfire.
+* Configurations and code may work great in your developer Integration environments and run into issues in Staging and Production. Working in your local does not confirm it works perfectly in production.
+* Integration environments do not have all the incredible services available in Staging and Production, like Fastly, New Relic, and Blackfire.
* [Fully test]({{ page.baseurl }}/cloud/live/stage-prod-test.html#loadtest) your site with a variety of tools in Staging for load, stress, performance, and site assets
* Integration environments may only have databases populated with test data, not matching a production-like environment
@@ -57,7 +57,7 @@ To review the report:
1. When the report completes, a notification displays.
2. In the site row, select the report you want to view from the **Reports** column. The order is latest to oldest.
-The report lists issues including Failed Scans, Unidentified Results, and Successful Scans. Each entry provides detailed information for the scan, any issues to investigate, and actions to take. Some of these actions may require downloading and installing security patches. Make sure to add those via branches and Git pushes through your local.
+The report lists issues including Failed Scans, Unidentified Results, and Successful Scans. Each entry provides detailed information for the scan, a list of issues to investigate, and actions to take. Some of these actions may require downloading and installing security patches. You can add those to a development branch on your local workstation.
Scan results include a general label that describes whether a site passed or failed plus detailed information about the checks performed. Failed indicates that the website contains a serious vulnerability, while unidentified suggests that a deeper review is required by your team or hosting provider to determine if further action is required. We also provide suggested remediation steps for each failed security test. Security scan results are protected and viewable only by the registered user, and notifications of scan completion are restricted to the users designated in the site registration process.
diff --git a/guides/v2.1/cloud/live/sens-data-initial.md b/guides/v2.1/cloud/live/sens-data-initial.md
index c4659a19632..e080589b2b1 100644
--- a/guides/v2.1/cloud/live/sens-data-initial.md
+++ b/guides/v2.1/cloud/live/sens-data-initial.md
@@ -151,7 +151,7 @@ Before you can change settings on the Integration environment, delete `app/etc/c
To delete `config.local.php`:
-1. On your local workstation, make sure you're on the `master` branch.
+1. On your local workstation, check out the `master` branch.
2. SSH to the integration server:
magento-cloud ssh
diff --git a/guides/v2.1/cloud/live/sens-data-over.md b/guides/v2.1/cloud/live/sens-data-over.md
index 31e6065dd7e..ec0f0445a12 100644
--- a/guides/v2.1/cloud/live/sens-data-over.md
+++ b/guides/v2.1/cloud/live/sens-data-over.md
@@ -124,7 +124,7 @@ Managing store configuration is a complex task mostly up to you. What locales do
We **strongly recommend** using the `scd-dump` command to generate a `config.local.php` file. This file includes only the settings you configure without locking the default values. It also ensures that all extensions used in the Staging and Production environments do not break due to read-only configurations, especially Fastly.
-To fully understand the process, please see [our extensive example]({{ page.baseurl }}/cloud/live/sens-data-initial.html).
+To fully understand the process, see [our extensive example]({{ page.baseurl }}/cloud/live/sens-data-initial.html).
The **Starter plan** environment high-level overview of this process:
diff --git a/guides/v2.1/cloud/live/stage-prod-migrate-prereq.md b/guides/v2.1/cloud/live/stage-prod-migrate-prereq.md
index 96087a28ca7..233a20c107f 100644
--- a/guides/v2.1/cloud/live/stage-prod-migrate-prereq.md
+++ b/guides/v2.1/cloud/live/stage-prod-migrate-prereq.md
@@ -20,9 +20,9 @@ This information is broken down into prerequisite steps for [Starter](#starter)
## Starter plan projects {#starter}
-For Starter, make sure all of your code is merged into a single development branch to test prior to deployment to Production. Due to all of your branches and environments being on a PaaS infrastructure, you only need access information for Master Production and other environments as needed. This access information includes your store URLs and SSH link.
+For Starter, merge all code into one "staging" branch for testing prior to deploying to Production. All active branches and environments are part of the PaaS infrastructure and have access to information, such as store URLs and SSH link.
-You can deploy to your environments, including all .yaml configuration files, migrate files and data, all through CLI commands using SSH.
+You can deploy to your environments, including all YAML configuration files, migrate files and data, all through CLI commands using SSH.
To prepare your environments for full deployment, you need:
@@ -31,7 +31,7 @@ To prepare your environments for full deployment, you need:
### Get your Starter access URLs and SSH information {#starter-urls}
-You can locate your URLs through the Project Web Interface. For each selected environment or branch, you will find an Access Site link. Your environments begin with Master, which is Production, and any additional branches you create, including Staging (recommended) and development branches for custom code.
+You can locate your URLs through the Project Web Interface. For each selected environment or branch, you have an Access Site link. Your environments begin with Master, which is Production, and any additional branches you create, including Staging (recommended) and development branches for custom code.
1. Log in to [your {{site.data.var.ece}} account](https://accounts.magento.cloud).
2. Select an environment.
@@ -41,7 +41,7 @@ You can locate your URLs through the Project Web Interface. For each selected en
## Pro plan projects {#pro}
-For Pro plan projects, make sure to complete all development and merging of your code to the `master` branch in the Integration environment. Only the `master` branch is deployed to Staging then Production.
+For Pro plan projects, you must merge your completed development code to the `integration` branch. Only the Integration environment branch can deploy to Staging, then Production.
{% include cloud/wings-management.md %}
@@ -53,7 +53,7 @@ For **first time setup** to migrate your database and deploy code to Staging or
If your project was created before October 23, 2017, you also need to set up [remote Git repositories](#pro-remote) on Staging and Production. Deployment targets are already set up on Staging and Production for projects created after October 23, 2017.
-If you haven't done so already, upload any [Fastly VCL snippets]({{ page.baseurl }}/cloud/cdn/configure-fastly.html#upload-vcl-snippets) in your Integration environment `master` Magento Admin panel. Fastly is available in Staging and Production.
+If you have not done so already, upload any [Fastly VCL snippets]({{ page.baseurl }}/cloud/cdn/configure-fastly.html#upload-vcl-snippets) in your Integration environment `master` Magento Admin panel. Fastly is available in Staging and Production.
### Migrate your `.magento.app.yaml` file {#pro-yaml}
@@ -88,7 +88,7 @@ For Pro projects created **before October 23, 2017**, you would need to access t
For Pro projects created **after October 23, 2017**, you do not need to complete this step. Your Staging and Production environments are branches of `master` with configured deployment targets. You can simply merge code to these environments from Integration `master`. You can also use the Project Web Interface to merge your code without SSH or Git commands.
-For Pro projects created **before October 23, 2017**, you will need to initially set up remote Git repositories for Staging and Production. For these classic Pro accounts, your Staging and Production environments have dedicated Git repositories. You only need to set these up once.
+For Pro projects created **before October 23, 2017**, you need to initially set up remote Git repositories for Staging and Production. For these classic Pro accounts, your Staging and Production environments have dedicated Git repositories. You only need to set these up once.
When you know your Git URLs, you need to set them up as remote upstream repositories so you can push code to them. Basically, you configure these remote repositories using these instructions to SSH into the environments and push code and migrate data and files using Git commands.
diff --git a/guides/v2.1/cloud/live/stage-prod-migrate.md b/guides/v2.1/cloud/live/stage-prod-migrate.md
index 767bfe50358..3dcec8d0ebb 100644
--- a/guides/v2.1/cloud/live/stage-prod-migrate.md
+++ b/guides/v2.1/cloud/live/stage-prod-migrate.md
@@ -132,7 +132,7 @@ To migrate static files from your local machine:
To migrate static files from remote-to-remote environments directly (fast approach):
-**Note** In order to transfer media from remote-to-remote environments directly you need to enable ssh agent forwarding, please refer to this [GitHub guidance](https://developer.github.com/v3/guides/using-ssh-agent-forwarding/)
+**Note** In order to transfer media from remote-to-remote environments directly you need to enable ssh agent forwarding, see [GitHub guidance](https://developer.github.com/v3/guides/using-ssh-agent-forwarding/)
1. SSH into the environment you want to transfer from (you can find ssh link in your Cloud UI -> select the branch -> Access Site -> SSH access):
@@ -146,7 +146,7 @@ To migrate static files from remote-to-remote environments directly (fast approa
## Migrate the database {#cloud-live-migrate-db}
-**Prerequisite:** A database dump (see Step 3) should include database triggers. For dumping them, make sure you have the [TRIGGER privilege](https://dev.mysql.com/doc/refman/5.7/en/privileges-provided.html#priv_trigger).
+**Prerequisite:** A database dump (see Step 3) should include database triggers. For dumping them, confirm you have the [TRIGGER privilege](https://dev.mysql.com/doc/refman/5.7/en/privileges-provided.html#priv_trigger).
**Important:** The Integration environment database is strictly for development testing and may include data you may not want to migrate into Staging and Production.
@@ -154,7 +154,7 @@ For continuous integration deployments, we **do not recommend** migrating data f
We **do recommend** migrating data from Production into Staging to fully test your site and store(s) in a near-production environment with all services and settings.
-**Note** In order to transfer media from remote-to-remote environments directly you need to enable ssh agent forwarding, please refer to this [GitHub guidance](https://developer.github.com/v3/guides/using-ssh-agent-forwarding/)
+**Note** In order to transfer media from remote-to-remote environments directly you need to enable ssh agent forwarding, see [GitHub guidance](https://developer.github.com/v3/guides/using-ssh-agent-forwarding/)
To migrate a database:
diff --git a/guides/v2.1/cloud/live/stage-prod-test.md b/guides/v2.1/cloud/live/stage-prod-test.md
index 02fe8a57d59..e309cea09cc 100644
--- a/guides/v2.1/cloud/live/stage-prod-test.md
+++ b/guides/v2.1/cloud/live/stage-prod-test.md
@@ -203,7 +203,7 @@ If you encounter issues, save your reproduction steps, error messages, strange s
Before launching, we highly recommend performing extensive traffic and performance testing on your Staging and Production environments. You should consider performance testing for your frontend and backend processes.
-Before you begin testing, please enter a ticket with support advising the environments you are testing, what tools you are using, and the time frame. Update the ticket with results and information to track performance. When you complete testing, add your updated results and note in the ticket testing is complete with a date and time stamp.
+Before you begin testing, enter a ticket with support advising the environments you are testing, what tools you are using, and the time frame. Update the ticket with results and information to track performance. When you complete testing, add your updated results and note in the ticket testing is complete with a date and time stamp.
We recommend that you review the [Magento Performance Toolkit](https://github.com/magento/magento2/tree/2.0/setup/performance-toolkit) options as part of your pre-launch readiness process.
diff --git a/guides/v2.1/cloud/project/project-conf-files_magento-app.md b/guides/v2.1/cloud/project/project-conf-files_magento-app.md
index f5519cce440..31184b35528 100644
--- a/guides/v2.1/cloud/project/project-conf-files_magento-app.md
+++ b/guides/v2.1/cloud/project/project-conf-files_magento-app.md
@@ -12,7 +12,7 @@ functional_areas:
The `.magento.app.yaml` file controls the way your application builds and deploys. Although {{site.data.var.ece}} supports multiple applications per project, typically, a project has a single application with the `.magento.app.yaml` file at the root of the repository.
-The `.magento.app.yaml` has many default values, see [a sample `.magento.app.yaml` file](https://github.com/magento/magento-cloud/blob/master/.magento.app.yaml). Make sure to review the `.magento.app.yaml` for your installed version. This file can differ across {{site.data.var.ece}} versions.
+The `.magento.app.yaml` has many default values, see [a sample `.magento.app.yaml` file](https://github.com/magento/magento-cloud/blob/master/.magento.app.yaml). Always review the `.magento.app.yaml` for your installed version. This file can differ across {{site.data.var.ece}} versions.
{% include cloud/note-pro-using-yaml.md %}
@@ -189,7 +189,7 @@ nodejs:
### `hooks`
Use the `hooks` section to run shell commands during the build, deploy, and post-deploy phases:
-- **`build`**—Execute commands _before_ packaging your application. Services, such as the database or Redis, are not available at this time since the application has not been deployed yet. You must add custom commands _before_ the default `php ./vendor/bin/ece-tools` command to make sure custom-generated content makes it to the deployment phase.
+- **`build`**—Execute commands _before_ packaging your application. Services, such as the database or Redis, are not available at this time since the application has not been deployed yet. You must add custom commands _before_ the default `php ./vendor/bin/ece-tools` command so that custom-generated content continues to the deployment phase.
- **`deploy`**—Execute commands _after_ packaging and deploying your application. You can access other services at this point. Since the default `php ./vendor/bin/ece-tools` command copies the `app/etc` directory to the correct location, you must add custom commands _after_ the deploy command to prevent custom commands from failing.
- **`post_deploy`**—Execute commands _after_ deploying your application and _after_ the container begins accepting connections. The `post_deploy` hook clears the cache and preloads (warms) the cache. You can customize the list of pages using the `WARM_UP_PAGES` variable in the [Post-deploy stage]({{ site.baseurl }}/guides/v2.1/cloud/env/variables-post-deploy.html). It is available only for Pro projects that contain [Staging and Production environments in the Project Web UI]({{ page.baseurl }}/cloud/trouble/pro-env-management.html) and for Starter projects. Although not required, this works in tandem with the `SCD_ON_DEMAND` environment variable.
diff --git a/guides/v2.1/cloud/project/project-multi-sites.md b/guides/v2.1/cloud/project/project-multi-sites.md
index 5ac6a2c7b5d..8db276695c2 100644
--- a/guides/v2.1/cloud/project/project-multi-sites.md
+++ b/guides/v2.1/cloud/project/project-multi-sites.md
@@ -64,7 +64,7 @@ To set up routes in a staging or production environment, you must create a [Supp
In the Admin panel, set up your {{site.data.var.ee}} websites, stores, and store views. See [Set up multiple websites, stores, and store views in the Admin]({{ page.baseurl }}/config-guide/multi-site/ms_websites.html).
-Make sure you name your websites, stores, and store views in your Cloud Admin the same as you did when you set up your local installation.
+It is important to name your websites, stores, and store views in your Cloud Admin the same as you did when you set up your local installation.
### Modify the `magento-vars.php` file
diff --git a/guides/v2.1/cloud/project/project-routes-more-redir.md b/guides/v2.1/cloud/project/project-routes-more-redir.md
index 71ccc9216c3..3af6c345af7 100644
--- a/guides/v2.1/cloud/project/project-routes-more-redir.md
+++ b/guides/v2.1/cloud/project/project-routes-more-redir.md
@@ -19,7 +19,7 @@ especially in cases where you do not want to lose incoming links that have
changed or been removed over time. This topic discusses how you can manage redirection rules on your
{{site.data.var.ece}} projects.
-If the redirection methods discussed in this topic don't work for you, you can use caching headers to do the same thing.
+If the redirection methods discussed in this topic do not work for you, you can use caching headers to do the same thing.
## Whole-route redirects {#cloud-route-whole}
diff --git a/guides/v2.1/cloud/release-notes/CloudReleaseNotes2.1.3.md b/guides/v2.1/cloud/release-notes/CloudReleaseNotes2.1.3.md
index 7ee8c8e8c87..451cf446741 100644
--- a/guides/v2.1/cloud/release-notes/CloudReleaseNotes2.1.3.md
+++ b/guides/v2.1/cloud/release-notes/CloudReleaseNotes2.1.3.md
@@ -66,7 +66,7 @@ This section discusses how to update your [integration]({{ page.baseurl }}/cloud
Elasticsearch is supported by Magento Cloud Enterprise Edition 2.1.x only.
-If you installed Magento Enterprise Cloud Edition 2.1.3 for the first time, you don't need to do this because Elasticsearch is already the default search engine.
+If you installed Magento Enterprise Cloud Edition 2.1.3 for the first time, you do not need to do this because Elasticsearch is already the default search engine.
To use Elasticsearch on a [staging]({{ page.baseurl }}/cloud/architecture/cloud-architecture.html) or [production]({{ page.baseurl }}/cloud/architecture/cloud-architecture.html) system, open a [Support ticket]({{ page.baseurl }}/cloud/trouble/trouble.html) and request Elasticsearch.
diff --git a/guides/v2.1/cloud/release-notes/cloud-release-archive.md b/guides/v2.1/cloud/release-notes/cloud-release-archive.md
index 9040bd4915c..a8c12bb83ec 100644
--- a/guides/v2.1/cloud/release-notes/cloud-release-archive.md
+++ b/guides/v2.1/cloud/release-notes/cloud-release-archive.md
@@ -82,7 +82,7 @@ We merged `vendor/magento/ece-patches` with `vendor/magento/ece-tools` in this r
- [Static content deployment performance]({{ site.baseurl }}/guides/v2.1/cloud/live/sens-data-over.html#cloud-confman-scd-over)
- [Deployment process]({{ site.baseurl }}/guides/v2.1/cloud/reference/discover-deploy.html)
-- **Configuration management**—We now auto-generate an `app/etc/config.php` file in your Git repository during the build phase if it doesn't already exist. The auto-generated file includes only a list of modules and extensions. If the file already exists, the build phase continues as normal. If you follow [Configuration Management]({{ site.baseurl }}/guides/v2.1/cloud/live/sens-data-over.html) at a later time, the commands update the file without requiring additional steps. Refer to [Deployment process]({{ site.baseurl }}/guides/v2.1/cloud/reference/discover-deploy.html) for more information.
+- **Configuration management**—We now auto-generate an `app/etc/config.php` file in your Git repository during the build phase if it does not already exist. The auto-generated file includes only a list of modules and extensions. If the file already exists, the build phase continues as normal. If you follow [Configuration Management]({{ site.baseurl }}/guides/v2.1/cloud/live/sens-data-over.html) at a later time, the commands update the file without requiring additional steps. Refer to [Deployment process]({{ site.baseurl }}/guides/v2.1/cloud/reference/discover-deploy.html) for more information.
- **Database dumps**—We added a new `magento/ece-tools` CLI command for creating database dumps in all environments. For Pro plan Production environments, this command only dumps from one of three high-availability nodes, so production data written to a different node during the dump may not be copied. We recommend putting the application in maintenance mode before doing a database dump in Production environments. See [Snapshots and backup management]({{ site.baseurl }}/guides/v2.1/cloud/project/project-webint-snap.html#db-dump) for more information.
diff --git a/guides/v2.1/cloud/setup/first-time-setup-import-import.md b/guides/v2.1/cloud/setup/first-time-setup-import-import.md
index 1e59d836d6d..412e41a1a0a 100755
--- a/guides/v2.1/cloud/setup/first-time-setup-import-import.md
+++ b/guides/v2.1/cloud/setup/first-time-setup-import-import.md
@@ -34,7 +34,7 @@ Create a remote Git reference from your Cloud Git repository to the repository c
1. Log in to your local {{site.data.var.ece}} development machine as, or switch to, the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
-1. Copy `composer.json` to a _non-tracked directory_ so it doesn't get overwritten.
+1. Copy `composer.json` to a _non-tracked directory_ so it does not get overwritten.
```
cp composer.json ../composer.json.cloud
@@ -251,7 +251,7 @@ To add your {{site.data.var.ee}} encryption key:
1. Save your changes to `env.php` and exit the text editor.
{:.bs-callout .bs-callout-info}
- Make sure to add this key to the `env.php` file for all environments: Integration, Staging, and Production.
+ You must add this key to the `env.php` file for all environments: Integration, Staging, and Production.
## Import media {#media}
@@ -298,7 +298,7 @@ To verify everything imported properly, perform the following tasks in your loca
```
1. Log in to the Magento {% glossarytooltip 29ddb393-ca22-4df9-a8d4-0024d75739b1 %}Admin{% endglossarytooltip %} using the username and password of your {{site.data.var.ee}} system.
-1. Make sure settings in the Admin are the same as your {{site.data.var.ee}} system.
+1. Verify that the settings in the Admin are the same as your {{site.data.var.ee}} system.
1. Access the {% glossarytooltip 1a70d3ac-6bd9-475a-8937-5f80ca785c14 %}storefront{% endglossarytooltip %}.
-1. Make sure categories, products, and so on display as you expect.
+1. Confirm that categories, products, and other content display as expected.
1. Test everything thoroughly.
diff --git a/guides/v2.1/cloud/setup/first-time-setup-import-prepare.md b/guides/v2.1/cloud/setup/first-time-setup-import-prepare.md
index 459c934cac3..2d45fa700b5 100755
--- a/guides/v2.1/cloud/setup/first-time-setup-import-prepare.md
+++ b/guides/v2.1/cloud/setup/first-time-setup-import-prepare.md
@@ -66,11 +66,11 @@ Add these files to your {{site.data.var.ee}} code:
{:width="600px"}
3. In your {{site.data.var.ee}} project, open a text editor in the {{site.data.var.ee}} installation directory (for example, `/var/www/html/magento2`).
4. Paste the raw contents of `.magento.app.yaml` from GitHub into the text editor.
- 5. Make sure the file is named `.magento.app.yaml` when you save the file.
+ 5. Save the file using the name: `.magento.app.yaml`
6. Repeat these tasks for the other files.
- * Make sure to create `magento-vars.php` in the Magento root directory.
- * Make sure to create `routes.yaml` and `services.yaml` in the `.magento` subdirectory.
+ * Create `magento-vars.php` in the Magento root directory.
+ * Create `routes.yaml` and `services.yaml` in the `.magento` subdirectory.
When you push your code, all services are configured into the associated environment per active branch of code. These files affect all Starter environments and all Pro Integration environments. To update these settings in Pro Staging and Production, you need to enter a ticket.
@@ -206,7 +206,7 @@ You must paste the encryption key into your {{site.data.var.ece}} `env.php` file
Create a database dump and transfer the data from an existing database. You will import this data to your {{site.data.var.ece}} database.
-The following command example compresses the dump so it doesn't significantly interfere with traffic from in live site. The dump file is named `db.sql.gz`. You may want to include the date in the file name if you do multiple dumps over time. Because the database dump can be large, we recommend you create it in a directory not tracked by Git.
+The following example compresses the dump so that it does not significantly interfere with traffic from a live site. The dump file is named `db.sql.gz`. You may want to include the date in the file name if you do multiple dumps over time. Because the database dump can be large, we recommend you create it in a directory not tracked by Git.
1. In your existing environment, create a database dump.
diff --git a/guides/v2.1/cloud/trouble/pro-env-management.md b/guides/v2.1/cloud/trouble/pro-env-management.md
index 945c623109d..cca3a47425b 100644
--- a/guides/v2.1/cloud/trouble/pro-env-management.md
+++ b/guides/v2.1/cloud/trouble/pro-env-management.md
@@ -59,7 +59,7 @@ To prepare, verify that your settings and environment variables are correct.
### Verify code
-We strongly recommend working in your local development environment, deploying to Integration, deploying to Staging, and, finally, deploying to Production. All code should match 100% across each of these environments. Before submitting a ticket, make sure you sync your code. This process creates a new branch of code for Staging and Production environments.
+We strongly recommend working in your local development environment, deploying to Integration, deploying to Staging, and, finally, deploying to Production. All code should match 100% across each of these environments. You must sync your code before submitting a ticket. This process creates a new branch of code for Staging and Production environments.
If you have additional code, such as new extensions in your Production environment without following this workflow, then deployments from Integration or Staging **overwrite** your Production code.
diff --git a/guides/v2.1/cloud/trouble/trouble_ce-creds.md b/guides/v2.1/cloud/trouble/trouble_ce-creds.md
index 8368e0f4d3a..7a42efcd1ed 100644
--- a/guides/v2.1/cloud/trouble/trouble_ce-creds.md
+++ b/guides/v2.1/cloud/trouble/trouble_ce-creds.md
@@ -31,7 +31,7 @@ To see the error log:
To resolve this issue, you must clone the project locally and update `auth.json` with the correct {{site.data.var.ee}} [authorization keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) and run `composer update` to update project dependencies. After that, you can deploy your project successfully and get started with your development.
-Make sure you're using your own keys, and *not* [shared account keys](http://docs.magento.com/m2/ce/user_guide/magento/magento-account-share.html).
+Verify that you are using your own keys, and *not* [shared account keys](http://docs.magento.com/m2/ce/user_guide/magento/magento-account-share.html).
#### Get started
diff --git a/guides/v2.1/cloud/trouble/trouble_comp-deploy-fail.md b/guides/v2.1/cloud/trouble/trouble_comp-deploy-fail.md
index 54c820b4bd2..44cf329a105 100644
--- a/guides/v2.1/cloud/trouble/trouble_comp-deploy-fail.md
+++ b/guides/v2.1/cloud/trouble/trouble_comp-deploy-fail.md
@@ -50,7 +50,7 @@ To remove the component:
composer remove :
- If the following message displays, you don't need to do anything further:
+ If the following message displays, you do not need to do anything further:
Package ":" listed for update is not installed. Ignoring.
diff --git a/guides/v2.1/install-gde/composer.md b/guides/v2.1/install-gde/composer.md
index 967cbf05eed..4e205860b58 100644
--- a/guides/v2.1/install-gde/composer.md
+++ b/guides/v2.1/install-gde/composer.md
@@ -63,7 +63,7 @@ You must set read-write permissions for the web server group before you install
cd /var/www/html/
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
-chown -R :www-data . // Ubuntu
+chown -R :www-data . # Ubuntu
chmod u+x bin/magento
```
diff --git a/guides/v2.1/install-gde/install/cli/install-cli-subcommands-store.md b/guides/v2.1/install-gde/install/cli/install-cli-subcommands-store.md
index 8905e72fac5..17b8772b9f0 100644
--- a/guides/v2.1/install-gde/install/cli/install-cli-subcommands-store.md
+++ b/guides/v2.1/install-gde/install/cli/install-cli-subcommands-store.md
@@ -41,5 +41,5 @@ where the following table defines parameters and values.
|`--base-url-secure`|Secure base URL to use to access your Magento Admin and storefront in the following format:`http[s]:////`|No|
|`--use-secure-admin`|`1` means you use SSL to access the Magento Admin. Make sure your web server supports SSL before you select this option.
`0` means you do not use SSL with the Admin. This is the default.|No|
|`--admin-use-security-key`|`1` causes the Magento software to use a randomly generated key value to access pages in the Magento Admin and in forms. These key values help prevent cross-site script forgery attacks. This is the default.
`0` disables the use of the key.|No|
-|`--magento-init-params`|Add to any command to customize Magneto initialization parameters
For example: `MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache`|No|
+|`--magento-init-params`|Add to any command to customize Magento initialization parameters
For example: `MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache`|No|
{:style="table-layout:auto;"}
diff --git a/guides/v2.1/install-gde/install/sample-data-before-clone.md b/guides/v2.1/install-gde/install/sample-data-before-clone.md
index 2c9930b8af1..267421f41cb 100644
--- a/guides/v2.1/install-gde/install/sample-data-before-clone.md
+++ b/guides/v2.1/install-gde/install/sample-data-before-clone.md
@@ -1,5 +1,5 @@
---
-group: SampleData
+group: installation-guide
subgroup: T_SampleData
title: Install by cloning repositories
menu_title: Install by cloning repositories
diff --git a/guides/v2.1/install-gde/install/sample-data-before-composer.md b/guides/v2.1/install-gde/install/sample-data-before-composer.md
index 9b10b0d30e1..3f448aa2675 100644
--- a/guides/v2.1/install-gde/install/sample-data-before-composer.md
+++ b/guides/v2.1/install-gde/install/sample-data-before-composer.md
@@ -1,5 +1,5 @@
---
-group: SampleData
+group: installation-guide
subgroup: T_SampleData
title: Install using Composer
menu_title: Install using Composer
diff --git a/guides/v2.1/install-gde/install/sample-data-other-cmds.md b/guides/v2.1/install-gde/install/sample-data-other-cmds.md
index 0693b309569..08bfd37ba3d 100644
--- a/guides/v2.1/install-gde/install/sample-data-other-cmds.md
+++ b/guides/v2.1/install-gde/install/sample-data-other-cmds.md
@@ -1,5 +1,5 @@
---
-group: SampleData
+group: installation-guide
subgroup: T_SampleData
title: Remove sample data modules or update sample data
menu_title: Remove sample data modules or update sample data
diff --git a/guides/v2.1/install-gde/install/sample-data.md b/guides/v2.1/install-gde/install/sample-data.md
index 6db9412ed79..048bc59cb7b 100644
--- a/guides/v2.1/install-gde/install/sample-data.md
+++ b/guides/v2.1/install-gde/install/sample-data.md
@@ -1,5 +1,5 @@
---
-group: SampleData
+group: installation-guide
subgroup: T_SampleData
title: Install, remove, or update optional sample data modules
menu_title: Install, remove, or update optional sample data modules
diff --git a/guides/v2.1/install-gde/prereq/dev_install.md b/guides/v2.1/install-gde/prereq/dev_install.md
index f4f5244e240..ccf192c8b34 100644
--- a/guides/v2.1/install-gde/prereq/dev_install.md
+++ b/guides/v2.1/install-gde/prereq/dev_install.md
@@ -15,35 +15,60 @@ Totally lost? Need a helping hand? Try our [installation quick reference (tutori
## Intended audience {#integrator-aud}
-The audience for this topic is anyone who contributes to the {{site.data.var.ce}} codebase. You should be highly technical, understand {% glossarytooltip d85e2d0a-221f-4d03-aa43-0cda9f50809e %}Composer{% endglossarytooltip %} and Git commands, and be able to upgrade the Magento system software and extensions using those commands. If that isn't you, go back and [choose another starting point]({{ page.baseurl }}/install-gde/bk-install-guide.html).
+The audience for this topic is anyone who contributes to the {{site.data.var.ce}} codebase.
+You should be highly technical, understand {% glossarytooltip d85e2d0a-221f-4d03-aa43-0cda9f50809e %}Composer{% endglossarytooltip %} and Git commands, and be able to upgrade the Magento system software and extensions using those commands. If that isn't you, go back and [choose another starting point]({{ page.baseurl }}/install-gde/bk-install-guide.html).
{:.bs-callout .bs-callout-warning}
-If you clone the Magento 2 GitHub repository, you _cannot_ use the Magento software in a production environment. You cannot have a live store that accepts orders and so on.
+If you clone the Magento 2 GitHub repository, you _cannot_ use the Magento software in a production environment.
+You cannot have a live store that accepts orders and so on.
## Prerequisites
+
{% include install/prereq.md %}
{% include install/composer-overview.md %}
## Install Composer {#instgde-prereq-compose-install}
+
{% include install/composer-clone.md %}
## Clone the Magento repository {#instgde-prereq-compose-clone}
-This section discusses how to get current code by cloning [Magento's GitHub repository](https://github.com/magento/magento2){:target="_blank"} and checking out branches. You can either checkout a release branch or a development branch:
+This section discusses how to get current code by cloning [Magento's GitHub repository][]{:target="_blank"} and checking out branches.
+You can either checkout a release branch or a development branch:
+
-- Release branches, like `2.1.0`, are more stable. You _must_ use a release branch with the [Data Migration Tool]({{page.baseurl}}/migration/bk-migration-guide.html).
-- Development branches, like `2.2-develop`, contain the latest changes.
+* Release branches, like `2.x.0`, are more stable. You _must_ use a release branch with the [Data Migration Tool][].
-Currently, the `2.2-develop` branch is the default, but you can checkout a release branch, like `2.1.0`, after cloning.
+* Development branches, like `2.x-develop`, contain the latest changes.
+
+You can checkout a specific release branch after cloning the latest code.
{:.bs-callout .bs-callout-info}
-Refer to [GitHub's documentation](https://help.github.com/articles/cloning-a-repository-from-github/){:target="_blank"} for instructions on cloning a repository.
+Refer to [GitHub's documentation][]{:target="_blank"} for instructions on cloning a repository.
+
+
+### Creating an authorization file {#instgde-prereq-compose-clone-auth}
-## Create a Composer authentication file {#instgde-prereq-compose-clone-auth}
+The Magento 2 GitHub repository requires you to authenticate. The `composer install` commands fails if you do not.
+
+#### Generate Magento and Github keys
+
+To authenticate, you will need to generate [Magento authentication keys][] and a [Github personal access token][].
+
+#### Create `auth.json`
{% include install/auth-json.md %}
## Next step
-After completing the tasks discussed on this page, see [Update installation dependencies]({{page.baseurl}}/install-gde/install/prepare-install.html).
+After completing the tasks discussed on this page, see [Update installation dependencies][].
+
+
+
+[Github personal access token]: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
+[Magento's GitHub repository]: https://github.com/magento/magento2
+[Data Migration Tool]: {{page.baseurl}}/migration/bk-migration-guide.html
+[GitHub's documentation]: https://help.github.com/articles/cloning-a-repository-from-github/
+[Magento authentication keys]: {{ page.baseurl }}/install-gde/prereq/connect-auth.html
+[Update installation dependencies]: {{page.baseurl}}/install-gde/install/prepare-install.html
\ No newline at end of file
diff --git a/guides/v2.1/install-gde/prereq/nginx.md b/guides/v2.1/install-gde/prereq/nginx.md
index 4347a9a0d71..244f71e6c96 100644
--- a/guides/v2.1/install-gde/prereq/nginx.md
+++ b/guides/v2.1/install-gde/prereq/nginx.md
@@ -115,7 +115,7 @@ You cannot use the Web Setup Wizard when installing Magento on nginx. You must u
cd /var/www/html/
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
- chown -R :www-data . // Ubuntu
+ chown -R :www-data . # Ubuntu
chmod u+x bin/magento
```
diff --git a/guides/v2.1/test/integration/annotations.md b/guides/v2.1/test/integration/annotations.md
index da0d1100d18..f39363979ad 100644
--- a/guides/v2.1/test/integration/annotations.md
+++ b/guides/v2.1/test/integration/annotations.md
@@ -3,7 +3,8 @@ group: testing
title: Using DocBlock Annotations
---
-DocBlock annotations help to declare context in your code. In addition to built-in [PHPUnit annotations], the Integration testing framework provides custom annotations described in this topic.
+DocBlock annotations help to declare context in your code. In addition to built-in [PHPUnit annotations][]
+, the Integration testing framework provides custom annotations described in this topic.
### Quick overview
@@ -35,4 +36,4 @@ This order is necessary to meet the requirement of setting up the store-scoped c
-[PHPUnit annotations]: https://wiki.corp.magento.com/display/MAGE2/Custom+DocBlock+Annotations#CustomDocBlockAnnotations-RevertingAnnotation
+[PHPUnit annotations]: https://phpunit.readthedocs.io/en/7.4/annotations.html
diff --git a/guides/v2.2/cloud/basic-information/starter-develop-deploy-workflow.md b/guides/v2.2/cloud/basic-information/starter-develop-deploy-workflow.md
index 28ef7d08fa6..c1677ad53bd 100644
--- a/guides/v2.2/cloud/basic-information/starter-develop-deploy-workflow.md
+++ b/guides/v2.2/cloud/basic-information/starter-develop-deploy-workflow.md
@@ -142,7 +142,7 @@ For more information, see [Deployment workflow](#deploy).
If you need some example data when developing your store, you can install our sample data. This data simulates an active Magento store, including customers, products, and other data. This sample data works best with a "blank site" {{site.data.var.ece}} template installation when creating your project.
-We recommend installing sample data in your local and Integration environments. If you use this data in Staging or Production, make sure to clear out the information and products before going live.
+We recommend installing sample data in your local and Integration environments. If you use this data in Staging or Production, you need to remove the sample information and products before going live.
For instructions, see [Install optional sample data]({{ page.baseurl }}/cloud/howtos/sample-data.html).
diff --git a/guides/v2.2/cloud/configure/setup-b2b.md b/guides/v2.2/cloud/configure/setup-b2b.md
index 9beba9aee23..9ae8dac880b 100644
--- a/guides/v2.2/cloud/configure/setup-b2b.md
+++ b/guides/v2.2/cloud/configure/setup-b2b.md
@@ -43,14 +43,14 @@ You need to add the module to `composer.json`. All extensions and modules must b
composer update
- You may be prompted to enter your Magento Authentication keys (public and private). If copying and pasting your keys, make sure no additional spaces are included. Spaces could cause the following error:
+ You may be prompted to enter your Magento Authentication keys (public and private). If copying and pasting your keys, do not introduce additional spaces. Spaces could cause the following error:
InvalidArgumentException - Could not find package magento/extension-b2b at any version for your minimum-stability (stable). Check the package spelling or your minimum-stability.
5. Add the new B2B files to Git:
git add setup dev pub lib && git commit -a -m "b2b"
-5. Enable all missing modules,including B2B, for updating.
+5. Enable all missing modules, including B2B, for updating.
./vendor/bin/ece-tools module:refresh
diff --git a/guides/v2.2/cloud/env/variables-deploy.md b/guides/v2.2/cloud/env/variables-deploy.md
index 322557d4b8e..cb4459dafbe 100644
--- a/guides/v2.2/cloud/env/variables-deploy.md
+++ b/guides/v2.2/cloud/env/variables-deploy.md
@@ -77,7 +77,7 @@ deploy updates to existing files without removing the previous versions. Because
- **Default**—`cron_run = false`, `max_messages = 1000`
- **Version**—Magento 2.2.0 and later
-Use this environment variable to make sure message queues are running after a deployment.
+Use this environment variable to confirm message queues are running after a deployment.
- `cron_run`—A boolean value that enables or disables the `consumers_runner` cron job (default = `false`).
- `max_messages`—A number specifying the maximum number of messages each consumer must process before terminating (default = `1000`). Although we do not recommend it, you can use `0` to prevent the consumer from terminating.
diff --git a/guides/v2.2/cloud/howtos/install-components.md b/guides/v2.2/cloud/howtos/install-components.md
index 1f341e2dbb6..82ec1dc2a6e 100644
--- a/guides/v2.2/cloud/howtos/install-components.md
+++ b/guides/v2.2/cloud/howtos/install-components.md
@@ -80,7 +80,7 @@ When installing and adding the module, you must add the `composer.lock` to your
### Step 3: Verify the extension {#verify}
-To verify the extension installed properly, you can check its functionality in the Magento Admin or you can make sure it is enabled as follows:
+To verify the extension installed properly, you can check its functionality in the Magento Admin or you can view enabled modules using the CLI:
1. Open a terminal.
1. [Checkout the branch]({{ page.baseurl }}/cloud/before/before-setup-env-2_clone.html#branch) where the module is installed.
@@ -135,7 +135,7 @@ Trying to enable and disable extensions not following this method can lead to pe
### Modify configurations {#configure}
-You will update configurations according to [Configuration Management]({{ site.baseurl }}/guides/v2.2/cloud/live/sens-data-over.html#cloud-clp-settings) for `config.php`.
+You update configurations according to [Configuration Management]({{ site.baseurl }}/guides/v2.2/cloud/live/sens-data-over.html#cloud-clp-settings) for `config.php`.
## Upgrade an extension {#update}
diff --git a/guides/v2.2/cloud/live/paypal-onboarding.md b/guides/v2.2/cloud/live/paypal-onboarding.md
index 3df7d604d9e..7ba6ef162ee 100644
--- a/guides/v2.2/cloud/live/paypal-onboarding.md
+++ b/guides/v2.2/cloud/live/paypal-onboarding.md
@@ -29,7 +29,7 @@ PayPal on-boarding supports connecting with the following accounts:
If you do not have an existing PayPal account, you have an option to create a new one. Enter an e-mail address for a new account. If a matching PayPal account is not found, you will be prompted to create a new PayPal Business account. Or you can create an account directly through [PayPal](https://www.paypal.com/us/webapps/mpp/account-selection).
-Please note the [PayPal account limitations](#limitations) for further information.
+See [PayPal account limitations](#limitations) for further information.
{:width="336px"}
@@ -40,7 +40,7 @@ PayPal supports connecting PayPal Express Checkout for countries across the glob
* India, and Japan (future PayPal updates may support these accounts)
* Israel
-For Brazil, you must have an existing PayPal business account to connect. You cannot convert an existing personal PayPal account for Brazil during this process. If you need an account, please create a new business PayPal account through [their website](https://www.paypal.com/us/webapps/mpp/account-selection).
+For Brazil, you must have an existing PayPal business account to connect. You cannot convert an existing personal PayPal account for Brazil during this process. If you need an account, create a new business PayPal account through [their website](https://www.paypal.com/us/webapps/mpp/account-selection).
## Configure PayPal Express Checkout
diff --git a/guides/v2.2/cloud/project/project-conf-files_magento-app.md b/guides/v2.2/cloud/project/project-conf-files_magento-app.md
index 7bfafe9286d..8209779ceba 100644
--- a/guides/v2.2/cloud/project/project-conf-files_magento-app.md
+++ b/guides/v2.2/cloud/project/project-conf-files_magento-app.md
@@ -12,7 +12,7 @@ functional_areas:
The `.magento.app.yaml` file controls the way your application builds and deploys. Although {{site.data.var.ece}} supports multiple applications per project, typically, a project has a single application with the `.magento.app.yaml` file at the root of the repository.
-The `.magento.app.yaml` has many default values, see [a sample `.magento.app.yaml` file](https://github.com/magento/magento-cloud/blob/master/.magento.app.yaml). Make sure to review the `.magento.app.yaml` for your installed version. This file can differ across {{site.data.var.ece}} versions.
+The `.magento.app.yaml` has many default values, see [a sample `.magento.app.yaml` file](https://github.com/magento/magento-cloud/blob/master/.magento.app.yaml). Always review the `.magento.app.yaml` for your installed version. This file can differ across {{site.data.var.ece}} versions.
{% include cloud/note-pro-using-yaml.md %}
@@ -189,7 +189,7 @@ nodejs:
### `hooks`
Use the `hooks` section to run shell commands during the build, deploy, and post-deploy phases:
-- **`build`**—Execute commands _before_ packaging your application. Services, such as the database or Redis, are not available at this time since the application has not been deployed yet. You must add custom commands _before_ the default `php ./vendor/bin/ece-tools` command to make sure custom-generated content makes it to the deployment phase.
+- **`build`**—Execute commands _before_ packaging your application. Services, such as the database or Redis, are not available at this time since the application has not been deployed yet. You must add custom commands _before_ the default `php ./vendor/bin/ece-tools` command so that custom-generated content continues to the deployment phase.
- **`deploy`**—Execute commands _after_ packaging and deploying your application. You can access other services at this point. Since the default `php ./vendor/bin/ece-tools` command copies the `app/etc` directory to the correct location, you must add custom commands _after_ the deploy command to prevent custom commands from failing.
- **`post_deploy`**—Execute commands _after_ deploying your application and _after_ the container begins accepting connections. The `post_deploy` hook clears the cache and preloads (warms) the cache. You can customize the list of pages using the `WARM_UP_PAGES` variable in the [Post-deploy stage]({{ site.baseurl }}/guides/v2.1/cloud/env/variables-post-deploy.html). It is available only for Pro projects that contain [Staging and Production environments in the Project Web UI]({{ page.baseurl }}/cloud/trouble/pro-env-management.html) and for Starter projects. Although not required, this works in tandem with the `SCD_ON_DEMAND` environment variable.
diff --git a/guides/v2.2/cloud/project/project-upgrade.md b/guides/v2.2/cloud/project/project-upgrade.md
index ed0de952eee..8f77410d913 100644
--- a/guides/v2.2/cloud/project/project-upgrade.md
+++ b/guides/v2.2/cloud/project/project-upgrade.md
@@ -22,7 +22,7 @@ Prepare your environment with the following tasks:
{% include cloud/note-ece-tools-package.md %}
### Upgrade PHP version
-{{site.data.var.ece}} 2.2 supports PHP 7.1 and later. Make sure to upgrade the version of PHP on your local development workspace as well. For more information, see the following:
+{{site.data.var.ece}} 2.2 supports PHP 7.1 and later. You can upgrade the version of PHP on your local development workspace.
* [PHP]({{ site.baseurl }}/guides/v2.2/cloud/before/before-workspace-magento-prereqs.html#php) information for your local Magento workstation
* [Migrating PHP](http://php.net/manual/en/migration71.php)
diff --git a/guides/v2.2/cloud/release-notes/CloudReleaseNotes2.2.1.md b/guides/v2.2/cloud/release-notes/CloudReleaseNotes2.2.1.md
index ce5fd4026d6..e5debd24933 100644
--- a/guides/v2.2/cloud/release-notes/CloudReleaseNotes2.2.1.md
+++ b/guides/v2.2/cloud/release-notes/CloudReleaseNotes2.2.1.md
@@ -77,7 +77,7 @@ For all known {{site.data.var.ee}} 2.2.1 issues, see [Magento Commerce 2.2.1 Re
//...
-* The `ADMIN_EMAIL` variable must be set for new and existing projects. We require that you configure the `ADMIN_EMAIL` environment variable for deployments, including new installations and upgrades. You can set this variable through the Project Web Interface. For instructions, see [Change the Magento Admin URL, username, and password on master]({{ site.baseurl }}/guides/v2.2/cloud/before/before-setup-env-2_clone.html#setvariables).
+* The `ADMIN_EMAIL` variable must be set for new and existing projects. We require that you configure the `ADMIN_EMAIL` environment variable for deployments, including new installations and upgrades. You can set this variable through the Project Web Interface. For instructions, see [Change the Magento Admin URL, username, and password on master]({{ site.baseurl }}/guides/v2.2/cloud/before/before-setup-env-2_clone.html).
## Community contributions {#community}
diff --git a/guides/v2.2/cloud/release-notes/cloud-release-archive.md b/guides/v2.2/cloud/release-notes/cloud-release-archive.md
index 8f8958c3299..687e73b64a1 100644
--- a/guides/v2.2/cloud/release-notes/cloud-release-archive.md
+++ b/guides/v2.2/cloud/release-notes/cloud-release-archive.md
@@ -82,7 +82,7 @@ We merged [`vendor/magento/ece-patches`]({{ site.baseurl }}/guides/v2.2/cloud/co
- [Static content deployment performance]({{ site.baseurl }}/guides/v2.2/cloud/live/sens-data-over.html#cloud-confman-scd-over)
- [Deployment process]({{ site.baseurl }}/guides/v2.2/cloud/reference/discover-deploy.html)
-- **Configuration management**—We now auto-generate an `app/etc/config.php` file in your Git repository during the build phase if it doesn't already exist. The auto-generated file includes only a list of modules and extensions. If the file already exists, the build phase continues as normal. If you follow [Configuration Management]({{ site.baseurl }}/guides/v2.2/cloud/live/sens-data-over.html) at a later time, the commands update the file without requiring additional steps. Refer to [Deployment process]({{ site.baseurl }}/guides/v2.2/cloud/reference/discover-deploy.html) for more information.
+- **Configuration management**—We now auto-generate an `app/etc/config.php` file in your Git repository during the build phase if it does not already exist. The auto-generated file includes only a list of modules and extensions. If the file already exists, the build phase continues as normal. If you follow [Configuration Management]({{ site.baseurl }}/guides/v2.2/cloud/live/sens-data-over.html) at a later time, the commands update the file without requiring additional steps. Refer to [Deployment process]({{ site.baseurl }}/guides/v2.2/cloud/reference/discover-deploy.html) for more information.
- **Database dumps**—We added a `magento/ece-tools` CLI command for creating database dumps in all environments. For Pro plan Production environments, this command only dumps from one of three high-availability nodes, so production data written to a different node during the dump may not be copied. We recommend putting the application in maintenance mode before doing a database dump in Production environments. See [Snapshots and backup management]({{ site.baseurl }}/guides/v2.2/cloud/project/project-webint-snap.html#db-dump) for more information.
diff --git a/guides/v2.2/install-gde/prereq/nginx.md b/guides/v2.2/install-gde/prereq/nginx.md
index 4063fb68f88..ffd84d80bbc 100644
--- a/guides/v2.2/install-gde/prereq/nginx.md
+++ b/guides/v2.2/install-gde/prereq/nginx.md
@@ -118,7 +118,7 @@ You cannot use the Web Setup Wizard when installing Magento on nginx. You must u
cd /var/www/html/
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
- chown -R :www-data . // Ubuntu
+ chown -R :www-data . # Ubuntu
chmod u+x bin/magento
```
diff --git a/guides/v2.3/install-gde/composer.md b/guides/v2.3/install-gde/composer.md
index e7647e0d8b9..e684b258cbd 100644
--- a/guides/v2.3/install-gde/composer.md
+++ b/guides/v2.3/install-gde/composer.md
@@ -65,7 +65,7 @@ You must set read-write permissions for the web server group before you install
cd /var/www/html/
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
-chown -R :www-data . // Ubuntu
+chown -R :www-data . # Ubuntu
chmod u+x bin/magento
```
diff --git a/guides/v2.3/install-gde/prereq/nginx.md b/guides/v2.3/install-gde/prereq/nginx.md
index 36b44fdc5aa..52d1527734b 100644
--- a/guides/v2.3/install-gde/prereq/nginx.md
+++ b/guides/v2.3/install-gde/prereq/nginx.md
@@ -115,7 +115,7 @@ You cannot use the Web Setup Wizard when installing Magento on nginx. You must u
cd /var/www/html/
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
- chown -R :www-data . // Ubuntu
+ chown -R :www-data . # Ubuntu
chmod u+x bin/magento
```
@@ -324,7 +324,7 @@ You cannot use the Web Setup Wizard when installing Magento on nginx. You must u
cd /var/www/html/
find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
- chown -R :www-data . // Ubuntu
+ chown -R :www-data . # Ubuntu
chmod u+x bin/magento
```
diff --git a/guides/v2.3/install-gde/system-requirements-tech.md b/guides/v2.3/install-gde/system-requirements-tech.md
index b62e4cd666e..a00a226e504 100644
--- a/guides/v2.3/install-gde/system-requirements-tech.md
+++ b/guides/v2.3/install-gde/system-requirements-tech.md
@@ -62,7 +62,7 @@ The [PHP installation instructions](prereq/php-centos-ubuntu.html) include a ste
* [spl](http://php.net/manual/en/book.spl.php){:target="_blank"}
* [libxml](http://php.net/manual/en/book.libxml.php){:target="_blank"}
* [xsl](http://php.net/manual/en/book.xsl.php){:target="_blank"}
-* [azip](http://php.net/manual/en/book.zip.php){:target="_blank"}
+* [zip](http://php.net/manual/en/book.zip.php){:target="_blank"}
* [json](http://php.net/manual/en/book.json.php){:target="_blank"}
* [iconv](http://php.net/manual/en/book.iconv.php){:target="_blank"}
diff --git a/guides/v2.3/test/integration/integration_test_execution.md b/guides/v2.3/test/integration/integration_test_execution.md
index 20b1414aa9b..e6bdecc4cc0 100644
--- a/guides/v2.3/test/integration/integration_test_execution.md
+++ b/guides/v2.3/test/integration/integration_test_execution.md
@@ -266,7 +266,7 @@ This happens if the integration tests are executed from the wrong directory.
#### Could not read "dev/tests/integration/phpunit.xml"
This error happens if the integration tests are executed from a different directory than `dev/tests/integration`.
-To fix the issue, change to the `dev/tests/integration` directory, adjust any relative paths accoridngly, and run the tests again.
+To fix the issue, change to the `dev/tests/integration` directory, adjust any relative paths accordingly, and run the tests again.
#### Unable to connect to MySQL
diff --git a/mftf/2.3/best-practices.md b/mftf/2.3/best-practices.md
index 0bd38ec0fce..013c5e7beed 100644
--- a/mftf/2.3/best-practices.md
+++ b/mftf/2.3/best-practices.md
@@ -5,15 +5,15 @@ redirect_from: /guides/v2.3/magento-functional-testing-framework/2.3/best-practi
# Best practices
-_This topic was updated due to the {{page.mftf-release}} MFTF release._
+_This topic was updated due to the {{ page.mftf-release }} MFTF release._
{: style="text-align: right"}
-Check out our best practices below to ensure you're getting the absolute most out of the Magento Functional Testing Framework.
+Check out our best practices below to ensure you are getting the absolute most out of the Magento Functional Testing Framework.
## Action group
1. [Action group] names should be sufficiently descriptive to inform a test writer of what the action group does and when it should be used.
- Add additional explanation in comments if needed.
+ Add additional explanation in comments if needed.
2. Provide default values for the arguments that apply to your most common case scenarios.
## `actionGroups` vs `extends`
@@ -33,17 +33,19 @@ Use `extends` in your new test or action group when at least one of the followin
### When to avoid `extends`
Do not use `extends` in the following conditions:
+
1. You want to change the functionality of the test or action group and do not need to run the original version.
2. You plan to merge the base test or action group.
The following pattern is used when merging with `extends`:
+
1. The original test is merged.
2. The extended test is created from the merged original test.
3. The extended test is merged.
## Annotation
-1. Use [annotations] in a test.
+1. Use [annotations] in a test.
2. Update your annotations correspondingly when updating tests.
## Data entity
@@ -52,16 +54,16 @@ The following pattern is used when merging with `extends`:
Remove data after the test if the test required creating any data.
Use a corresponding [``] test step in your [``] block when using a [``] action in a [``] block.
2. Make specific data entries under test to be unique.
- Enable data uniqueness where data values are required to be unique in a database by test design.
+ Enable data uniqueness where data values are required to be unique in a database by test design.
Use `unique=”suffix”` or `unique=”prefix”` to append or prepend a unique value to the [entity] attribute.
This ensures that tests using the entity can be repeated.
3. Do not modify existing data entity fields or merge additional data fields without complete understanding and verifying the usage of existing data in tests.
Create a new data entity for your test if you are not sure.
-
+
## Naming conventions
-
+
### File names
-
+
Name files according to the following patterns to make searching in future more easy:
#### Test file name
@@ -69,39 +71,41 @@ Name files according to the following patterns to make searching in future more
Format: {_Admin_ or _Storefront_}{Functionality}_Test.xml_, where Functionality briefly describes the testing functionality.
Example: _StorefrontCreateCustomerTest.xml_.
-
+
#### Section file name
-
+
Format: {_Admin_ or _Storefront_}{UI Description}_Section.xml_, where UI Description briefly describes the testing UI.
-
+
Example: _AdminNavbarSection.xml_.
-
+
#### Data file name
-
+
Format: {Type}_Data.xml_, where Type represents the entity type.
-
+
Example: _ProductData.xml_.
-
+
### Object names
-
+
Use the _Foo.camelCase_ naming convention, which is similar to _Classes_ and _classProperties_ in PHP.
-
+
#### Upper case
-
+
Use an upper case first letter for:
- - File names. Example: _StorefrontCreateCustomerTest.xml_
- - Test name attributes. Example: ``.
- - Data entity names. Example: ``.
- - Page name. Example: ``.
- - Section name. Example: ``.
- - Action group name. Example: ``.
-
+
+- File names. Example: _StorefrontCreateCustomerTest.xml_
+- Test name attributes. Example: ``.
+- Data entity names. Example: ``.
+- Page name. Example: ``.
+- Section name. Example: ``.
+- Action group name. Example: ``.
+
#### Lower case
-
+
Use a lower case first letter for:
- - Data keys. Example: ``.
- - Element names. Examples: ``.
-
+
+- Data keys. Example: ``.
+- Element names. Examples: ``.
+
## Page object
Use [parameterized selectors] for constructing a selector when test specific or runtime generated information is needed.
@@ -109,6 +113,7 @@ Do not use them for static elements.
{:style="color:red"}
BAD:
+
``` xml
```
@@ -117,6 +122,7 @@ BAD:
GOOD:
Define these three elements and reference them by name in the tests.
+
``` xml
@@ -127,13 +133,13 @@ Define these three elements and reference them by name in the tests.
1. Use actions such as [``], [``], and [``] to wait the exact time required for the test step.
Try to avoid using the [``] action, because it forces the test to wait for the time you specify. You may not need to wait so long to proceed.
-2. Keep your tests short and granular for target testing, easier reviews, and easier merge conflict resolution.
+1. Keep your tests short and granular for target testing, easier reviews, and easier merge conflict resolution.
It also helps you to identify the cause of test failure.
-3. Use comments to keep tests readable and maintainable:
- * Keep the inline `` and [``] tags up to date.
- It helps to inform the reader of what you are testing and to yield a more descriptive Allure report.
- * Explain in comments unclear or tricky test steps.
-4. Refer to [sections] instead of writing selectors.
+1. Use comments to keep tests readable and maintainable:
+ - Keep the inline `` and [``] tags up to date.
+ It helps to inform the reader of what you are testing and to yield a more descriptive Allure report.
+ - Explain in comments unclear or tricky test steps.
+1. Refer to [sections] instead of writing selectors.
## Test step merging order