Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 src/_includes/install/file-system-perms-before.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This topic discusses how to set read-write permissions for the web server group
The procedure you use is different, depending on whether you use [shared hosting](#perms-shared) and have one user or if you use a [private server](#perms-private) and have two users.

{:.bs-callout-info}
If you're using a Magento version*earlier than* 2.0.6, see [Appendix—Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead.
If you're using a Magento version*earlier than* 2.0.6, see [Appendix---Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In a separate PR, remove this callout and delete the target file (legacy-file-system-perms.md) from the v2.3 directory. Also delete all links to that file, including those in src/_includes/install/file-system-perms-before_22.md, src/_includes/install/file-system-umask-over.md, and others

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR: #6364

I hope I did all what you requested.


## Set permissions for shared hosting (one user) {#perms-shared}

Expand Down
2 changes: 1 addition & 1 deletion src/_includes/install/file-system-perms-before_22.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This topic discusses how to set read-write permissions for the web server group
The procedure you use is different, depending on whether you use [shared hosting](#perms-shared) and have one user or if you use a [private server](#perms-private) and have two users.

{:.bs-callout-info}
If you're using a Magento version *earlier than* 2.0.6, see [Appendix—Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead.
If you're using a Magento version *earlier than* 2.0.6, see [Appendix---Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead.

## Set permissions for shared hosting (one user) {#perms-shared}

Expand Down
4 changes: 2 additions & 2 deletions src/_includes/install/file-system-umask-over.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Even in a development environment, you want your Magento installation to be secure. To help prevent issues related to unauthorized people or processes doing potentially harmful things to your system, we recommend some guidelines related to file system ownership and permissions.

{:.bs-callout-info}
If you're using an Magento version 2.0.5 or earlier, see [Appendix—Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead of this topic. In version 2.0.6 and later, Magento does not explicitly set file or directory permissions.
If you're using an Magento version 2.0.5 or earlier, see [Appendix---Magento file system ownership and appendix (legacy)]({{ page.baseurl }}/install-gde/install/legacy-file-system-perms.html) instead of this topic. In version 2.0.6 and later, Magento does not explicitly set file or directory permissions.

This topic provides some basic information about our ownership and permissions guidelines. For additional information, see:

Expand Down Expand Up @@ -41,7 +41,7 @@ Before you install the Magento software, see [Set pre-installation ownership and

### Restrict access with a umask {#restrict}

To tighten security, particularly in production on a shared hosting system, we provide a flexible to means to restrict access using a umask. A umask—also referred to as a *file system creation mask*—is a set of bits, each of which restricts how its corresponding permission is set for newly created files.
To tighten security, particularly in production on a shared hosting system, we provide a flexible to means to restrict access using a umask. A umask---also referred to as a *file system creation mask*---is a set of bits, each of which restricts how its corresponding permission is set for newly created files.

{:.bs-callout-warning}
File system security is complex and extremely important. We strongly recommend you consult an experienced system administrator or network administrator before you decide what permissions to set. We provide a mechanism for you to use but a permissions strategy is up to you.
Expand Down
2 changes: 1 addition & 1 deletion src/_includes/install/install-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Topics include:

* [Upgrading (or *patching* the Magento application)]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html)
* [Updating components (including install, uninstall, update, enable, disable)]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html)
* *Contributing developers only*: [Contributing developers—update, reinstall Magento]({{ page.baseurl }}/install-gde/install/cli/dev_options.html)
* *Contributing developers only*: [Contributing developers---update, reinstall Magento]({{ page.baseurl }}/install-gde/install/cli/dev_options.html)

## Deploy to production

Expand Down
2 changes: 1 addition & 1 deletion src/cloud/before/before-workspace-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Previous step

[Install Magento prerequisites]({{ site.baseurl }}/cloud/before/before-workspace-magento-prereqs.html)

The [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell) is designed to maintain a secure connection between two systems—in this case, your local working environment and your {{site.data.var.ece}} Git project.
The [SSH protocol](https://en.wikipedia.org/wiki/Secure_Shell) is designed to maintain a secure connection between two systems---in this case, your local working environment and your {{site.data.var.ece}} Git project.

When initially setting up your local environment, you need to add the SSH keys to the following specific environments:

Expand Down
2 changes: 1 addition & 1 deletion src/cloud/live/live-prot.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ We run two types of blocks:

* For production websites, we run a "partial block" that allows the site to stay mostly online.

Depending on the nature of the vulnerability, parts of a request, such as a query string, cookies or any additional headers, might be removed from GET requests. All other requests may be blocked entirely—this could apply to logging in, form submission, or product [checkout](https://glossary.magento.com/checkout).
Depending on the nature of the vulnerability, parts of a request, such as a query string, cookies or any additional headers, might be removed from GET requests. All other requests may be blocked entirely---this could apply to logging in, form submission, or product [checkout](https://glossary.magento.com/checkout).

Unblocking is automated upon resolution of the security risk. The block is removed soon after you apply a security upgrade that removes the vulnerability.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ functional_areas:
- Standards
---

In the Magento system, all jQuery UI widgets and interactions are built on a simple, reusable base—the [jQuery UI Widget Factory][jquery-ui-widget-factory]{:target="_blank"}.
In the Magento system, all jQuery UI widgets and interactions are built on a simple, reusable base---the [jQuery UI Widget Factory][jquery-ui-widget-factory]{:target="_blank"}.

The factory provides a flexible base for building complex, stateful plug-ins with a consistent [API](https://glossary.magento.com/api).
It is designed not only for plug-ins that are part of [jQuery](https://glossary.magento.com/jquery) UI, but for general usage by developers who want to create object-oriented components without reinventing common infrastructure.
Expand Down
4 changes: 2 additions & 2 deletions src/guides/v2.3/comp-mgr/extens-man/extensman-main-pg.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ After you log in to the Extension Manager, a list displays as follows:

{% collapsible Supported actions for each type %}

We support different actions for each *type* of component. (*Component* is a general term that includes any type of code you can install in the Magento application—module, language package, theme, or metapackage. *Extension* refers to anything you can install, uninstall, or update.)
We support different actions for each *type* of component. (*Component* is a general term that includes any type of code you can install in the Magento application---module, language package, theme, or metapackage. *Extension* refers to anything you can install, uninstall, or update.)

The following figure shows how types display in the Extension Manager.

Expand All @@ -66,7 +66,7 @@ Following is a definition of types:
* `module` for a module (that is, PHP code that modifies Magento behavior)
* `language` for a language package used to translate the Magento storefront and Admin
* `theme` for a collection of styles that affect the look of the storefront or Admin
* `library` for a library—such as a shared third-party library
* `library` for a library---such as a shared third-party library
* `component` for any type of component that must be installed in the Magento root directory (this is a relatively uncommon type)

Actions are further divided between those available for *metapackages* (that is, an installable package that contains a group of different types) or *non-metapackages* (that is, a single type).
Expand Down
2 changes: 1 addition & 1 deletion src/guides/v2.3/config-guide/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Magento uses the following caching terminology:
* *Frontend*: Similar to an interface or gateway to cache storage, implemented by [Magento\Framework\Cache\Frontend]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Cache/Frontend).
* *Cache types*: Can be one of the types provided with Magento or you can [create your own]({{ page.baseurl }}/extension-dev-guide/cache/partial-caching/create-cache-type.html).
* *Backend*: Specifies details about [cache storage](http://framework.zend.com/manual/1.12/en/zend.cache.backends.html), implemented by [Magento\Framework\Cache\Backend]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Cache/Backend)
* *Two-level backend*: Stores cache records in two backends—a faster one and a slower one.
* *Two-level backend*: Stores cache records in two backends---a faster one and a slower one.

Two-level backend cache configuration is beyond the scope of this guide at this time.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ An example of translating a phrase:

## Create a language package {#config-cli-subcommands-xlate-pack}

As opposed to a translation dictionary, you can translate any or all words and phrases in the Magento application using a language package. You can translate a particular component—like a module or a theme—using a translation dictionary. [Learn more about language packages].
As opposed to a translation dictionary, you can translate any or all words and phrases in the Magento application using a language package. You can translate a particular component---like a module or a theme---using a translation dictionary. [Learn more about language packages].

This section discusses how to create a language package, which writes `.csv` files to modules and themes. To create a language package, you must perform the tasks discussed in the following sections:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -532,19 +532,19 @@ Generates tax rates. XML profile node:

Additional configuration information:

* `<Magento root dir>/setup/performance-toolkit/config/attributeSets.xml`&mdash;Default attribute sets
* `<Magento root dir>/setup/performance-toolkit/config/attributeSets.xml`---Default attribute sets

* `<Magento root dir>/setup/performance-toolkit/config/customerConfig.xml`&mdash;Customer configuration
* `<Magento root dir>/setup/performance-toolkit/config/customerConfig.xml`---Customer configuration

* `<Magento root dir>/setup/performance-toolkit/config/description.xml`&mdash;Product full description configuration
* `<Magento root dir>/setup/performance-toolkit/config/description.xml`---Product full description configuration

* `<Magento root dir>/setup/performance-toolkit/config/shortDescription.xml`&mdash;Product short description configuration
* `<Magento root dir>/setup/performance-toolkit/config/shortDescription.xml`---Product short description configuration

* `<Magento root dir>/setup/performance-toolkit/config/searchConfig.xml`&mdash;Configuration for product short and full description. This older implementation is provided for backward compatibility.
* `<Magento root dir>/setup/performance-toolkit/config/searchConfig.xml`---Configuration for product short and full description. This older implementation is provided for backward compatibility.

* `<Magento root dir>/setup/performance-toolkit/config/searchTerms.xml`&mdash;Small number of search terms to in short and full descriptions
* `<Magento root dir>/setup/performance-toolkit/config/searchTerms.xml`---Small number of search terms to in short and full descriptions

* `<Magento root dir>/setup/performance-toolkit/config/searchTermsLarge.xml`&mdash;Larger number of search terms to use in short and full description.
* `<Magento root dir>/setup/performance-toolkit/config/searchTermsLarge.xml`---Larger number of search terms to use in short and full description.

{:.ref-header}
Related topics
Expand Down
2 changes: 1 addition & 1 deletion src/guides/v2.3/config-guide/config/config-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ functional_areas:

The responsibilities of the `config.xml` configuration file used in earlier versions of Magento is now divided between several files, located in various [module](https://glossary.magento.com/module) directories. Magento's multiple configuration files load on demand only when a module requests a specific configuration type.

You can use these files&mdash;also referred to as *configuration types*&mdash;to customize specific aspects of your module's behavior.
You can use these files---also referred to as *configuration types*---to customize specific aspects of your module's behavior.

Multiple modules can declare configuration files that affect the same configuration type (for example, events), and these multiple configuration files are merged.

Expand Down
4 changes: 2 additions & 2 deletions src/guides/v2.3/config-guide/config/config-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ Unlike other [module configuration files]({{ page.baseurl }}/config-guide/config
## Details about the deployment configuration {#config-php-contents}
`config.php` and `env.php` are [PHP](https://glossary.magento.com/php) files that return a [multi-dimensional associative array](http://www.w3schools.com/php/php_arrays.asp), which is basically a hierarchical arrangement of configuration parameters and values.

On the top level of this array are *configuration segments*. A segment has arbitrary content (a scalar value or a nested array) distinguished by an arbitrary key&mdash;where both the key and its value are defined by the Magento framework.
On the top level of this array are *configuration segments*. A segment has arbitrary content (a scalar value or a nested array) distinguished by an arbitrary key---where both the key and its value are defined by the Magento framework.

[Magento\Framework\App\DeploymentConfig]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/App/DeploymentConfig.php) merely provides access to these sections but does not allow you to extend them.

On the next hierarchy level, items in each segment are ordered according to the [module](https://glossary.magento.com/module) sequence definition, which is obtained by merging all modules' configuration files, with the [exception](https://glossary.magento.com/exception) of disabled modules.

The following sections discusses the structure and contents of the deployment configuration&mdash;`config.php` and `env.php`.
The following sections discusses the structure and contents of the deployment configuration---`config.php` and `env.php`.

* [Manage installed modules](#config-php-contents-config-php)
* [System-specific configuration]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-config-mgmt-export.html#app-etc-env-php)
Expand Down
2 changes: 1 addition & 1 deletion src/guides/v2.3/config-guide/cron/custom-cron-ref.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ where:

{:.ref-header}
Related topic
[Tutorial&mdash;configure custom cron jobs and cron groups]({{ page.baseurl }}/config-guide/cron/custom-cron-tut.html)
[Tutorial---configure custom cron jobs and cron groups]({{ page.baseurl }}/config-guide/cron/custom-cron-tut.html)
2 changes: 1 addition & 1 deletion src/guides/v2.3/config-guide/deployment/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following topics are organized to help you get started quickly. If you're ne

* Step-by-step examples of using pipeline deployment

* [Simple example&mdash;manage the shared configuration]({{ page.baseurl }}/config-guide/deployment/pipeline/example/shared-configuration.html)
* [Simple example---manage the shared configuration]({{ page.baseurl }}/config-guide/deployment/pipeline/example/shared-configuration.html)

* Reference information

Expand Down
2 changes: 1 addition & 1 deletion src/guides/v2.3/config-guide/log/log-magento.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ The preceding example shows that `SomeModel` receives a `\Psr\Log\LoggerInterfac
{:.ref-header}
Next step

[Example&mdash;logging database activity]({{ page.baseurl }}/config-guide/log/log-db.html)
[Example---logging database activity]({{ page.baseurl }}/config-guide/log/log-db.html)
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This topic covers only the default options in the preceding list. There are many

On the first browser request, cacheable assets are delivered to the client browser from Varnish and cached on the browser.

In addition, Varnish uses an [Entity](https://glossary.magento.com/entity) Tag ([ETag](https://en.wikipedia.org/wiki/HTTP_ETag)) for static assets. The ETag provides a way to determine when [static files](https://glossary.magento.com/static-files) change on the server. As a result, static assets are sent to the client when they change on the server&mdash;either on a new request from a browser or when the client refreshes the browser cache, typically by pressing F5 or Control+F5.
In addition, Varnish uses an [Entity](https://glossary.magento.com/entity) Tag ([ETag](https://en.wikipedia.org/wiki/HTTP_ETag)) for static assets. The ETag provides a way to determine when [static files](https://glossary.magento.com/static-files) change on the server. As a result, static assets are sent to the client when they change on the server---either on a new request from a browser or when the client refreshes the browser cache, typically by pressing F5 or Control+F5.

More detail is provided in the sections that follow.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ For each particular scenario, files of the same type are loaded from different c

In another scenario, let's say you want to load all of the [layout](https://glossary.magento.com/layout) files with the name `default.xml`. __Component A__ specifies __component B__ in `<sequence>`. The files load in the following order:

1. `component X/view/frontend/layout/default.xml`&mdash;Either we don't care about when component X loads or perhaps component B requires it to be loaded before it.
1. `component X/view/frontend/layout/default.xml`---Either we don't care about when component X loads or perhaps component B requires it to be loaded before it.
1. `component B/view/frontend/layout/default.xml`
1. `component A/view/frontend/layout/default.xml`&mdash;Loads after __component B__ because __component B__ is listed in __component A's__ `<sequence>` tag.
1. `component Z/view/frontend/layout/default.xml`&mdash;Either we don't care about the sequence for component Z or perhaps component Z requires component A files to be loaded before it.
1. `component A/view/frontend/layout/default.xml`---Loads after __component B__ because __component B__ is listed in __component A's__ `<sequence>` tag.
1. `component Z/view/frontend/layout/default.xml`---Either we don't care about the sequence for component Z or perhaps component Z requires component A files to be loaded before it.

There are no limitations&mdash;you can specify any valid component in `<sequence>`.
There are no limitations---you can specify any valid component in `<sequence>`.

If you do specify a component in `<sequence>`, make sure that you have also added it to the `require` section in that component's `composer.json` file.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This topic discusses how to set up database caching and how to verify database c
* Using a custom [cache](https://glossary.magento.com/cache) frontend, in which case you modify `env.php` only.

{:.bs-callout-warning}
Database caching&mdash;like file-based caching&mdash; works well in a development environment but we _strongly recommend_ you use [Varnish] in production instead.
Database caching---like file-based caching--- works well in a development environment but we _strongly recommend_ you use [Varnish] in production instead.
Varnish is designed to accelerate the HTTP protocol.

## Prerequisites {#mage-cache-db-prereq}
Expand Down
Loading