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

Small changes #4533

Merged
merged 35 commits into from
May 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
1116486
Added number for Cron section
buskamuza May 10, 2019
239fae8
Fixed notes formatting in kramdown attributes
dshevtsov May 10, 2019
57e1c2b
Fix formatting
dshevtsov May 10, 2019
0580f8c
Format the XML code block
yogeshsuhagiya May 11, 2019
3f5956a
Updated lock config and lock env short commands
May 11, 2019
7df58fc
Updated lock config and lock env short commands
May 11, 2019
cf60d32
added missing php tags
gaurav-473 May 12, 2019
8d13455
Removing extra spaces
rogyar May 12, 2019
b2d9ae7
Merge branch 'master' into masterPr1
dobooth May 13, 2019
f551c43
Merge pull request #4497 from gauravagarwal1001/masterPr1
dobooth May 13, 2019
c3eac58
Merge branch 'master' into master-yogesh-patch-28
dobooth May 13, 2019
6909648
Merge pull request #4488 from yogeshsuhagiya/master-yogesh-patch-28
dobooth May 13, 2019
833daf8
Merge branch 'master' into masterPr1
dobooth May 13, 2019
1657ffe
Merge pull request #4490 from shikhamis11/masterPr1
dobooth May 13, 2019
63091ce
Merge branch 'master' into ds/fix-notes-format
dobooth May 13, 2019
ac1d320
Merge pull request #4486 from magento/ds/fix-notes-format
dobooth May 13, 2019
f3f17fe
Revert "[2.3.3] Updated lock config and lock env short commands"
dobooth May 13, 2019
af1ef8a
Merge pull request #4507 from magento/revert-4490-masterPr1
dobooth May 13, 2019
ae870bb
Merge branch 'master' into buskamuza-tech-guidelines
dobooth May 13, 2019
2d59291
Merge branch 'master' into small_changes
dobooth May 13, 2019
120537d
Merge pull request #4483 from magento/buskamuza-tech-guidelines
dobooth May 13, 2019
dfcbcfa
Corrected Fastly CDN availability info on Starter (#4508)
meker12 May 13, 2019
9be2264
updating magento command for docker based on description in issue #4514
aman3103 May 14, 2019
9ab43bf
Merge branch 'master' into small_changes
dobooth May 14, 2019
acd418a
Merge pull request #4515 from aman3103/issue/#4514
dobooth May 14, 2019
07130a2
Fix target=_blank & code identation
May 15, 2019
f38168c
Updates the URI to the Centos 7 PHP repository
May 15, 2019
a9fa6b6
Merge branch 'master' into small_changes
dobooth May 15, 2019
e5b5627
Merge branch 'small_changes' of github.com:magento/devdocs into small…
dobooth May 15, 2019
1b11da3
Merge pull request #4522 from digitalbricklayer/patch-2
dobooth May 15, 2019
cff7ea2
Merge branch 'master' into improve/cache-public-content
erikmarr May 15, 2019
da773f1
Merge branch 'master' into small_changes
dobooth May 15, 2019
60b6360
Merge pull request #4454 from williankeller/improve/cache-public-content
dobooth May 15, 2019
ac812d9
Fix format issue in Fastly configuration topic
meker12 May 15, 2019
b135f65
Merge pull request #4531 from magento/mae-fastly-format-fix
dobooth May 15, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion guides/v2.1/cloud/cdn/cloud-fastly.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ We highly recommend using Fastly for your CDN, security, and image optimization

## Fastly CDN module for Magento 2

Fastly services for {{ site.data.var.ece }} use the [Fastly CDN module for Magento 2](https://github.com/fastly/fastly-magento2) installed in the following environments: Pro Staging and Production, Starter Production (`master` branch).
Fastly services for {{ site.data.var.ece }} use the [Fastly CDN module for Magento 2](https://github.com/fastly/fastly-magento2) installed in the following environments: Pro Staging and Production, Starter Production (`master`) and Staging.

On initial provisioning or upgrade of your {{ site. data.var.ece }} project, we install the latest version of the Fastly CDN module. When Fastly releases module updates, you receive notifications in the Magento Admin UI for your environments. We recommend that you update your environments to use the latest release. See [Upgrade Fastly]({{ page.baseurl}}/cloud/cdn/configure-fastly.html#upgrade).

Expand Down
29 changes: 9 additions & 20 deletions guides/v2.1/cloud/cdn/configure-fastly.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,7 @@ functional_areas:
- Configuration
---

[Fastly]({{ page.baseurl }}/cloud/basic-information/cloud-fastly.html) is
required for {{site.data.var.ece}}, and is used in Staging and Production
environments. It works with Varnish to provide fast caching capabilities and a
{% glossarytooltip f83f1fa7-7a64-467b-b629-c2d0c25d2e7f %}Content Delivery Network{% endglossarytooltip %}
(CDN) for static assets. Fastly is not available in Integration environments.
[Fastly]({{ page.baseurl }}/cloud/basic-information/cloud-fastly.html) is required for {{site.data.var.ece}}, and is used in Staging and Production environments. It works with Varnish to provide fast caching capabilities and a {% glossarytooltip f83f1fa7-7a64-467b-b629-c2d0c25d2e7f %}Content Delivery Network{% endglossarytooltip %} (CDN) for static assets. Fastly is not available in Integration environments.

This information gets you started with installing and configuring Fastly.
We provide additional information for configuring backends and Origin shields, customizing
Expand Down Expand Up @@ -150,26 +146,19 @@ You cannot use the Fastly service in Integration environments.
2. Wait for dependencies to be updated.
3. Enter the following command to fully update and clear the cache:

```bash
php bin/magento setup:upgrade && php bin/magento cache:clean
```

php bin/magento setup:upgrade && php bin/magento cache:clean
4. Edit your composer.json and ensure the Fastly module is included with version.

* In the "require" section, you should have `"fastly/magento2": <version number>`
* In the "repositories" section, you should have:

```json
"fastly-magento2": {
"url": "https://github.com/fastly/fastly-magento2.git"
}
```

3. Add, commit, and push the changes to your code repository with the following command:

```bash
git add -A; git commit -m "Install Fastly" && git push origin <branch name>
```
"fastly-magento2": {
"url": "https://github.com/fastly/fastly-magento2.git"
}
3. Add, commit, and push the changes to your code repository with the following
command:

git add -A; git commit -m "Install Fastly"; git push origin <branch name>

4. Merge the branch code with the `master` Integration branch.

Expand Down
2 changes: 1 addition & 1 deletion guides/v2.1/cloud/docker/docker-quick-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Build environment | `docker-compose run build cloud-build`
Deploy environment | `docker-compose run deploy cloud-deploy`
Connect to CLI container | `docker-compose run deploy bash`
Use `{{site.data.var.ct}}` command | `docker-compose run deploy ece-command <command>`
Use Magento command | `docker-compose run deploy magento <command>`
Use Magento command | `docker-compose run deploy magento-command <command>`
Stop and remove Docker environment (removes volumes) | `docker-compose down -v`
Stop Docker environment without destroying containers | `docker-compose stop`
Resume Docker environment | `docker-compose start`
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.1/config-guide/mq/manage-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The following shows a `crontab` group entry:
</group>
```

{:.bs-callout bs-callout-tip}
{: .bs-callout .bs-callout-tip }
How often you check message queues depends on your business logic and available system resources. In general, you'll probably want to check for newly created customers and send welcome emails more frequently than a more resource intensive process (e.g., updating your catalog). You should define `cron` schedules according to your business needs. See [Configure and run cron]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-cron.html) for more information about using `cron` with Magento.

You can also use a process manager such as [Supervisor](http://supervisord.org/index.html) to monitor the status of processes. The manager can use the command line to restart the processes as needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,10 @@ Use the `X-Magento-Vary` cookie to transfer context on the HTTP layer. HTTP prox

```
sub vcl_hash {
if (req.http.cookie ~ "X-Magento-Vary=") {
hash_data(regsub(req.http.cookie, "^.?X-Magento-Vary=([^;]+);.*$", "\1"));
}
... more ...
if (req.http.cookie ~ "X-Magento-Vary=") {
hash_data(regsub(req.http.cookie, "^.*?X-Magento-Vary=([^;]+);*.*$", "\1"));
}
... more ...
}
```

Expand Down Expand Up @@ -188,6 +188,6 @@ class View extends AbstractProduct implements \Magento\Framework\DataObject\Iden
Magento uses cache tags for link creation. The performance of cache storage has a direct dependency on the number of tags per cache record, so try to minimize the number of tags and use them only for entities that are used in production mode. In other words, don't use invalidation for actions related to store setup.

{: .bs-callout .bs-callout-warning }
Use only HTTP POST or PUT methods to change state (e.g., adding to a shopping cart, adding to a wishlist, etc.) and don't expect to see caching on these methods. Using GET or HEAD methods might trigger caching and prevent updates to private content. For more information about caching, see [RFC-2616 section 13](https://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html) {:target="_blank"}
Use only HTTP POST or PUT methods to change state (e.g., adding to a shopping cart, adding to a wishlist, etc.) and don't expect to see caching on these methods. Using GET or HEAD methods might trigger caching and prevent updates to private content. For more information about caching, see [RFC-2616 section 13](https://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html){:target="_blank"}

{% include cache/page-cache-checklists.md%}
2 changes: 1 addition & 1 deletion guides/v2.1/install-gde/prereq/php-centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you must install both Apache and PHP, [Install Apache]({{ page.baseurl }}/ins

## PHP versions supported {#php-support}

<!--{% assign supported_php_versions = site.data.codebase.v2_1.open-source.composer_lock.platform.php | split: "||" %}-->
<!--{% assign supported_php_versions = site.data.codebase.v2_1.open-source.composer_lock.platform.php | split: "|" %}-->
{% include install/php-versions-template.md %}

{:.bs-callout .bs-callout-info}
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.1/install-gde/prereq/php-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you must install both Apache and PHP, [install Apache]({{ page.baseurl }}/ins

## PHP versions supported {#php-support}

<!--{% assign supported_php_versions = site.data.codebase.v2_1.open-source.composer_lock.platform.php | split: "||" %}-->
<!--{% assign supported_php_versions = site.data.codebase.v2_1.open-source.composer_lock.platform.php | split: "|" %}-->
{% include install/php-versions-template.md %}

{:.bs-callout .bs-callout-info}
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/coding-standards/technical-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -848,7 +848,7 @@ class SampleEventObserverThatModifiesInputs implements ObserverInterface

15.12. Files MUST be secured by a web server configuration (e.g., `.htaccess` or `nginx.conf`), except files that are intended to be publicly accessible.

## Cron
## 16. Cron

16.1. Cron job SHOULD be an [idempotent method](https://tools.ietf.org/html/rfc7231#section-4.2.2).

Expand Down
4 changes: 2 additions & 2 deletions guides/v2.2/comp-mgr/prereq/prereq_compman-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before you continue, to avoid errors during your installation or update, make su
* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size)
* [File system permissions](#perms) are set properly

{:bs-callout bs-callout-warning}
{: .bs-callout .bs-callout-warning }
Do not continue without performing these checks. Failure to do so could result in errors.

### Set a value for DATA_CONVERTER_BATCH_SIZE {#batch-size}
Expand Down Expand Up @@ -50,7 +50,7 @@ After your upgrade completes, you can unset the variable as follows:
unset DATA_CONVERTER_BATCH_SIZE
```

{:bs-callout bs-callout-info}
{: .bs-callout .bs-callout-info}
`DATA_CONVERTER_BATCH_SIZE` requires memory; avoid setting it to a very large value (approximately 1GB) without testing it first.

### Magento file system owner and group {#magento-owner-group}
Expand Down
8 changes: 7 additions & 1 deletion guides/v2.2/extension-dev-guide/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ You can use before methods to change the arguments of an observed method by retu
Below is an example of a before method modifying the `$name` argument before passing it on to the observed `setName` method.

```php
<?php
namespace My\Module\Plugin;

class ProductAttributesUpdater
Expand All @@ -86,7 +87,7 @@ You can use these methods to change the result of an observed method by modifyin
Below is an example of an after method modifying the return value `$result` of an observed methods call.

```php

<?php
namespace My\Module\Plugin;

class ProductAttributesUpdater
Expand All @@ -103,6 +104,7 @@ After methods have access to all the arguments of their observed methods. When t
Below is an example of an after method that accepts the `null` result and arguments from the observed `login` method for [`Magento\Backend\Model\Auth`]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Backend/Model/Auth.php){:target="_blank"}:

```php
<?php
namespace My\Module\Plugin;

class AuthLogger
Expand Down Expand Up @@ -173,6 +175,7 @@ If the around method does not call the `callable`, it will prevent the execution
Below is an example of an around method adding behavior before and after an observed method:

```php
<?php
namespace My\Module\Plugin;

class ProductAttributesUpdater
Expand Down Expand Up @@ -200,6 +203,7 @@ When you wrap a method which accepts arguments, your plugin must also accept tho
For example, the following code defines a parameter of type <code>SomeType</code> which is nullable:

```php
<?php
namespace My\Module\Model;

class MyUtility
Expand All @@ -214,6 +218,7 @@ class MyUtility
You should wrap this method with a plugin like below:

```php
<?php
namespace My\Module\Plugin;

class MyUtilityUpdater
Expand All @@ -230,6 +235,7 @@ Note if you miss <code>= null</code> and Magento calls the original method with
You are responsible for forwarding the arguments from the plugin to the <code>proceed</code> callable. If you are not using/modifying the arguments, you could use variadics and argument unpacking to achieve this:

```php
<?php
namespace My\Module\Plugin;

class MyUtilityUpdater
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/install-gde/prereq/php-centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you must install both Apache and PHP, [install Apache]({{ page.baseurl }}/ins

## PHP versions supported {#php-support}

<!--{% assign supported_php_versions = site.data.codebase.v2_2.open-source.composer_lock.platform.php | split: "||" %}-->
<!--{% assign supported_php_versions = site.data.codebase.v2_2.open-source.composer_lock.platform.php | split: "|" %}-->
{% include install/php-versions-template.md %}


Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/install-gde/prereq/php-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you must install both Apache and PHP, [install Apache]({{ page.baseurl }}/ins

## PHP versions supported {#php-support}

<!--{% assign supported_php_versions = site.data.codebase.v2_2.open-source.composer_lock.platform.php | split: "||" %}-->
<!--{% assign supported_php_versions = site.data.codebase.v2_2.open-source.composer_lock.platform.php | split: "|" %}-->
{% include install/php-versions-template.md %}


Expand Down
4 changes: 2 additions & 2 deletions guides/v2.2/install-gde/system-requirements-tech.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ MySQL 5.6, 5.7

Magento is also compatible with MySQL NDB Cluster 7.4.&#42;, MariaDB 10.0, 10.1, 10.2, Percona 5.7, and other binary-compatible MySQL technologies.

{:.bs-callout bs-callout-info}
{: .bs-callout .bs-callout-info }
Magento only uses MySQL features compatible with MariaDB. MariaDB may not be compatible with all MySQL features, however, so be sure to research compatibility issues before using a feature in your Magento module.

### PHP
Expand All @@ -43,7 +43,7 @@ Magento only uses MySQL features compatible with MariaDB. MariaDB may not be com

#### Required PHP extensions

{:.bs-callout bs-callout-info}
{: .bs-callout .bs-callout-info }
The [CentOS]({{ page.baseurl }}/install-gde/prereq/php-centos.html) and [Ubuntu]({{ page.baseurl }}/install-gde/prereq/php-ubuntu.html) PHP installation instructions include a step for installing these extensions.

<!--{% assign platform-req = site.data.codebase.v2_2.open-source.composer_lock.platform %}-->
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.3/install-gde/prereq/php-centos-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ To install PHP 7.1 on CentOS 6 or 7:

*CentOS 7*. Enter the following commands:

yum install -y http://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/ius-release-1.0-14.ius.centos7.noarch.rpm
yum install -y http://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/ius-release-1.0-15.ius.centos7.noarch.rpm
yum -y update

1. Install all [required PHP extensions]({{page.baseurl}}/install-gde/system-requirements-tech.html#required-php-extensions):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Revise the `di.xml` file, adding the configuration settings as an argument to `M

The following code shows an example of configuration settings in the `di.xml` file that determine the font sizes available for selection and add a paragraph menu option associated with the `<p>` tag:

```
```xml
<type name="Magento\PageBuilder\Model\Wysiwyg\DefaultConfigProvider">
<arguments>
<argument name="additionalSettings" xsi:type="array">
Expand All @@ -29,4 +29,4 @@ The following code shows an example of configuration settings in the `di.xml` fi
```
See a list of possibly TinyMCE settings on their [website](https://www.tinymce.com/docs/configure/).

Once you have edited the `di.xml` file you can apply custom styling for the settings you implemented in the related CSS file.
Once you have edited the `di.xml` file you can apply custom styling for the settings you implemented in the related CSS file.