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

Commit 098bccd

Browse files
doboothdobooth
authored
Merge pull request #4872 from magento/small_changes
Small changes
2 parents b641168 + 131b70a commit 098bccd

File tree

18 files changed

+41
-73
lines changed

18 files changed

+41
-73
lines changed

‎_data/toc/extension-best-practices.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,6 @@ pages:
5757

5858
- label: Creating a Magento admin page
5959
url: /ext-best-practices/extension-coding/example-module-adminpage.html
60+
61+
- label: Creating a dynamic row system config
62+
url: /ext-best-practices/tutorials/dynamic-row-system-config.html

‎common/images/widget/confirm-widget-result.png

-6.77 KB
Loading

‎guides/v2.1/cloud/cdn/configure-fastly.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Complete the following configuration steps in Staging and Production environment
183183

184184
1. Log in to your Magento Admin UI.
185185

186-
1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System** and expand **Full Page Cache**.
186+
1. Click **Stores** > Settings > **Configuration** > **Advanced** > **System** and expand **Full Page Cache**.
187187

188188
![Expand to select Fastly]({{ site.baseurl }}/common/images/cloud_fastly_menu.png){:width="650px"}
189189

@@ -195,7 +195,7 @@ Complete the following configuration steps in Staging and Production environment
195195

196196
1. After configuring the caching options, click **Save Config** at the top of the page.
197197

198-
1. Clear the cache according to the notification. Then, navigate back to **Stores** > **Settings** > **Configuration** > **Advanced** > **System** >
198+
1. Clear the cache according to the notification. Then, navigate back to **Stores** > Settings > **Configuration** > **Advanced** > **System** > **Full Page Cache** >
199199
**Fastly Configuration** to continue configuring Fastly.
200200

