From c94c2c9bbdff257693476c1f7a3ab6cbe4c405c7 Mon Sep 17 00:00:00 2001 From: Jakob Meissner Date: Thu, 2 May 2019 12:41:40 +0200 Subject: [PATCH 01/10] Update checkout_new_step.md Custom step is hidden when using back button --- guides/v2.1/howdoi/checkout/checkout_new_step.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/guides/v2.1/howdoi/checkout/checkout_new_step.md b/guides/v2.1/howdoi/checkout/checkout_new_step.md index f4856246f27..ad17ad2b24f 100644 --- a/guides/v2.1/howdoi/checkout/checkout_new_step.md +++ b/guides/v2.1/howdoi/checkout/checkout_new_step.md @@ -106,9 +106,11 @@ define( * The navigate() method is responsible for navigation between checkout step * during checkout. You can add custom logic, for example some conditions * for switching to your custom step + * When the user navigates to the custom step via url anchor or back button we_must show step manually here */ navigate: function () { + this.isVisible(true); }, /** From f1459ad70e756d1cd886b655a76b38df5640cdbf Mon Sep 17 00:00:00 2001 From: Hardik Makwana <35128338+hardikm-cirkleinc@users.noreply.github.com> Date: Sat, 15 Jun 2019 01:46:48 +0530 Subject: [PATCH 02/10] Add __('') method in Alert Widget For Alert widget, Add __('') method in Example because this method is used for translation of the string. --- guides/v2.1/javascript-dev-guide/widgets/widget_alert.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/guides/v2.1/javascript-dev-guide/widgets/widget_alert.md b/guides/v2.1/javascript-dev-guide/widgets/widget_alert.md index b95c4da4985..467ff8c453b 100644 --- a/guides/v2.1/javascript-dev-guide/widgets/widget_alert.md +++ b/guides/v2.1/javascript-dev-guide/widgets/widget_alert.md @@ -19,8 +19,8 @@ The alert widget can be initialized with or without binding to a certain element ```javascript $('#init_element').alert({ - title: 'Warning', - content: 'Warning content', + title: $.mage.__('Warning'), + content: $.mage.__('Warning content'), actions: { always: function(){} } @@ -34,8 +34,8 @@ require([ ], function(alert) { // Variable that represents the `alert` function alert({ - title: 'Some title', - content: 'Some content', + title: $.mage.__('Some title'), + content: $.mage.__('Some content'), actions: { always: function(){} } From 113ae86f9fb59e9fd96738310cab6c9df2912e8e Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Mon, 17 Jun 2019 11:17:17 -0500 Subject: [PATCH 03/10] Fix description of theme.xml contents --- guides/v2.1/frontend-dev-guide/themes/theme-structure.md | 2 +- guides/v2.2/frontend-dev-guide/themes/theme-structure.md | 2 +- guides/v2.3/frontend-dev-guide/themes/theme-structure.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/v2.1/frontend-dev-guide/themes/theme-structure.md b/guides/v2.1/frontend-dev-guide/themes/theme-structure.md index c5f0e70149a..da9ff9a5c73 100644 --- a/guides/v2.1/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.1/frontend-dev-guide/themes/theme-structure.md @@ -248,7 +248,7 @@ The directories and files structure described below is the most extended one. It required - The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme name and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme. + The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme title and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme. diff --git a/guides/v2.2/frontend-dev-guide/themes/theme-structure.md b/guides/v2.2/frontend-dev-guide/themes/theme-structure.md index c5f0e70149a..da9ff9a5c73 100644 --- a/guides/v2.2/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.2/frontend-dev-guide/themes/theme-structure.md @@ -248,7 +248,7 @@ The directories and files structure described below is the most extended one. It required - The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme name and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme. + The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme title and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme. diff --git a/guides/v2.3/frontend-dev-guide/themes/theme-structure.md b/guides/v2.3/frontend-dev-guide/themes/theme-structure.md index c5f0e70149a..da9ff9a5c73 100644 --- a/guides/v2.3/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.3/frontend-dev-guide/themes/theme-structure.md @@ -248,7 +248,7 @@ The directories and files structure described below is the most extended one. It required - The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme name and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme. + The file is mandatory as it declares a theme as a system component. It contains the basic meta-information, like the theme title and the parent theme name, if the theme is inherited from an existing theme. The file is used by the Magento system to recognize the theme. From 924ed95ea65fa84b3746543f65fbbfb10de1bd74 Mon Sep 17 00:00:00 2001 From: Donald Booth Date: Mon, 17 Jun 2019 15:20:17 -0500 Subject: [PATCH 04/10] Fixed up formatting errors. --- guides/v2.3/comp-mgr/patching.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/guides/v2.3/comp-mgr/patching.md b/guides/v2.3/comp-mgr/patching.md index 03082cc1998..4bf4fed7d08 100644 --- a/guides/v2.3/comp-mgr/patching.md +++ b/guides/v2.3/comp-mgr/patching.md @@ -34,7 +34,9 @@ When the [patch][] program is run, this file is read in and the specified change 1. Login to the server as the [Magento admin user][] and verify the file is in the correct directory. 1. In the command line interface, run the following commands according to the patch extension: - patch < patch_file_name.patch + ```bash + patch < patch_file_name.patch + ``` The command assumes the file to be patched is located relative to the patch file. @@ -55,7 +57,7 @@ Please refer to the [Magento Help Center][] for details on how to use Composer t [Magento Security Center]:https://magento.com/security/patches [-p1 instead of -p0]:http://man7.org/linux/man-pages/man1/patch.1.html -[Back up and roll back the file system]:https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-backup.html +[Back up and roll back the file system]:{{ page.baseurl }}/install-gde/install/cli/install-cli-backup.html [patch]:https://en.wikipedia.org/wiki/Patch_(Unix) [Magento Help Center]:https://support.magento.com/hc/en-us/articles/360005484154-Create-a-patch-for-a-Magento-2-Composer-installation-from-a-GitHub-commit -[Magento Admin user]:https://devdocs.magento.com/guides/v2.3/config-guide/cli/config-cli.html#config-install-cli-first +[Magento Admin user]:{{ page.baseurl }}/config-guide/cli/config-cli.html#config-install-cli-first From 117c0f8730c6f8894f770cff69d4bcf0b8bdd5c7 Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Tue, 18 Jun 2019 10:14:06 -0500 Subject: [PATCH 05/10] Update docs about composer-packaged themes to include naming convention --- guides/v2.1/extension-dev-guide/package/package_module.md | 2 +- guides/v2.1/frontend-dev-guide/themes/theme-structure.md | 2 +- guides/v2.2/frontend-dev-guide/themes/theme-structure.md | 2 +- guides/v2.3/frontend-dev-guide/themes/theme-structure.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/guides/v2.1/extension-dev-guide/package/package_module.md b/guides/v2.1/extension-dev-guide/package/package_module.md index bd1b348bc6e..747bc8b0b4d 100644 --- a/guides/v2.1/extension-dev-guide/package/package_module.md +++ b/guides/v2.1/extension-dev-guide/package/package_module.md @@ -27,7 +27,7 @@ The `composer.json` uses [Composer's generic schema](https://getcomposer.org/doc Element | Description --- | --- -`name` | A fully-qualified component name, in the format `/`. All letters must be in lowercase. Use dashes in the `` to separate words. +`name` | A fully-qualified component name, in the format `/`. All letters must be in lowercase. Use dashes in the `` to separate words. Themes must use the format `/theme--`. `type` | For modules, this value must be set to `magento2-module`. Other possible types are `metapackage`, `magento2-theme`, and `magento2-language`. `autoload` | Specify necessary information to be loaded, such as [registration.php]({{ page.baseurl }}/extension-dev-guide/build/component-registration.html). For more information, see [Autoloading](https://getcomposer.org/doc/01-basic-usage.md#autoloading) from Composer. diff --git a/guides/v2.1/frontend-dev-guide/themes/theme-structure.md b/guides/v2.1/frontend-dev-guide/themes/theme-structure.md index c5f0e70149a..f84763fe762 100644 --- a/guides/v2.1/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.1/frontend-dev-guide/themes/theme-structure.md @@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It optional - Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. + Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>" diff --git a/guides/v2.2/frontend-dev-guide/themes/theme-structure.md b/guides/v2.2/frontend-dev-guide/themes/theme-structure.md index c5f0e70149a..f84763fe762 100644 --- a/guides/v2.2/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.2/frontend-dev-guide/themes/theme-structure.md @@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It optional - Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. + Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>" diff --git a/guides/v2.3/frontend-dev-guide/themes/theme-structure.md b/guides/v2.3/frontend-dev-guide/themes/theme-structure.md index c5f0e70149a..f84763fe762 100644 --- a/guides/v2.3/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.3/frontend-dev-guide/themes/theme-structure.md @@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It optional - Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. + Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>" From 7a680d93a272780cc41813bb05f035937d0f8887 Mon Sep 17 00:00:00 2001 From: Tom Anderson Date: Wed, 19 Jun 2019 15:22:36 +0930 Subject: [PATCH 06/10] Fix root to be visible on Magento DevDocs website The Magento website (https://devdocs.magento.com/guides/v2.3/config-guide/cli/config-cli-subcommands-mode.html) renders the tags as html, so they are not visible to the reader. --- guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md index d75fc3fb9d4..5fab647bc89 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md @@ -125,7 +125,7 @@ When you change from production to developer mode, you should clear generated cl 1. If you're changing from production mode to developer mode, delete the contents of the `generated/code` and `generated/metadata` directories: - rm -rf /generated/metadata/* /generated/code/* + rm -rf <magento_root>/generated/metadata/* <magento_root>/generated/code/* 2. Set the mode: From 72e4ad7dbc29d7e688b60d1ab9828dbb42893a2d Mon Sep 17 00:00:00 2001 From: Tom Anderson Date: Wed, 19 Jun 2019 15:52:49 +0930 Subject: [PATCH 07/10] Add bash code block around the command --- guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md index 5fab647bc89..36e8b3882cf 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md @@ -125,8 +125,10 @@ When you change from production to developer mode, you should clear generated cl 1. If you're changing from production mode to developer mode, delete the contents of the `generated/code` and `generated/metadata` directories: - rm -rf <magento_root>/generated/metadata/* <magento_root>/generated/code/* - + ```bash + rm -rf /generated/metadata/* /generated/code/* + ``` + 2. Set the mode: ```bash From 75ac87e3458ff818bd8b10f3343d4961529b244d Mon Sep 17 00:00:00 2001 From: Andrew Levine Date: Wed, 19 Jun 2019 11:48:25 -0500 Subject: [PATCH 08/10] Apply suggestions from code review Co-Authored-By: Jeff Matthews --- guides/v2.1/frontend-dev-guide/themes/theme-structure.md | 2 +- guides/v2.2/frontend-dev-guide/themes/theme-structure.md | 2 +- guides/v2.3/frontend-dev-guide/themes/theme-structure.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/v2.1/frontend-dev-guide/themes/theme-structure.md b/guides/v2.1/frontend-dev-guide/themes/theme-structure.md index f84763fe762..14deb707264 100644 --- a/guides/v2.1/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.1/frontend-dev-guide/themes/theme-structure.md @@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It optional - Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>" + Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>". diff --git a/guides/v2.2/frontend-dev-guide/themes/theme-structure.md b/guides/v2.2/frontend-dev-guide/themes/theme-structure.md index f84763fe762..14deb707264 100644 --- a/guides/v2.2/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.2/frontend-dev-guide/themes/theme-structure.md @@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It optional - Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>" + Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>". diff --git a/guides/v2.3/frontend-dev-guide/themes/theme-structure.md b/guides/v2.3/frontend-dev-guide/themes/theme-structure.md index f84763fe762..14deb707264 100644 --- a/guides/v2.3/frontend-dev-guide/themes/theme-structure.md +++ b/guides/v2.3/frontend-dev-guide/themes/theme-structure.md @@ -230,7 +230,7 @@ The directories and files structure described below is the most extended one. It optional - Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>" + Describes the theme dependencies and some meta-information. Will be here if your theme is a Composer package. The "name" field must be in the format "<vendor-name>/theme-<area>-<theme-name>". From f3da0827abe0f4ac304d4345274f26b3e59266a0 Mon Sep 17 00:00:00 2001 From: Parth Brahmbhatt Date: Thu, 20 Jun 2019 23:37:43 +0530 Subject: [PATCH 09/10] Add content related to loader widget --- .../javascript-dev-guide/widgets/widget_loader.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/guides/v2.1/javascript-dev-guide/widgets/widget_loader.md b/guides/v2.1/javascript-dev-guide/widgets/widget_loader.md index ec7a7830a8b..8e324bc861f 100644 --- a/guides/v2.1/javascript-dev-guide/widgets/widget_loader.md +++ b/guides/v2.1/javascript-dev-guide/widgets/widget_loader.md @@ -69,7 +69,7 @@ $("#element").loader("show"); Hide the loader. -Invoke the show method: +Invoke the hide method: ```javascript $("#element").loader("hide"); @@ -84,8 +84,20 @@ Loader is subscribed to the following events: ### `processStart` {#l_processStart} Display the loader. Can be triggered on any page element. +Start show loading: + +```javascript +$("body").trigger('processStart'); +``` + ### `processStop` {#l_processStop} Hide the loader. Can be triggered on any page element. +Stop show loading: + +```javascript +$("body").trigger('processStop'); +``` + [lib/web/mage/loader.js]: {{ site.mage2bloburl }}/{{ page.guide_version }}/lib/web/mage/loader.js [JavaScript initialization]: {{page.baseurl}}/javascript-dev-guide/javascript/js_init.html From 30e0bc941e67f9c46b43f5f71bc8c27d301a4125 Mon Sep 17 00:00:00 2001 From: Hardik Makwana <35128338+hardikm-cirkleinc@users.noreply.github.com> Date: Fri, 21 Jun 2019 16:46:01 +0530 Subject: [PATCH 10/10] Add __('') method in Examples Add __('') method in Confirm Widget Example --- guides/v2.1/javascript-dev-guide/widgets/widget_confirm.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/v2.1/javascript-dev-guide/widgets/widget_confirm.md b/guides/v2.1/javascript-dev-guide/widgets/widget_confirm.md index 54a2797840c..39283341a2a 100644 --- a/guides/v2.1/javascript-dev-guide/widgets/widget_confirm.md +++ b/guides/v2.1/javascript-dev-guide/widgets/widget_confirm.md @@ -20,7 +20,7 @@ The confirmation widget can be initialized with or without binding to a certain ```javascript $('#confirm_init').confirm({ - title: 'Confirmation title', + title: $.mage.__('Confirmation title'), actions: { confirm: function(){}, //callback on 'Ok' button click cancel: function(){}, //callback on 'Cancel' button click @@ -36,8 +36,8 @@ require([ ], function(confirmation) { // Variable that represents the `confirm` widget confirmation({ - title: 'Some title', - content: 'Some content', + title: $.mage.__('Some title'), + content: $.mage.__('Some content'), actions: { confirm: function(){}, cancel: function(){},