Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 0327977

Browse files
authored
Merge branch 'master' into kh_tech-vision
2 parents 4de91aa + c4fade1 commit 0327977

34 files changed

+254
-100
lines changed

_videos/fundamentals/add-a-javascript-module.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,8 @@ Finally, let’s add our module and test the result.
173173

174174
```
175175
$ cd <magento2_root>
176-
$ php bin/magento setup:upgrade
176+
$ bin/magento setup:upgrade
177+
$ bin/magento cache:clean
177178
```
178179

179180
Now we’ll go to any product view page, and we should see the “HELLO WORLD!” message.

guides/v2.1/comp-mgr/cli/cli-upgrade.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,14 @@ To enable maintenance mode:
7979
composer update
8080
```
8181

82-
3. If prompted, enter your [authentication keys]({{ page.baseurl }}/comp-mgr/prereq/prereq_auth-token.html).
82+
4. If prompted, enter your [authentication keys]({{ page.baseurl }}/comp-mgr/prereq/prereq_auth-token.html).
83+
84+
5. Clean the Magento cache:
85+
86+
```bash
87+
bin/magento cache:clean
88+
```
89+
8390
4. Manually clear `var` subdirectories:
8491

8592
```bash

guides/v2.1/comp-mgr/install-extensions.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you already know the extension's Composer name and version, skip this step an
2626

2727
To get the extension's Composer name and version from the Magento Marketplace:
2828

