diff --git a/src/_includes/graphql/create-customer.md b/src/_includes/graphql/create-customer.md index f13cae5ebff..002bc849f85 100644 --- a/src/_includes/graphql/create-customer.md +++ b/src/_includes/graphql/create-customer.md @@ -1,6 +1,6 @@ Attribute | Data Type | Description --- | --- | --- -`date_of_birth` | String | The customer’s date of birth +`date_of_birth` | String | The customer’s date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. `dob` | String | Deprecated. Use `date_of_birth` instead. The customer’s date of birth `email` | String | The customer’s email address. Required to create a customer `firstname` | String | The customer’s first name. Required to create a customer diff --git a/src/_includes/graphql/customer-input-24.md b/src/_includes/graphql/customer-input-24.md index 7a2e79a4718..5c4125b74f4 100644 --- a/src/_includes/graphql/customer-input-24.md +++ b/src/_includes/graphql/customer-input-24.md @@ -2,7 +2,7 @@ Attribute | Data Type | Description --- | --- | --- `addresses` | [CustomerAddress](#customerAddressInput) | An array containing the customer's shipping and billing addresses `created_at` | String | Timestamp indicating when the account was created -`date_of_birth` | String | The customer's date of birth +`date_of_birth` | String | The customer's date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. `default_billing` | String | The ID assigned to the billing address `default_shipping` | String | The ID assigned to the shipping address `dob` | String | Deprecated. Use `date_of_birth` instead. The customer's date of birth diff --git a/src/_includes/graphql/customer-input.md b/src/_includes/graphql/customer-input.md index 7ce006d1ae2..bdb11b0534c 100644 --- a/src/_includes/graphql/customer-input.md +++ b/src/_includes/graphql/customer-input.md @@ -2,7 +2,7 @@ Attribute | Data Type | Description --- | --- | --- `addresses` | [CustomerAddress](#customerAddressInput) | An array containing the customer's shipping and billing addresses `created_at` | String | Timestamp indicating when the account was created -`date_of_birth` | String | The customer's date of birth +`date_of_birth` | String | The customer's date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. `default_billing` | String | The ID assigned to the billing address `default_shipping` | String | The ID assigned to the shipping address `dob` | String | Deprecated. Use `date_of_birth` instead. The customer's date of birth diff --git a/src/_includes/graphql/customer-output-24.md b/src/_includes/graphql/customer-output-24.md index 0e09afb212b..282b0304627 100644 --- a/src/_includes/graphql/customer-output-24.md +++ b/src/_includes/graphql/customer-output-24.md @@ -19,7 +19,7 @@ Attribute | Data Type | Description `addresses` | {{ customeraddress_text }} | An array containing the customer's shipping and billing addresses `allow_remote_shopping_assistance` | Boolean! | Indicates whether the customer has enabled remote shopping assistance `created_at` | String | Timestamp indicating when the account was created -`date_of_birth` | String | The customer's date of birth +`date_of_birth` | String | The customer's date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. `default_billing` | String | The ID assigned to the billing address `default_shipping` | String | The ID assigned to the shipping address `dob` | String | Deprecated. Use `date_of_birth` instead. The customer's date of birth diff --git a/src/_includes/graphql/customer-output.md b/src/_includes/graphql/customer-output.md index f6d43aaa16b..8f4033a15f3 100644 --- a/src/_includes/graphql/customer-output.md +++ b/src/_includes/graphql/customer-output.md @@ -2,7 +2,7 @@ Attribute | Data Type | Description --- | --- | --- `addresses` | [CustomerAddress](#customerAddressOutput) | An array containing the customer's shipping and billing addresses `created_at` | String | Timestamp indicating when the account was created -`date_of_birth` | String | The customer's date of birth +`date_of_birth` | String | The customer's date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. `default_billing` | String | The ID assigned to the billing address `default_shipping` | String | The ID assigned to the shipping address `dob` | String | Deprecated. Use `date_of_birth` instead. The customer's date of birth diff --git a/src/cloud/howtos/debug.md b/src/cloud/howtos/debug.md index ae3a94be592..0cd9891b4e6 100644 --- a/src/cloud/howtos/debug.md +++ b/src/cloud/howtos/debug.md @@ -91,7 +91,7 @@ To configure PhpStorm to work with Xdebug: 1. In your PhpStorm project, open the settings panel. - - _Mac OS X_—Select **File** > **Preferences**. + - _Mac OS X_—Select **PhpStorm** > **Preferences**. - _Windows/Linux_—Select **File** > **Settings**. 1. In the _Settings_ panel, expand and locate the **Languages & Frameworks** > **PHP** > **Servers** section. diff --git a/src/compliance/privacy/pi-data-reference-m2.md b/src/compliance/privacy/pi-data-reference-m2.md index d64e67ca867..ef2cfc509a5 100644 --- a/src/compliance/privacy/pi-data-reference-m2.md +++ b/src/compliance/privacy/pi-data-reference-m2.md @@ -45,7 +45,7 @@ Magento 2 primarily stores customer-specific information in customer, address, o ### Customer data {#customer-data} -Magento 2 stores the following customer attributes: +Magento 2 can be figured to store the following customer attributes: - Date of Birth - Email @@ -56,6 +56,9 @@ Magento 2 stores the following customer attributes: - Name Prefix - Name Suffix +{:.bs-callout-info} +In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. + #### `customer_entity` and 'customer_entity' references The following columns in the `customer_entity` table contain customer information: diff --git a/src/guides/v2.3/config-guide/prod/config-reference-most.md b/src/guides/v2.3/config-guide/prod/config-reference-most.md index 11cad8be728..7d79989499e 100644 --- a/src/guides/v2.3/config-guide/prod/config-reference-most.md +++ b/src/guides/v2.3/config-guide/prod/config-reference-most.md @@ -405,7 +405,7 @@ Prefix Dropdown Options | `customer/address/prefix_options` | | Show Suffix | `customer/address/suffix_show` | | Suffix Dropdown Options | `customer/address/suffix_options` | | -Show Date of Birth | `customer/address/dob_show` | | +Show Date of Birth | `customer/address/dob_show`
In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data.| | Show Tax/VAT Number | `customer/address/taxvat_show` | | Show Gender | `customer/address/gender_show` | | Enable Store Credit Functionality | `customer/magento_customerbalance/is_enabled` | ![EE-only]({{ site.baseurl }}/common/images/cloud_ee.png) | diff --git a/src/guides/v2.3/extension-dev-guide/configuration/sensitive-and-environment-settings.md b/src/guides/v2.3/extension-dev-guide/configuration/sensitive-and-environment-settings.md index c800f41797e..949d6459c45 100644 --- a/src/guides/v2.3/extension-dev-guide/configuration/sensitive-and-environment-settings.md +++ b/src/guides/v2.3/extension-dev-guide/configuration/sensitive-and-environment-settings.md @@ -28,6 +28,9 @@ Examples of sensitive information include: * E-mail addresses * Any personally identifiable information (e.g., address, phone number, date of birth, government identification number, etc.) +{:.bs-callout-info} +In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. + ### Environment or system-specific values _Environment_ or _system-specific_ values are unique to the system where Magento is deployed. diff --git a/src/guides/v2.3/frontend-dev-guide/themes/theme-structure.md b/src/guides/v2.3/frontend-dev-guide/themes/theme-structure.md index 8df4a68c53c..e49ab0ccb0e 100644 --- a/src/guides/v2.3/frontend-dev-guide/themes/theme-structure.md +++ b/src/guides/v2.3/frontend-dev-guide/themes/theme-structure.md @@ -282,7 +282,7 @@ The key difference between static files and other theme files is that static fil Static view files that can be accessed by a direct link from the storefront, are distinguished as public theme files. {:.bs-callout-info} - To be actually accessible for browsers public static files are [published]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-static-view.html#config-cli-static-overview) to the `/pub/static/frontend////css/` directory. + To be actually accessible for browsers public static files are [published]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-static-view.html#config-cli-static-overview) to the `/pub/static/frontend////css/` directory. ### Dynamic view files diff --git a/src/guides/v2.3/graphql/develop/resolvers.md b/src/guides/v2.3/graphql/develop/resolvers.md index dabb2ca39f7..787d805f236 100644 --- a/src/guides/v2.3/graphql/develop/resolvers.md +++ b/src/guides/v2.3/graphql/develop/resolvers.md @@ -284,7 +284,7 @@ input CustomerInput { lastname: String @doc(description: "The customer's family name") suffix: String @doc(description: "A value such as Sr., Jr., or III") email: String @doc(description: "The customer's email address. Required") - date_of_birth: String @doc(description: "The customer's date of birth") + date_of_birth: String @doc(description: "The customer's date of birth.") taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers)") gender: Int @doc(description: "The customer's gender(Male - 1, Female - 2)") password: String @doc(description: "The customer's password") @@ -292,6 +292,9 @@ input CustomerInput { } ``` +{:.bs-callout-info} +In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. + The `createCustomer` mutation returns `CustomerOutput` object ```text @@ -319,7 +322,9 @@ type Customer @doc(description: "Customer defines the customer name and address addresses: [CustomerAddress] @doc(description: "An array containing the customer's shipping and billing addresses") gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2)") } -``` + +{:.bs-callout-info} +In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. The following example shows the `createCustomer` mutation in action: diff --git a/src/guides/v2.3/graphql/queries/category.md b/src/guides/v2.3/graphql/queries/category.md index b7bb3d6155d..d383d685f0f 100644 --- a/src/guides/v2.3/graphql/queries/category.md +++ b/src/guides/v2.3/graphql/queries/category.md @@ -212,3 +212,10 @@ The query returns a `CategoryTree` object, which implements [`CategoryInterface` Attribute | Data type | Description --- | --- | --- `children` | `CategoryTree` | An array containing the next level of subcategories. By default, you can specify up to 10 levels of child categories + +## Errors + +Error | Description +--- | --- +`Category doesn't exist` | The specified category ID value does not exist. +`Field "category" argument "id" requires type Int, found "XXX"` | The specified `id` argument value has the wrong type. \ No newline at end of file diff --git a/src/guides/v2.3/graphql/queries/directory-country.md b/src/guides/v2.3/graphql/queries/directory-country.md index 6b1f6ed8e05..f9a26b67cb2 100644 --- a/src/guides/v2.3/graphql/queries/directory-country.md +++ b/src/guides/v2.3/graphql/queries/directory-country.md @@ -112,3 +112,10 @@ The query returns a single `Country` object. * [countries query]({{page.baseurl}}/graphql/queries/directory-countries.html) * [currency query]({{page.baseurl}}/graphql/queries/directory-currency.html) + +## Errors + +Error | Description +--- | --- +`Country \"id\" value should be specified"` | The Country ID value must be specified to find the mapped country. +`The country isn't available` | There is no country mapped to the given country ID. diff --git a/src/guides/v2.3/howdoi/checkout/checkout_new_step.md b/src/guides/v2.3/howdoi/checkout/checkout_new_step.md index b82485e821d..ce20fdb8ec4 100644 --- a/src/guides/v2.3/howdoi/checkout/checkout_new_step.md +++ b/src/guides/v2.3/howdoi/checkout/checkout_new_step.md @@ -29,7 +29,7 @@ To create the view part of the new checkout step: 1. Add a module directory (not covered in this topic). See [Build your module]({{ page.baseurl }}/extension-dev-guide/build/build.html) for details). All custom files must be stored there. For your checkout customization to be applied correctly, your custom module should depend on the `Magento_Checkout` module. Do not use `Ui` for your custom module name, because `%Vendor%_Ui` notation, required when specifying paths, might cause issues. 1. [Create the `.js` file implementing the view model](#component). -1. [Create an `.html` template for the component](#html-template). +1. [Create a `.html` template for the component](#html-template). ### Add the JavaScript file implementing the new step {#component} @@ -37,91 +37,81 @@ A new checkout step must be implemented as UI component. That is, its [JavaScrip The file must be stored under the `/view/frontend/web/js/view` directory. - {:.bs-callout-info} +{:.bs-callout-info} `` notation stands for the path to your module directory from the root directory. Usually it will be one of the following: `app/code//` or `vendor//module--`. For more details see [Conventional notations for paths to modules and themes]({{ page.baseurl }}/frontend-dev-guide/conventions.html) A sample `my-step-view.js` with comments follows: ```js -define( - [ - 'ko', - 'uiComponent', - 'underscore', - 'Magento_Checkout/js/model/step-navigator' - ], - function ( - ko, - Component, - _, - stepNavigator - ) { - 'use strict'; +define([ + 'ko', + 'uiComponent', + 'underscore', + 'Magento_Checkout/js/model/step-navigator' +], function (ko, Component, _, stepNavigator) { + 'use strict'; + + /** + * mystep - is the name of the component's .html template, + * _ - is the name of your module directory. + */ + return Component.extend({ + defaults: { + template: '_/mystep' + }, + + // add here your logic to display step, + isVisible: ko.observable(true), + + /** + * @returns {*} + */ + initialize: function () { + this._super(); + + // register your step + stepNavigator.registerStep( + // step code will be used as step content id in the component template + 'step_code', + // step alias + null, + // step title value + 'Step Title', + // observable property with logic when display step or hide step + this.isVisible, + + _.bind(this.navigate, this), + + /** + * sort order value + * 'sort order value' < 10: step displays before shipping step; + * 10 < 'sort order value' < 20 : step displays between shipping and payment step + * 'sort order value' > 20 : step displays after payment step + */ + 15 + ); + + return this; + }, + + /** + * The navigate() method is responsible for navigation between checkout steps + * 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); + }, + /** - * - * mystep - is the name of the component's .html template, - * _ - is the name of the your module directory. - * - */ - return Component.extend({ - defaults: { - template: '_/mystep' - }, - - //add here your logic to display step, - isVisible: ko.observable(true), - - /** - * - * @returns {*} - */ - initialize: function () { - this._super(); - // register your step - stepNavigator.registerStep( - //step code will be used as step content id in the component template - 'step_code', - //step alias - null, - //step title value - 'Step Title', - //observable property with logic when display step or hide step - this.isVisible, - - _.bind(this.navigate, this), - - /** - * sort order value - * 'sort order value' < 10: step displays before shipping step; - * 10 < 'sort order value' < 20 : step displays between shipping and payment step - * 'sort order value' > 20 : step displays after payment step - */ - 15 - ); - - return this; - }, - - /** - * 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); - }, - - /** - * @returns void - */ - navigateToNextStep: function () { - stepNavigator.next(); - } - }); - } -); + * @returns void + */ + navigateToNextStep: function () { + stepNavigator.next(); + } + }); +}); ``` ### Add the .html template {#html-template} @@ -133,7 +123,7 @@ A sample `mystep.html` follows: ```html
  • -
    +
    @@ -163,31 +153,31 @@ A sample `checkout_index_index.xml` follows: - - - - - - - - - - %Vendor%_%Module%/js/view/my-step-view - - - - 2 - - - + + + + + + + + + + %Vendor%_%Module%/js/view/my-step-view + + + + 2 + + - - + + + @@ -195,7 +185,7 @@ A sample `checkout_index_index.xml` follows: ## Step 3: Create mixins for payment and shipping steps (optional) {#create-mixin} -If your new step is the first step, you have to create mixins for the payment and shipping steps. Otherwise two steps will be activated on loading of the checkout. +If your new step is the first step, you have to create mixins for the payment and shipping steps. Otherwise, two steps will be activated on the loading of the checkout. Create a mixin as follows: @@ -219,28 +209,27 @@ Create a mixin as follows: 1. Create the mixin. We'll use the same mixin for both payment and shipping: ```js - define( - [ - 'ko' - ], function (ko) { - 'use strict'; - - var mixin = { - - initialize: function () { - this.isVisible = ko.observable(false); // set visible to be initially false to have your step show first - this._super(); - - return this; - } - }; - - return function (target) { - return target.extend(mixin); - }; - } - ); + define([ + 'ko' + ], function (ko) { + 'use strict'; + + var mixin = { + + initialize: function () { + // set visible to be initially false to have your step show first + this.isVisible = ko.observable(false); + this._super(); + + return this; + } + }; + + return function (target) { + return target.extend(mixin); + }; + }); ``` - {:.bs-callout-info} +{:.bs-callout-info} For your changes to be applied, you might need to [clean layout cache]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-cache.html ) and [static view file cache]({{ page.baseurl }}/frontend-dev-guide/cache_for_frontdevs.html#clean_static_cache). For more info on mixins, see [JS Mixins]({{ page.baseurl }}/javascript-dev-guide/javascript/js_mixins.html). diff --git a/src/guides/v2.3/javascript-dev-guide/javascript/js-resources.md b/src/guides/v2.3/javascript-dev-guide/javascript/js-resources.md index 0aee01f324a..168449f0439 100644 --- a/src/guides/v2.3/javascript-dev-guide/javascript/js-resources.md +++ b/src/guides/v2.3/javascript-dev-guide/javascript/js-resources.md @@ -37,7 +37,7 @@ JS resources are accessed using relative paths. **Example 1:** * File actual location: `app/code/Magento/ConfigurableProduct/view/frontend/web/js/configurable.js` -* File published to `pub/static`: `pub/static/frontend/Magento///Magento_ConfigurableProduct/js/configurable.js`. Here `` and `` are the currently applied in your instance [theme](https://glossary.magento.com/theme) and [locale](https://glossary.magento.com/locale). +* File published to `pub/static`: `pub/static/frontend////Magento_ConfigurableProduct/js/configurable.js`. Here `` and `` are the currently applied in your instance [theme](https://glossary.magento.com/theme) and [locale](https://glossary.magento.com/locale). * Called in script: ```javascript @@ -59,7 +59,7 @@ JS resources are accessed using relative paths. **Example 3:** * File actual location: `lib/web/jquery.js` -* File published to `pub/static`: `pub/static//Magento///jquery.js` +* File published to `pub/static`: `pub/static/////jquery.js` * Called in script: ```javascript diff --git a/src/guides/v2.4/config-guide/prod/config-reference-most.md b/src/guides/v2.4/config-guide/prod/config-reference-most.md index 97ddefd0b9c..3d7e108932a 100644 --- a/src/guides/v2.4/config-guide/prod/config-reference-most.md +++ b/src/guides/v2.4/config-guide/prod/config-reference-most.md @@ -406,7 +406,7 @@ Prefix Dropdown Options | `customer/address/prefix_options` | | Show Suffix | `customer/address/suffix_show` | | Suffix Dropdown Options | `customer/address/suffix_options` | | -Show Date of Birth | `customer/address/dob_show` | | +Show Date of Birth | `customer/address/dob_show`
    In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data.| | Show Tax/VAT Number | `customer/address/taxvat_show` | | Show Gender | `customer/address/gender_show` | | Enable Store Credit Functionality | `customer/magento_customerbalance/is_enabled` | ![EE-only]({{ site.baseurl }}/common/images/cloud_ee.png) | diff --git a/src/guides/v2.4/graphql/mutations/create-customer-v2.md b/src/guides/v2.4/graphql/mutations/create-customer-v2.md index 91713681c3c..df91f21d72e 100644 --- a/src/guides/v2.4/graphql/mutations/create-customer-v2.md +++ b/src/guides/v2.4/graphql/mutations/create-customer-v2.md @@ -62,7 +62,7 @@ The following table lists the attributes you can use as input for the `createCus Attribute | Data Type | Description --- | --- | --- `allow_remote_shopping_assistance` | Boolean | Indicates whether the customer has enabled remote shopping assistance -`date_of_birth` | String | The customer’s date of birth +`date_of_birth` | String | The customer’s date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. `dob` | String | Deprecated. Use `date_of_birth` instead. The customer’s date of birth `email` | String! | The customer’s email address `firstname` | String! | The customer’s first name diff --git a/src/guides/v2.4/graphql/mutations/update-customer-v2.md b/src/guides/v2.4/graphql/mutations/update-customer-v2.md index 3f73fec468e..ca52c8e33c1 100644 --- a/src/guides/v2.4/graphql/mutations/update-customer-v2.md +++ b/src/guides/v2.4/graphql/mutations/update-customer-v2.md @@ -57,7 +57,7 @@ The following table lists the attributes you can use as input for the `updateCus Attribute | Data Type | Description --- | --- | --- `allow_remote_shopping_assistance` | Boolean | Indicates whether the customer has enabled remote shopping assistance -`date_of_birth` | String | The customer’s date of birth +`date_of_birth` | String | The customer’s date of birth. In keeping with current security and privacy best practices, be sure you are aware of any potential legal and security risks associated with the storage of customers’ full date of birth (month, day, year) along with other personal identifiers, such as full name, before collecting or processing such data. `dob` | String | Deprecated. Use `date_of_birth` instead. The customer’s date of birth `firstname` | String | The customer’s first name `gender` | Int | The customer's gender (Male - 1, Female - 2) diff --git a/src/guides/v2.4/graphql/queries/category.md b/src/guides/v2.4/graphql/queries/category.md index 0cfcb903a27..420b3249f2e 100644 --- a/src/guides/v2.4/graphql/queries/category.md +++ b/src/guides/v2.4/graphql/queries/category.md @@ -210,3 +210,10 @@ The query returns a `CategoryTree` object, which implements [`CategoryInterface` Attribute | Data type | Description --- | --- | --- `children` | `CategoryTree` | An array containing the next level of subcategories. By default, you can specify up to 10 levels of child categories + +## Errors + +Error | Description +--- | --- +`Category doesn't exist` | The specified category ID value does not exist. +`Field "category" argument "id" requires type Int, found "XXX"` | The specified `id` argument value has the wrong type. \ No newline at end of file