201201
Configure the following features and enable additional [configuration options](https://github.com/fastly/fastly-magento2/blob/master/Documentation/CONFIGURATION.md#further-configuration-options):

‎guides/v2.1/config-guide/bootstrap/magento-modes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ You can run Magento in any of the following *modes*:
3232
<li>Enables <a href="{{ page.baseurl }}/config-guide/cli/config-cli-subcommands-compiler.html">automatic code compilation</a></li>
3333
<li>Enables enhanced debugging</li>
3434
<li>Shows custom <code>X-Magento-*</code> HTTP request and response headers</li>
35-
<li>Results in the slowest performance (because of the preceding)</li></ul>
35+
<li>Results in the slowest performance</li>
36+
<li>Does not show errors on the frontend</li></ul>
3637
</td>
3738
</tr>
3839
<tr>

‎guides/v2.1/contributor-guide/backward-compatible-development/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ The rules listed do not apply to customization code (e.g. Plugins, Observers, JS
2727

2828
### Composer
2929

30-
#### Introducing a new dependency from an existing module
30+
#### Introducing a new dependency between modules
3131

32-
Introducing a new dependency from an existing module is a backward incompatible change because we cannot guarantee when Magento will enable the required module. As a result, we cannot satisfy the dependency in this way.
32+
Introducing a new dependency on another Magento module from an existing module is a backward incompatible change because we cannot guarantee whether an existing instance of Magento will have the target module enabled.
3333

3434
### PHP
3535

‎guides/v2.1/extension-dev-guide/attributes.md

Lines changed: 10 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -113,60 +113,16 @@ You must create a `<Module>/etc/extension_attributes.xml` file to define a modul
113113

114114
where:
115115

116-
<table>
117-
<thead>
118-
<th>Keyword</th>
119-
<th>Description</th>
120-
<th>Example</th>
121-
</thead>
122-
<tbody>
123-
<tr>
124-
<td><p>for</p></td>
125-
<td><p>The fully-qualified type name with the [namespace](https://glossary.magento.com/namespace) that processes the extensions. The value must be a type that implements `ExtensibleDataInterface`. The interface can be in a different module.</p> </td>
126-
<td><code>Magento\Quote\Api\Data\TotalsInterface</code></td>
127-
</tr>
128-
<tr>
129-
<td><p>code</p></td>
130-
<td><p>The name of the attribute. The attribute name should be in snake case (the first letter in each word should be in lowercase, with each word separated by an underscore). </p></td>
131-
<td><code>gift_cards_amount_used</code></td>
132-
</tr>
133-
<tr>
134-
<td><p>type</p></td>
135-
<td><p>The data type. This can be a simple data type, such as string or integer, or complex type, such as an interface.</p></td>
136-
<td><code>float <br />Magento\CatalogInventory\Api\Data\StockItemInterface</code></td>
137-
</tr>
138-
<tr>
139-
<td><p>ref</p></td>
140-
<td><p>Optional. Restricts access to the [extension attribute](https://glossary.magento.com/extension-attribute) to users with the specified permission.</p></td>
141-
<td><code>Magento_CatalogInventory::cataloginventory</code></td>
142-
</tr>
143-
<tr>
144-
<td><p>reference_table</p></td>
145-
<td>
146-
<p>The table involved in a join operation. See <a href="#search">Searching extension attributes</a> for details.</p>
147-
</td>
148-
<td><code>admin_user</code></td>
149-
</tr>
150-
<tr>
151-
<td><p>reference_field</p></td>
152-
<td><p>Column in the reference_table</p></td>
153-
<td><code>user_id</code></td>
154-
</tr>
155-
<tr>
156-
<td><p>join_on_field</p></td>
157-
<td><p>The column of the table associated with the interface specified in the <code>for</code> [keyword](https://glossary.magento.com/keyword) that will be used in the join operation.</p></td>
158-
<td><code>store_id</code></td>
159-
</tr>
160-
<tr>
161-
<td><p>field</p></td>
162-
<td><p>One or more fields present in the interface specified in the <code>type</code> keyword.</p>
163-
<p>You can specify the <code>column=""</code> keyword to define the column in the reference_table to use. The field value specifies the property on the <code>interface</code> which should be set.</p></td>
164-
<td><code><field>firstname</field><br /><field>lastname</field><br /><field>email</field><br /><br />
165-
<field column="customer_group_code">code</field></code></td>
166-
</tr>
167-
</tbody>
168-
169-
</table>
116+
|Keyword|Description|Example|
117+
|--- |--- |--- |
118+
| for | The fully-qualified type name with the [namespace](https://glossary.magento.com/namespace) that processes the extensions. The value must be a type that implements `ExtensibleDataInterface`. The interface can be in a different module. | `Magento\Quote\Api\Data\TotalsInterface` |
119+
| code | The name of the attribute. The attribute name should be in snake case (the first letter in each word should be in lowercase, with each word separated by an underscore). | `gift_cards_amount_used` |
120+
| type | The data type. This can be a simple data type, such as string or integer, or complex type, such as an interface. | `float`<br />`Magento\CatalogInventory\Api\Data\StockItemInterface` |
121+
| ref | Optional. Restricts access to the extension attribute to users with the specified permission. | `Magento_CatalogInventory::cataloginventory` |
122+
| reference_table | The table involved in a join operation. See [Searching extension attributes](#search) for details. | `admin_user` |
123+
| reference_field | Column in the `reference_table`. | `user_id` |
124+
| join_on_field | The column of the table associated with the interface specified in the `for` keyword that will be used in the join operation. | `store_id` |
125+
| field | One or more fields present in the interface specified in the `type` keyword.<br />You can specify the `column=""` keyword to define the column in the reference_table to use. The field value specifies the property on the `interface` which should be set. | `<field>firstname</field>`<br />`<field>lastname</field>`<br />`<field>email</field>`<br /><br />`<field column="customer_group_code">code</field>` |
170126

171127
### Searching extension attributes {#search}
172128

‎guides/v2.1/frontend-dev-guide/css-topics/css-themes.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,12 @@ To include an external CSS file, add `<css src="URL to External Source" src_type
102102
</page>
103103
```
104104

105+
The `<link/>` tag can be used to insert `CSS` file in layout XML.
106+
107+
```xml
108+
<link src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap-theme.min.css" src_type="url" rel="stylesheet" type="text/css"/>
109+
```
110+
105111
{:.bs-callout .bs-callout-info}
106112
If the system does not find the included CSS files, it searches for the same file names with a `.less` extension. This is part of the built-in preprocessing mechanism. You can find more information about it in the [CSS Preprocessing] topic.
107113

‎guides/v2.1/frontend-dev-guide/translations/xlate.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Depending on your needs, you can use the existing [language packages](#m2devgde-
5252
## Programming notes
5353

5454
* It is recommended, but not enforced, that you do not place variables inside `__()` functions or `new Phrase()` calls. The scanner that collects the phrases from the code cannot interpret and collect the value of the variable when it is in these locations. Instead, you should place the full text in the `__()` function or `new Phrase()` call. If you need to specify a variable in these cases, ensure that it is translated correctly wherever it is defined as a string literal.
55+
* It is recommended that, whenever possible, the preferred gender of any nouns be supplied as a variable. This helps languages with gendered conjugations translate phrases more smoothly.
5556
* The [language package](https://glossary.magento.com/language-package) (`i18n` directory) can be saved to any directory of your [extension](https://glossary.magento.com/extension).
5657
* The phrases for translations are enabled in the [Phrase] class.
5758

‎guides/v2.2/config-guide/bootstrap/magento-modes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ You can run Magento in any of the following *modes*:
3232
<li>Enables <a href="{{ page.baseurl }}/config-guide/cli/config-cli-subcommands-compiler.html">automatic code compilation</a></li>
3333
<li>Enables enhanced debugging</li>
3434
<li>Shows custom <code>X-Magento-*</code> HTTP request and response headers</li>
35-
<li>Results in the slowest performance (because of the preceding)</li></ul>
35+
<li>Results in the slowest performance</li>
36+
<li>Does not show errors on the frontend</li></ul>
3637
</td>
3738
</tr>
3839
<tr>

‎guides/v2.2/frontend-dev-guide/theme-best-practice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Some other customizations that can be performed using layout instructions are th
2828
4. Use `<theme_dir>/etc/view.xml` to change image types sizes or add your own types. See [Configure images properties]({{ page.baseurl }}/frontend-dev-guide/themes/theme-images.html) for details. Use this file also to [customize product gallery widget]({{ page.baseurl }}/javascript-dev-guide/widgets/widget_gallery.html)
2929
5. If you need to change the wording in user interface, [add custom CSV dictionary files]({{ page.baseurl }}/frontend-dev-guide/translations/theme_dictionary.html) instead of overriding `.phtml` templates.
3030

31-
Keep in mind, that after Magento instances, updates or upgrades something can change in default templates, layouts, and styles. So it is recommended to check if the changes effected the files overridden in your theme and copy changes if any, to your templates, layouts, and styles.
31+
Keep in mind that, after updating or upgrading Magento instances, there may be changes to default templates, layouts, and styles. So it is recommended to check if those changes affect any files overridden in your theme and if so, copy the changes to your templates, layouts, and styles.

0 commit comments

Comments
 (0)