Small changes (#6242)

* Updated link to proper format * Small typo in code example (#6204) There is small typo with using variable in code example. * Fixing typo in apc codeblock (#6196) * Fixing typo in apc codeblock * Mirroring change in 2.2 file * magento/devdocs#: Fix incorrect markdown in UI Text component. (#6180) https://devdocs.magento.com/guides/v2.2/ui_comp_guide/components/ui-text.html https://devdocs.magento.com/guides/v2.3/ui_comp_guide/components/ui-text.html * Update Input UI component documentation (#6208) * Update Expandable UI component documentation (#6210) * Update Expandable UI component documentation * grammar updates * Update InsertForm UI component documentation * magento/devdocs#: Add applyCouponToCart mutation API errors (#6213) * magento/devdocs#: Add applyCouponToCart mutation API errors https://devdocs.magento.com/guides/v2.3/graphql/mutations/apply-coupon.html * Grammar updates * Update documentation for the Text UI component (#6207) * Update documentation for the Text UI component * alphabetization/grammar * Sentence Correction. (#6219) * Update InsertListing UI component documentation (#6211) * Update InsertListing UI component documentation * Grammar updates * Added cli command for static content signing to enable/disable (#6217) * Added cli command for static content signing to enable/disable * CLI command values indication added * Grammar updates * Add urn path to example XML files on copy fieldsets page (#6199) * Introduced a space between "Translate" and "Inline" * MIssing semicolon added. (#6236) * Update docker-config.md (#6222) * Update docker-config.md * Update docker-config.md * Improiving the Ui Form Component documentation (#6235) * Period(".") added and Extra colon removed (#6231) * Period(".") added and Extra colon removed * Extra colon(":") removed Extra colon(":") removed after Example title of Helper classes section * Remove duplicated </a> tag. (#6232) * Word "Differences" changed to "Relationship" (#6237) Title - "Differences between parent and child themes" changed to "Relationship between parent and child themes" * Unnecessary italic style removed (#6239) * Added information to block class attribute (#6229) * Added information to block class attribute * Changed refs to "lower than 2.2.1" to "2.2.0" * magento/devdocs#: Add removeCouponFromCart mutation API errors (#6220) * magento/devdocs#: Add removeCouponFromCart mutation API errors https://devdocs.magento.com/guides/v2.3/graphql/mutations/remove-coupon.html * Grammar/linting updates * Update remove-coupon.md * Update the documentation for the urlInput UI component (#6234) * Update the documentation for the urlInput UI component * Adjusted the UrlInput documentation * Update documentation for the Textarea UI component (#6158) * Update documentation for the Textarea UI component * Added the label option * Grammar * fix linting errors
magento · Dec 18, 2019 · 20f1e2c · 20f1e2c
1 parent 64e904b
commit 20f1e2c
Show file tree

Hide file tree

Showing 36 changed files with 746 additions and 716 deletions.
diff --git a/src/cloud/docker/docker-config.md b/src/cloud/docker/docker-config.md
@@ -117,7 +117,7 @@ Continue launching your Docker environment in the default _production_ mode.
 1. _Optional_: If you have a custom PHP configuration file, copy the default configuration DIST file to your custom configuration file and make any necessary changes.
 
    ```bash
-   cp .docker/config.php.dist .docker/config.php
+   cp ./docker/config.php.dist ./docker/config.php
    ```
 
 1. _Optional_: Configure the Docker global variables in the `docker-compose.yml` file. For example, you can [configure Xdebug]({{ site.baseurl }}/cloud/docker/docker-development-debug.html#configure-xdebug).
@@ -197,7 +197,7 @@ The `{{site.data.var.ct}}` version 2002.0.18 and later supports developer mode.
 1. _Optional_: If you have a custom PHP configuration file, copy the default configuration DIST file to your custom configuration file and make any necessary changes.
 
    ```bash
-   cp .docker/config.php.dist .docker/config.php
+   cp ./docker/config.php.dist ./docker/config.php
    ```
 
 1. _Optional_: Configure the Docker global variables in the `docker-compose.yml` file. For example, you can [enable and configure Xdebug]({{ site.baseurl }}/cloud/docker/docker-development-debug.html).

diff --git a/src/common/images/ui_comps/ui-expandable-expanded-result.png b/src/common/images/ui_comps/ui-expandable-expanded-result.png
diff --git a/src/common/images/ui_comps/ui-expandable-result.png b/src/common/images/ui_comps/ui-expandable-result.png
diff --git a/src/common/images/ui_comps/ui-input-result.png b/src/common/images/ui_comps/ui-input-result.png
diff --git a/src/common/images/ui_comps/ui-insertform-result.png b/src/common/images/ui_comps/ui-insertform-result.png
diff --git a/src/common/images/ui_comps/ui-insertlisting-result.png b/src/common/images/ui_comps/ui-insertlisting-result.png
diff --git a/src/common/images/ui_comps/ui-text-result.png b/src/common/images/ui_comps/ui-text-result.png
diff --git a/src/common/images/ui_comps/ui-textarea-result.png b/src/common/images/ui_comps/ui-textarea-result.png
diff --git a/src/common/images/ui_comps/ui-urlinput-category-link-result.png b/src/common/images/ui_comps/ui-urlinput-category-link-result.png
diff --git a/src/common/images/ui_comps/ui-urlinput-default-link-result.png b/src/common/images/ui_comps/ui-urlinput-default-link-result.png
diff --git a/src/common/images/ui_comps/ui-urlinput-product-link-result.png b/src/common/images/ui_comps/ui-urlinput-product-link-result.png
diff --git a/src/guides/v2.2/coding-standards/code-standard-less.md b/src/guides/v2.2/coding-standards/code-standard-less.md
@@ -346,7 +346,7 @@ Helper class names should be lowercase and start with underscore ("_").
 
 Some parts of Magento code might not comply with this standard yet. You might still find helper names with no underscores. We are working to gradually remove the inconsistency.
 
-**Example:**:
+**Example:**
 
 ```css
 ._active {
@@ -658,7 +658,7 @@ If variables are local and used only in a [module](https://glossary.magento.com/
 
 #### Theme variables
 
-If variables are common for several modules they should be specified in the `_theme.less` file
+If variables are common for several modules they should be specified in the `_theme.less` file.
 
 ### Naming
 
@@ -728,7 +728,7 @@ For [mixin](https://glossary.magento.com/mixin) naming apply the class naming ru
 
 For mixins grouping use the double underscore "__" prefix.
 
-**Example:**:
+**Example:**
 
 ```css
 .extend__clearfix (...) {

diff --git a/src/guides/v2.2/config-guide/cache/static-content-signing.md b/src/guides/v2.2/config-guide/cache/static-content-signing.md
@@ -36,6 +36,20 @@ You can find the configuration for this feature in [**Stores** > Settings > Conf
 
 ![Static Files Settings]({{ site.baseurl }}/common/images/static-files-settings.png)
 
+You can also use the CLI command to determine the status:
+
+```bash
+bin/magento config:show dev/static/sign
+```
+
+Use the following command to enable or disable static content signing
+
+```bash
+bin/magento config:set dev/static/sign <value>
+```
+
+Where ```<value>``` is 1 (enabled) or 0 (disabled).
+
 #### Version signatures
 
 Magento appends the version signature as a path component directly after the base URL of static view files to preserve the integrity of relative URLs across static resources.

diff --git a/src/guides/v2.2/ext-best-practices/tutorials/copy-fieldsets.md b/src/guides/v2.2/ext-best-practices/tutorials/copy-fieldsets.md
@@ -19,7 +19,7 @@ The following code defines a simple [extension attribute][1] named `demo` for th
 **etc/extension_attributes.xml:**
 
 ```xml
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Api/etc/extension_attributes.xsd">
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
   <extension_attributes for="Magento\Quote\Api\Data\CartInterface">
     <attribute code="demo" type="string" />
   </extension_attributes>
@@ -37,7 +37,8 @@ The code snippet in the next step uses the name of the fieldset and aspect to sp
 **etc/fieldset.xml:**
 
 ```xml
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="DataObject/etc/fieldset.xsd">
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:DataObject/etc/fieldset.xsd">
   <scope id="global">
     <fieldset id="sales_convert_quote">
       <field name="demo">

diff --git a/src/guides/v2.2/extension-dev-guide/proxies.md b/src/guides/v2.2/extension-dev-guide/proxies.md
@@ -35,7 +35,7 @@ class FastLoading
     public function __construct(
         SlowLoading $slowLoading
     ){
-        $this->slowLoading = slowLoading;
+        $this->slowLoading = $slowLoading;
     }
 
     public function getFastValue()

diff --git a/src/guides/v2.2/frontend-dev-guide/css-topics/css-themes.md b/src/guides/v2.2/frontend-dev-guide/css-topics/css-themes.md
@@ -43,13 +43,13 @@ Contains the following:
 <li>
 <code>print.less</code>: used to generate styles for the printed version of store pages.
 </li>
-<li><code>_styles.less</code> - a composite file, which includes all Less files used in the [theme](https://glossary.magento.com/theme). The underscore sign ("_") in a file name conventionally means that a file is not used independently, but is included in other files.
+<li><code>_styles.less</code> - a composite file, which includes all Less files used in the <a href="https://glossary.magento.com/theme">theme</a>. The underscore sign ("_") in a file name conventionally means that a file is not used independently, but is included in other files.
 </li>
 <li><code>styles-m.less</code>: used to generate mobile-specific styles, includes <code>_styles.less</code>
 </li>
 <li><code>styles-l.less</code>: used to generate desktop-specific styles, includes <code>_styles.less</code>.
 </li>
-<li><code>/source</code>: this subdirectory contains Less configuration files that invoke mixins from the Magento UI [library](https://glossary.magento.com/library)
+<li><code>/source</code>: this subdirectory contains Less configuration files that invoke mixins from the Magento UI <a href="https://glossary.magento.com/library">library</a>
 </li>
 <li>
 <code>/source/_theme.less</code>: overrides the default Magento UI library variables values.

diff --git a/src/guides/v2.2/frontend-dev-guide/layouts/layout-overview.md b/src/guides/v2.2/frontend-dev-guide/layouts/layout-overview.md
@@ -102,7 +102,7 @@ Layout files that belong to inactive modules or modules with disabled output are
 
 After layouts are merged, Magento validates them.
 
-Layout validations and error handling depends on the [application mode] in which you Magento instance runs:
+Layout validations and error handling depends on the [application mode] in which your Magento instance runs:
 
 *  developer mode: syntax is validated in `.xml` and `.xsd` files, and `.xml` files are validated according to the xsd schema. If any validation fails, the hard failure with process halt occurs.
 

diff --git a/src/guides/v2.2/frontend-dev-guide/layouts/xml-instructions.md b/src/guides/v2.2/frontend-dev-guide/layouts/xml-instructions.md
@@ -56,14 +56,14 @@ Blocks are a foundational building unit for layouts in Magento. They are the lin
 Blocks employ templates to generate HTML. Examples of blocks include a [category](https://glossary.magento.com/category) list, a mini cart, product tags, and product listing.
 
 {:.bs-callout-info}
-The `class` attribute is no longer required in versions `2.2.1` and above as it will default to `Magento\Framework\View\Element\Template`. **In versions lower than `2.2.1`, the `class` attribute is still required**.
+The `class` attribute is no longer required in versions `2.2.1` and above, as it will default to `Magento\Framework\View\Element\Template`. **In version `2.2.0`, the `class` attribute is still required**.
 
-{:.bs-callout-info}
+{:.bs-callout-tip}
 We recommend always adding a `name` to blocks. Otherwise, it is given a random name.
 
 | Attribute | Description | Values | Required? |
 |:------- |:------ |:------ |:------ |
-| `class` | Name of a class that implements rendering of a particular block. An object of this class is responsible for actual rendering of block output. | class name | no |
+| `class` | Name of a class that implements rendering of a particular block. An object of this class is responsible for actual rendering of block output. | A fully-qualified class name, such as `Vendor\Module\Block\Class`. Defaults to `Magento\Framework\View\Element\Template` in v2.2.1+ | no (v2.2.1+), yes (v2.2.0) |
 |`name` | Name that can be used to address the block to which this attribute is assigned. The name must be unique per generated page. If not specified, an automatic name will be assigned in the format <code>ANONYMOUS_<em>n</em></code> | 0-9, A-Z, a-z, underscore (_), period (.), dash (-). Should start with a letter. Case-sensitive. | no |
 | `before` | Used to position the block before an element under the same parent. The element name or alias name is specified in the value. Use dash (-) to position the block before all other elements of its level of nesting. See [before and after attributes](#fedg_xml-instrux_before-after) for details. | Possible values: element name or dash (-) | no |
 | `after` | Used to position the block after an element under the same parent. The element name or alias name is specified in the value. Use dash (-) to position the block after all other elements of its level of nesting. See [before and after attributes](#fedg_xml-instrux_before-after) for details. | Possible values: element name or dash (-) | no |

diff --git a/src/guides/v2.2/frontend-dev-guide/themes/js-bundling.md b/src/guides/v2.2/frontend-dev-guide/themes/js-bundling.md
@@ -47,7 +47,7 @@ JavaScript bundling does not work unless Magento is in [production mode][product
 
 ## How bundling works in Magento
 
-When you enable bundling, Magento combines hundreds of JavaScript files into just a few JavaScript bundles and downloads those bundles for each page. Because the browser downloads the bundles synchronously, page rendering *is* blocked until all bundles finish downloading. But the time saved from reducing server requests from hundreds to just a few, usually offsets the cost of downloading the bundles synchronously.
+When you enable bundling, Magento combines hundreds of JavaScript files into just a few JavaScript bundles and downloads those bundles for each page. Because the browser downloads the bundles synchronously, page rendering is blocked until all bundles finish downloading. But the time saved from reducing server requests from hundreds to just a few, usually offsets the cost of downloading the bundles synchronously.
 
 ### Excluding files
 

diff --git a/src/guides/v2.2/frontend-dev-guide/themes/theme-inherit.md b/src/guides/v2.2/frontend-dev-guide/themes/theme-inherit.md
@@ -38,7 +38,7 @@ The Orange theme by OrangeCo inherits from the Magento Blank theme. The inherita
 {:.bs-callout-info}
 A parent and a child theme can belong to different vendors. For example, your custom theme can inherit from the Magento Blank theme.
 
-## Differences between parent and child themes
+## Relationship between parent and child themes
 
 *  A child theme inherits view configuration, templates, layouts, and static file from its parents.
 

diff --git a/src/guides/v2.2/performance-best-practices/software.md b/src/guides/v2.2/performance-best-practices/software.md
@@ -104,7 +104,7 @@ Edit your `apcu.ini` configuration file to add the APCu extension module:
 ```text
 extension=apcu.so
 [apcu]
-acp.enabled = 1
+apc.enabled = 1
 ```
 
 ## Web server

diff --git a/src/guides/v2.2/ui_comp_guide/components/ui-expandable-column.md b/src/guides/v2.2/ui_comp_guide/components/ui-expandable-column.md
@@ -8,54 +8,63 @@ The Expandable Column [UI component](https://glossary.magento.com/ui-component)
 The Expandable Column component can be used in [Admin](https://glossary.magento.com/admin) and the [storefront](https://glossary.magento.com/storefront).
 
 ## Configuration options
-<table>
-    <tr>
-        <th>Option</th>
-        <th>Description</th>
-        <th>Type</th>
-        <th>Default</th>
-    </tr>
-    <tr>
-        <td><code>bodyTmpl</code></td>
-        <td>Path to the template used for rendering the column's fields in the table's body.</td>
-        <td>String</td>
-        <td><code>ui/grid/cells/expandable</code></td>
-    </tr>
-    <tr>
-        <td><code>tooltipTmpl</code></td>
-        <td>Path to the template used for rendering the component's tooltip content template.</td>
-        <td>String</td>
-        <td><code>ui/grid/cells/expandable/content</code></td>
-    </tr>
-    <tr>
-        <td><code>visibeItemsLimit</code></td>
-        <td>A number of options to display in a cell.</td>
-        <td>String</td>
-        <td><code>'5'</code></td>
-    </tr>
-    <tr>
-        <td><code>tooltipTitle</code></td>
-        <td>A title for the tooltip.</td>
-        <td>String</td>
-        <td />
-    </tr>
-</table>
-
-Component's options are set in the configuration `.xml` file as follows:
+
+| Option | Description | Type | Default |
+| --- | --- | --- | --- |
+| `bodyTmpl` | Path to the template used for rendering the column's fields in the table's body. | String | `ui/grid/cells/expandable` |
+| `component` | The path to the component’s `.js` file in terms of RequireJS. | String | `Magento_Ui/js/grid/columns/expandable` |
+| `tooltipTitle` | A title for the tooltip. | String | `''` |
+| `tooltipTmpl` | Path to the template used for rendering the component's tooltip content template. | String | `ui/grid/cells/expandable/content` |
+| `visibeItemsLimit` | A number of options to display in a cell. | String | `5` |
+
+## Examples
+
+### Integrate the Expandable component with the Listing component
+
+The following example shows how the Expandable component integrates with the [Listing]({{ page.baseurl }}/ui_comp_guide/components/ui-listing-grid.html) component:
+
+The component's options are set in the configuration `.xml` file as follows:
 
 ```xml
-<column name="ids" class="Magento\Ui\Component\MassAction\Columns\Column">
-    <argument name="data" xsi:type="array">
-        <item name="options" xsi:type="object">Magento\Catalog\Model\Product\Attribute\Source\Status</item>
-        <item name="config" xsi:type="array">
-            <item name="component" xsi:type="string">Magento_Ui/js/grid/columns/expandable</item>
-            <item name="tooltipTitle" xsi:type="string">Tooltip Title</item>
-            <item name="visibeItemsLimit" xsi:type="number">5</item>
-        </item>
-    </argument>
-</column>
+<listing>
+    ...
+    <columns>
+        ...
+        <column name="labels" class="Magento\Ui\Component\MassAction\Columns\Column">
+            <argument name="data" xsi:type="array">
+                <item name="config" xsi:type="array">
+                    <item name="component" xsi:type="string">Magento_Ui/js/grid/columns/expandable</item>
+                    <item name="tooltipTitle" xsi:type="string">Tooltip Title</item>
+                    <item name="visibeItemsLimit" xsi:type="number">2</item>
+                    <item name="options" xsi:type="array">
+                        <item name="0" xsi:type="array">
+                            <item name="value" xsi:type="number">1</item>
+                            <item name="label" xsi:type="string" translate="true">Option #1</item>
+                        </item>
+                        <item name="1" xsi:type="array">
+                            <item name="value" xsi:type="number">2</item>
+                            <item name="label" xsi:type="string" translate="true">Option #2</item>
+                        </item>
+                        <item name="2" xsi:type="array">
+                            <item name="value" xsi:type="number">3</item>
+                            <item name="label" xsi:type="string" translate="true">Option #3</item>
+                        </item>
+                    </item>
+                </item>
+            </argument>
+            <settings>
+                <label translate="true">Expandable Column Component Example</label>
+            </settings>
+        </column>
+    </columns>
+</listing>
 ```
 
+#### Result
+
+![Expandable Component example]({{ site.baseurl }}/common/images/ui_comps/ui-expandable-result.png)
+![Expandable Component expanded example]({{ site.baseurl }}/common/images/ui_comps/ui-expandable-expanded-result.png)
+
 ## Dependencies
 
 This component has a dependency on the Column component, `<Magento_Ui_module_dir>/view/base/web/js/grid/columns/column.js`.