29-
1. Log in to [Magento Marketplace](https://marketplace.magento.com){:target="_blank"} with the username and password you used to purchase the extension.
29+
1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the extension.
3030

3131
2. In the upper-right corner, click **Your name** > **My Profile**.
3232

@@ -66,7 +66,9 @@ Add the extension's name and version to your `composer.json` file:
6666

6767
To verify that the extension installed properly, run the following command:
6868

69-
bin/magento module:status
69+
```bash
70+
bin/magento module:status
71+
```
7072

7173
By default, the extension is probably disabled:
7274

@@ -100,8 +102,8 @@ Some extensions won't work properly unless you clear Magento-generated static vi
100102

101103
3. Recompile your Magento project:
102104

103-
{: .bs-callout .bs-callout-info }
104-
In Production mode, you may receive a message to 'Please rerun Magento compile command'. Enter the command below. Magento does not prompt you to run the compile command in Developer mode.
105+
{: .bs-callout .bs-callout-info }
106+
In Production mode, you may receive a message to 'Please rerun Magento compile command'. Enter the command below. Magento does not prompt you to run the compile command in Developer mode.
105107

106108
bin/magento setup:di:compile
107109

@@ -117,7 +119,13 @@ In Production mode, you may receive a message to 'Please rerun Magento compile c
117119
List of disabled modules:
118120
None
119121

120-
5. Configure the extension in Admin as needed.
122+
5. Clean the cache:
123+
124+
```bash
125+
bin/magento cache:clean
126+
```
127+
128+
6. Configure the extension in Admin as needed.
121129

122130
{:.bs-callout .bs-callout-tip}
123131
If you encounter errors when loading the storefront in a browser, use the following command to clear the cache:

guides/v2.1/comp-mgr/module-man/compman-new-purchase.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ When you're installing new purchases from Magento Marketplace, the page displays
1616

1717
![]({{ site.baseurl }}/common/images/compman_new-purchases-step3install.png){: width="500px"}
1818

19+
## Install the component
1920

2021
If the list of purchases is correct, click **Install**.
2122

@@ -78,3 +79,11 @@ When the installation is complete, a page similar to the following displays:
7879

7980

8081
Click **Back to Setup Tool**.
82+
83+
## Clean the cache
84+
85+
Clean the cache by clicking **System** > **Cache Management** > **Flush Magento Cache** or by entering the following command:
86+
87+
```bash
88+
bin/magento cache:clean
89+
```

guides/v2.1/comp-mgr/module-man/compman-update.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This step displays if you're updating components. The following figure shows an
1616

1717
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="{{ site.baseurl }}/common/images/cman_update-step.png" width="350px" alt="Click update to complete the task">
1818

19-
To complete the update, click **Update**.
19+
To complete the update, click **Update**.
2020

2121
### Success
2222

@@ -42,11 +42,15 @@ Messages similar to the following display in the Console Log:
4242
[2015-07-31 19:42:05 CDT] Composer update completed successfully
4343
[2015-07-31 19:42:05 CDT] Job "update {"require":[{"name":"magento/sample-module-updater-wizard","version":"3.0.0.0"}]}" has successfully completed
4444

45-
### Failure
4645

47-
If the update fails, click **Rollback** to restore an earlier backup. Messages display in the Console Log as shown in the following figure.
46+
Clean the cache by clicking **System** > **Cache Management** > **Flush Magento Cache** or by entering the following command:
4847

49-
![If the component update fails, you can roll back]({{ site.baseurl }}/common/images/cman_update-fail.png)
48+
```bash
49+
bin/magento cache:clean
50+
```
5051

52+
### Failure
5153

54+
If the update fails, click **Rollback** to restore an earlier backup. Messages display in the Console Log as shown in the following figure.
5255

56+
![If the component update fails, you can roll back]({{ site.baseurl }}/common/images/cman_update-fail.png)

guides/v2.1/comp-mgr/upgrader/ce-ee-upgrade-start.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ You must be authorized for {{site.data.var.ee}} to perform the tasks discussed i
2020

2121
Before continuing, complete all tasks discussed in [Prerequisites]({{ page.baseurl }}/comp-mgr/prereq/prereq_compman.html).
2222

23-
In addition, you might need to install the {% glossarytooltip bf703ab1-ca4b-48f9-b2b7-16a81fd46e02 %}PHP{% endglossarytooltip %} [`bcmath`](http://php.net/manual/en/book.bc.php){:target="_blank"} extension, which is required by {{site.data.var.ee}}. Examples follow:
23+
In addition, you might need to install the {% glossarytooltip bf703ab1-ca4b-48f9-b2b7-16a81fd46e02 %}PHP{% endglossarytooltip %} [`bcmath`](http://php.net/manual/en/book.bc.php) extension, which is required by {{site.data.var.ee}}. Examples follow:
2424

2525
* CentOS (using the `webtatic` repository): `yum -y install php56w-bcmath`
2626
* Ubuntu (using the `ppa:ondrej/php5-5.6` repository): `apt-get -y install php5-bcmath`
2727

2828
{:.bs-callout .bs-callout-info}
29-
Make sure you are authorized for {{site.data.var.ee}} access before you continue. Contact [Magento Support](http://support.magentocommerce.com){:target="_blank"} if you have questions.
29+
Make sure you are authorized for {{site.data.var.ee}} access before you continue. Contact [Magento Support](http://support.magentocommerce.com) if you have questions.
3030

3131
## Start System Upgrade from the Magento Admin {#compman-access}
3232

@@ -47,9 +47,19 @@ To run System Upgrade:
4747

4848
From the list, click the version to which to upgrade. Typically, you'll choose the most recent version (indicated by **(latest)**.)
4949

50-
After the upgrade completes, restart Varnish if you use it for page caching.
50+
After the upgrade completes:
5151

52-
service varnish restart
52+
1. Clean the cache by clicking **System** > **Cache Management** > **Flush Magento Cache** or by entering the following command:
53+
54+
```bash
55+
bin/magento cache:clean
56+
```
57+
58+
2. Restart Varnish if you use it for page caching.
59+
60+
```bash
61+
service varnish restart
62+
```
5363
5464
#### Errors
5565
@@ -61,9 +71,9 @@ After the upgrade completes, restart Varnish if you use it for page caching.
6171
6272
* The following error might display:
6373
64-
[2016-01-19 23:33:24 UTC] An error occurred while executing job
65-
"setup:upgrade {"command":"setup:upgrade"}": Could not complete
66-
setup:upgrade {"command":"setup:upgrade"} successfully: Source
74+
[2016-01-19 23:33:24 UTC] An error occurred while executing job
75+
"setup:upgrade {"command":"setup:upgrade"}": Could not complete
76+
setup:upgrade {"command":"setup:upgrade"} successfully: Source
6777
class "\Cybersource" for "CybersourceLogger" generation does not exist.
6878
6979
For more information, see [Error upgrading from CE to EE]({{ page.baseurl }}/comp-mgr/trouble/cman/ce-ee-upgrade.html).

guides/v2.1/comp-mgr/upgrader/upgrade.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,21 @@ Messages similar to the following display in the Console Log:
2929

3030
{% endcollapsible %}
3131

32+
## Clean the Magento cache
33+
34+
Clean the Magento cache:
35+
36+
```bash
37+
bin/magento cache:clean
38+
```
39+
3240
## Manually clear directories
3341

3442
After the upgrade completes, manually clear `var` subdirectories:
3543

3644
rm -rf <Magento install dir>/var/cache/*
3745
rm -rf <Magento install dir>/var/page_cache/*
38-
rm -rf <Magento install dir>/var/generation/*
46+
rm -rf <Magento install dir>/var/generation/*
3947

4048
## Restart Varnish
4149

@@ -55,7 +63,7 @@ After you finish your upgrade, errors might display.
5563
* On a {% glossarytooltip 50e49338-1e6c-4473-8527-9e401d67ea2b %}category{% endglossarytooltip %} page, the following error might display:
5664

5765
We can't find products matching the selection.
58-
66+
5967
If any of the preceding errors display, perform all of the following tasks.
6068

6169
{% include install/sampledata/file-sys-perms-digest.md %}

guides/v2.1/config-guide/cli/config-cli-subcommands-cache.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ To purge out-of-date items from the cache, you can *clean* or *flush* cache type
8585

8686
Disabled cache types are not cleaned.
8787

88+
{:.bs-callout .bs-callout-tip}
89+
Always clean the cache after upgrading versions of {{site.data.var.ce}} or {{site.data.var.ee}}, upgrading from {{site.data.var.ce}} to {{site.data.var.ee}}, or installing {{site.data.var.b2b}} or any module.
90+
8891
- Flushing a cache type purges the cache storage, which might affect other processes applications that are using the same storage.
8992

9093
Flush cache types if you've already tried cleaning the cache and you're still having issues that you cannot isolate.

guides/v2.1/config-guide/cron/custom-cron-tut.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,14 @@ If you already have a sample module, you can use it; skip this step and the next
6060
drwxrwsr-x. 3 magento_user apache 4096 Oct 30 13:19 Test
6161
6. Update the Magento database and schema:
6262

63-
php /var/www/html/magento2/bin/magento setup:upgrade
63+
```bash
64+
bin/magento setup:upgrade
65+
```
66+
67+
7. Clean the cache:
68+
```
69+
bin/magento cache:clean
70+
```
6471
6572
{% endcollapsible %}
6673

guides/v2.1/ext-best-practices/extension-coding/example-module-adminpage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ Now that the module is code-complete, run the following commands to install it:
298298
2. `bin/magento module:enable MyCompany_ExampleAdminNewPage` - If necessary, run this to enable the disabled module.
299299
3. `bin/magento setup:upgrade` - This command will properly register the module with Magento.
300300
4. `bin/magento setup:di:compile` - This command compiles classes used in dependency injections.
301+
5. `bin/magento cache:clean` - This command cleans the cache.
301302

302303
Once the module installation has completed, the link to the **Hello World** page should appear in the **Greetings** section under **Content** in the left navigation in the admin area. Clicking this link will take you to a page that looks like the one pictured below.
303304

guides/v2.1/extension-dev-guide/build/enable-module.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ After you have built the component and are ready to enable it in your Magento en
1515
``` bash
1616
bin/magento module:enable --clear-static-content Component_Name
1717
bin/magento setup:upgrade
18+
bin/magento cache:clean
1819
```
1920

2021
Where `Component_Name` is the name of the component you are enabling.

guides/v2.1/frontend-dev-guide/themes/admin_theme_apply.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ functional_areas:
99

1010
This topic describes how to apply your custom {% glossarytooltip d2093e4a-2b71-48a3-99b7-b32af7158019 %}theme{% endglossarytooltip %} for {% glossarytooltip 18b930cf-09cc-47c9-a5e5-905f86c43f81 %}Magento Admin{% endglossarytooltip %}.
1111

12-
## Prerequisites
12+
## Prerequisites
1313

14-
1. [Set]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-mode.html) your Magento application to the developer [mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html). The application mode influences the way {% glossarytooltip 363662cb-73f1-4347-a15e-2d2adabeb0c2 %}static files{% endglossarytooltip %} are cached by Magento.
15-
2. [Create a custom theme for the Admin panel]({{ page.baseurl }}/frontend-dev-guide/themes/admin_theme_create.html).
14+
1. [Set]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-mode.html) your Magento application to the developer [mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html). The application mode influences the way {% glossarytooltip 363662cb-73f1-4347-a15e-2d2adabeb0c2 %}static files{% endglossarytooltip %} are cached by Magento.
15+
2. [Create a custom theme for the Admin panel]({{ page.baseurl }}/frontend-dev-guide/themes/admin_theme_create.html).
1616
3. [Add a new custom module]({{ page.baseurl }}/extension-dev-guide/build/build.html) or decide to use existing custom module. The module must load after the Magento_Theme module. To ensure this, add the following code in `<your_custom_module_dir>/etc/module.xml` (replace placeholders with your {% glossarytooltip c1e4242b-1f1a-44c3-9d72-1d5b1435e142 %}module{% endglossarytooltip %} information):
1717

1818
```xml
@@ -54,16 +54,16 @@ In `<your_module_dir>/etc/adminhtml/di.xml` add the following (replace the place
5454
<argument name="themes" xsi:type="array">
5555
<item name="adminhtml" xsi:type="string">%Your_vendor_dir%/%your_theme_code%</item> <!-- Example: "Magento/backend" -->
5656
</argument>
57-
</arguments>
57+
</arguments>
5858
</type>
5959
<!-- Admin theme. End -->
6060
</config>
6161
```
6262

63-
## Update components to actually apply the Admin theme
63+
## Update components to apply the Admin theme
6464

65-
For your changes to take effect, you need to update Magento components. For this,
66-
run the `bin/magento setup:upgrade` command in your command line. If prompted, also run `bin/magento setup:di:compile`.
65+
For your changes to take effect, you need to update Magento components. For this,
66+
run the `bin/magento setup:upgrade` command in your command line. If prompted, also run `bin/magento setup:di:compile`. Then run `bin/magento cache:clean` to clear the cache.
6767

6868

6969
For details about performing command line tasks, view the following topics:
@@ -77,6 +77,3 @@ The last step is to open the Admin in browser and view the new theme applied.
7777
## See also
7878

7979
* [Uninstall a theme]({{ page.baseurl }}/install-gde/install/cli/install-cli-theme-uninstall.html)
80-
81-
82-

guides/v2.1/get-started/create-integration.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,10 +241,14 @@ Use the following steps to install your module:
241241
242242
2. Run the following command to generate the new code.
243243
244-
{: .bs-callout .bs-callout-info }
245-
In Production mode, you may receive a message to 'Please rerun Magento compile command'. Enter the command below. Magento does not prompt you to run the compile command in Developer mode.
244+
{: .bs-callout .bs-callout-info }
245+
In Production mode, you may receive a message to 'Please rerun Magento compile command'. Enter the command below. Magento does not prompt you to run the compile command in Developer mode.
246246
247-
<code>bin/magento setup:di:compile</code>
247+
<code>bin/magento setup:di:compile</code>
248+
249+
3. Run the following command to clean the cache.
250+
251+
<code>bin/magento cache:clean</code>
248252
249253
## Check your integration {#check}
250254

guides/v2.1/install-gde/install/cli/dev_update-magento.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,8 @@ To update the Magento software if you're a contributing developer:
3636

3737
5. Update the Magento database:
3838

39-
php <your Magento install dir>/bin/magento setup:upgrade
39+
<your Magento install dir>/bin/magento setup:upgrade
40+
41+
6. Clean the cache:
42+
43+
bin/magento cache:clean

guides/v2.1/install-gde/install/cli/install-cli-subcommands-db-upgr.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,16 @@ Note the following:
2828
* If you used the Web Setup Wizard to do any of the preceding, you don't have to use the command discussed in this topic.
2929
* A Magento *component* can be a module, theme, or language pack; it doesn't matter whether the component comes from the Magento Marketplace or not
3030

31-
Command usage:
31+
1. Start the upgrade:
3232

33-
magento setup:upgrade [--keep-generated]
33+
```bash
34+
magento setup:upgrade [--keep-generated]
35+
```
3436
35-
where `--keep-generated` is an optional argument that does not update [static view files]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-static-view.html). This optional argument is for use *only* in limited circumstances by experienced system integrators. It should be used *only* in [production mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#production-mode). It should *not* be used in [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#developer-mode).
37+
where `--keep-generated` is an optional argument that does not update [static view files]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-static-view.html). This optional argument is for use *only* in limited circumstances by experienced system integrators. It should be used *only* in [production mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#production-mode). It should *not* be used in [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#developer-mode).
38+
39+
2. Clean the cache:
40+
41+
```bash
42+
bin/magento cache:clean
43+
```

guides/v2.1/install-gde/install/cli/install-cli-subcommands-enable.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,15 @@ For important information about enabling and disabling modules, see [About enabl
4949

5050
If you enabled one or more modules, run the following command to update the database:
5151

52-
magento setup:upgrade
52+
```bash
53+
bin/magento setup:upgrade
54+
```
55+
56+
Then clean the cache:
57+
58+
```bash
59+
bin/magento cache:clean
60+
```
5361

5462
## About enabling and disabling modules {#instgde-cli-subcommands-enable-modules}
5563
{% include install/enable-disable-modules.md %}

guides/v2.1/security/google-recaptcha.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,13 @@ composer require msp/recaptcha:2.0.0
2626
To complete installation in an existing Magento instance, run the following commands to enable the module:
2727

2828
``` bash
29-
php bin/magento module:enable --all
30-
php bin/magento setup:upgrade
29+
bin/magento module:enable --all
30+
```
31+
``` bash
32+
bin/magento setup:upgrade
33+
```
34+
```bash
35+
bin/magento cache:clean
3136
```
3237

3338
## Configure reCAPTCHA

0 commit comments

Comments
 (0)