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

Commit a0c9d39

Browse files
authored
Merge pull request #8103 from magento/small-changes
Small changes
2 parents 89f2908 + 54b49d6 commit a0c9d39

File tree

16 files changed

+126
-24
lines changed

16 files changed

+126
-24
lines changed

src/_data/codebase/v2_4/mrg/b2b/RequisitionList.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ last_modified_at: '2017-02-15 17:02:23 +0300'
77
content: "## Overview\n\nThe Magento_RequisitionList module allows a customer to create
88
multiple lists of frequently-purchased items and use those lists for order placement.
99
This feature is available for both logged-in users and guests.\n \nRequisitionList
10-
functionality is similiar to wish lists, but it has the following differences: \n\n*
10+
functionality is similar to wish lists, but it has the following differences: \n\n*
1111
A requisition list is not purged after sending items to the shopping cart. It can
1212
be used to place multiple orders.\n\n* The UI for requisition lists has been modified
1313
to a compact view in order to display large number of items. \n\nThe merchant can

src/_data/whats-new.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ entries:
526526
contributor: jeff-matthews
527527
profile: https://github.com/jeff-matthews
528528
- description: Standardized [release terminology](https://devdocs.magento.com/release/policy/)
529-
related to patch releases, hotfixes, invdividual fixes, and custom patches.
529+
related to patch releases, hotfixes, individual fixes, and custom patches.
530530
versions: 2.4.0
531531
type: Major Update
532532
date: July 27, 2020

src/cloud/cdn/fastly-vcl-allowlist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ After reviewing and updating the code for your environment, use either of the fo
114114
- Add the **VCL** snippet content:
115115

116116
```conf
117-
if ((req.url ~ "^/admin") && !(client.ip ~ allowlist) && !req.http.Fastly-FF) { error 403 "Forbidden"}
117+
if ((req.url ~ "^/admin") && !(client.ip ~ allowlist) && !req.http.Fastly-FF) { error 403 "Forbidden";}
118118
```
119119
120120
1. Click **Create** to generate the VCL snippet file with the name pattern `type_priority_name.vcl`, for example `recv_5_allowlist.vcl`

src/cloud/project/project-patch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When you update `{{ site.data.var.ct }}` or the {{ site.data.var.mcp-prod }} pac
2929

3030
{% include cloud/note-upgrade.md %}
3131

32-
The Magento Quality Patches package is a dependency for the {{ site.data.var.mcp-prod }} and {{site.data.var.ct}} packages. To apply the latest patches, you must have [the latest version of {{ site.data.var.ct }}]({{site.baseurl}}/cloud/project/ece-tools-update.html) installed.
32+
The Magento Quality Patches package is a dependency for the {{ site.data.var.mcp-prod }} and {{site.data.var.ct}} packages. To apply the latest patches, you must have [the latest version of {{ site.data.var.ct }}]({{site.baseurl}}/cloud/project/ece-tools-update.html) installed. The minimum required version of {{site.data.var.ct}} is 2002.1.2.
3333

3434
## View available patches and status
3535

src/guides/v2.3/config-guide/deployment/pipeline/technical-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,4 +309,4 @@ Next steps
309309
* [Set up your development systems]({{ page.baseurl }}/config-guide/deployment/pipeline/development-system.html)
310310
* [Set up your build system]({{ page.baseurl }}/config-guide/deployment/pipeline/build-system.html)
311311
* [Set up your production system]({{ page.baseurl }}/config-guide/deployment/pipeline/production-system.html)
312-
* [config-cli-config-set]: {{ page.baseurl }}/config-guide/cli/config-cli-subcommands-config-mgmt-set.html#config-cli-config-set
312+
* [Set configuration values]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-config-mgmt-set.html#config-cli-config-set)

src/guides/v2.3/config-guide/redis/redis-session.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ where
5050
|session-save-redis-sentinel-master|sentinel_master|Redis Sentinel master name|empty|
5151
|session-save-redis-sentinel-servers|sentinel_servers|List of Redis Sentinel servers, comma separated|empty|
5252
|session-save-redis-sentinel-verify-master|sentinel_verify_master|Verify Redis Sentinel master status flag|0 (false)|
53-
|session-save-redis-sentinel-connect-retires|sentinel_connect_retries|Connection retries for sentinels|5|
53+
|session-save-redis-sentinel-connect-retries|sentinel_connect_retries|Connection retries for sentinels|5|
5454

5555
### Example command
5656

src/guides/v2.3/extension-dev-guide/attributes.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,25 @@ use Magento\Framework\Setup\ModuleDataSetupInterface;
5858
use Magento\Framework\Setup\Patch\DataPatchInterface;
5959
use Magento\Framework\Setup\Patch\PatchVersionInterface;
6060

61+
/**
62+
* Class add customer example attribute to customer
63+
*/
6164
class AddCustomerExampleAttribute implements DataPatchInterface
6265
{
63-
66+
/**
67+
* @var ModuleDataSetupInterface
68+
*/
6469
private $moduleDataSetup;
6570

71+
/**
72+
* @var CustomerSetupFactory
73+
*/
6674
private $customerSetupFactory;
6775

76+
/**
77+
* @param ModuleDataSetupInterface $moduleDataSetup
78+
* @param CustomerSetupFactory $customerSetupFactory
79+
*/
6880
public function __construct(
6981
ModuleDataSetupInterface $moduleDataSetup,
7082
CustomerSetupFactory $customerSetupFactory
@@ -73,6 +85,9 @@ class AddCustomerExampleAttribute implements DataPatchInterface
7385
$this->customerSetupFactory = $customerSetupFactory;
7486
}
7587

88+
/**
89+
* @inheritdoc
90+
*/
7691
public function apply()
7792
{
7893
$customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);
@@ -82,7 +97,7 @@ class AddCustomerExampleAttribute implements DataPatchInterface
8297
}
8398

8499
/**
85-
* {@inheritdoc}
100+
* @inheritdoc
86101
*/
87102
public static function getDependencies()
88103
{
@@ -91,6 +106,9 @@ class AddCustomerExampleAttribute implements DataPatchInterface
91106
];
92107
}
93108

109+
/**
110+
* @inheritdoc
111+
*/
94112
public function getAliases()
95113
{
96114
return [];

src/guides/v2.3/extension-dev-guide/indexing.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,15 @@ The following figure shows the logic for partial reindexing.
8282

8383
### Indexer status {#m2devgde-indexing-status}
8484

85-
Depending on whether an index data is up to date, an indexer status value is one of the following:
85+
Depending on whether index data is up to date, an indexer status value is one of the following:
8686

87-
* valid - data is synchronized, no reindex required
88-
* invalid - the original data was changed, the index should be updated
89-
* working - indexing is in progress
87+
Database Status|Admin Status|Description
88+
`valid`|Ready|Data is synchronized, no reindex required
89+
`invalid`|Reindex Required|The original data was changed, the index should be updated
90+
`working`|Processing|Indexing is in progress
91+
92+
The database status can be seen when viewing the SQL table `indexer_state`.
93+
The admin status can be seen when viewing the indexer grid in Magento Admin or when running the index status from the CLI.
9094

9195
The Magento indexing mechanism uses the status value in reindex triggering process. You can check the status of an indexer in the [Admin](https://glossary.magento.com/admin) panel in **System >** Tools **> Index Management** or manually using the [command line]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-index.html#view-indexer-status).
9296

src/guides/v2.3/extension-dev-guide/price-adjustments.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,7 @@ class Adjustment implements AdjustmentInterface
9898
*/
9999
public function applyAdjustment($amount, SaleableInterface $saleableItem, $context = [])
100100
{
101-
$return = $amount + self::ADJUSTMENT_VALUE;
102-
return $return;
101+
return $amount + self::ADJUSTMENT_VALUE;
103102
}
104103

105104
/**

src/guides/v2.3/payments-integrations/payment-gateway/command-pool.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Following is an example of the command pool configuring for the Braintree paymen
2626

2727
```xml
2828
...
29-
<!-- BrainreeCommandPool - a command pool for the Braintree payments provider -->
29+
<!-- BraintreeCommandPool - a command pool for the Braintree payments provider -->
3030
<virtualType name="BraintreeCommandPool" type="Magento\Payment\Gateway\Command\CommandPool">
3131
<arguments>
3232
<argument name="commands" xsi:type="array">
@@ -38,7 +38,7 @@ Following is an example of the command pool configuring for the Braintree paymen
3838
</arguments>
3939
</virtualType>
4040
...
41-
<!-- Adding BrainreeCommandPool to the Braintree payment method configuration:-->
41+
<!-- Adding BraintreeCommandPool to the Braintree payment method configuration:-->
4242
<virtualType name="BraintreeFacade" type="Magento\Payment\Model\Method\Adapter">
4343
<arguments>
4444
...

src/guides/v2.3/ui_comp_guide/components/wysiwyg/add-custom-editor/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ If you are integrating Magento entities such as variable and widget as plugins,
101101

102102
After loading, modifying, and merging all configurations, Magento serializes the result into a JSON object and passes it to the UI component.
103103

104-
In your module's `view/base/requirejs-config.php` file, add a shim configuration entry for your editor in order to have RequireJS load it correctly.
104+
In your module's `view/base/requirejs-config.js` file, add a shim configuration entry for your editor in order to have RequireJS load it correctly.
105105

106106
**Example:** CKEditor\CKEditor4\view\base\requirejs-config.js
107107

src/guides/v2.4/extension-dev-guide/searching-with-repositories.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,12 +227,11 @@ class ProductCategoryFilter implements CustomFilterInterface
227227
{
228228
$value = $filter->getValue();
229229
$conditionType = $filter->getConditionType() ?: 'in';
230+
$filterValue = [$value];
230231
if (($conditionType === 'in' || $conditionType === 'nin') && is_string($value)) {
231-
$value = explode(',', $value);
232-
} else {
233-
$value = [$value];
232+
$filterValue = explode(',', $value);
234233
}
235-
$categoryFilter = [$conditionType => $value];
234+
$categoryFilter = [$conditionType => $filterValue];
236235

237236
/** @var Collection $collection */
238237
$collection->addCategoriesFilter($categoryFilter);

src/guides/v2.4/graphql/mutations/generate-customer-token.md

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
group: graphql
3+
title: generateCustomerToken mutation
4+
---
5+
6+
Use the `generateCustomerToken` mutation to create a new customer token.
7+
8+
To return or modify information about a customer, Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use [session authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication-session.html).
9+
10+
## Syntax
11+
12+
```graphql
13+
mutation {
14+
generateCustomerToken(
15+
email: String!
16+
password: String!
17+
) {
18+
CustomerToken
19+
}
20+
}
21+
```
22+
23+
## Example usage
24+
25+
The following call creates a new customer token.
26+
27+
**Request:**
28+
29+
```graphql
30+
mutation {
31+
generateCustomerToken(
32+
33+
password: "b0bl0bl@w"
34+
) {
35+
token
36+
}
37+
}
38+
```
39+
40+
**Response:**
41+
42+
```json
43+
{
44+
"data": {
45+
"generateCustomerToken": {
46+
"token": "ar4116zozoagxty1xjn4lj13kim36r6x"
47+
}
48+
}
49+
}
50+
```
51+
52+
## Input attributes
53+
54+
The `generateCustomerToken` mutation requires the following inputs:
55+
56+
Attribute | Data Type | Description
57+
--- | --- | ---
58+
`email` | String | The customer's email address
59+
`password` | String | The customer's password
60+
61+
## Output attributes
62+
63+
The `generateCustomerToken` mutation returns a valid token for the customer.
64+
65+
Attribute | Data Type | Description
66+
--- | --- | ---
67+
`token` | String | The customer token
68+
69+
## Errors
70+
71+
Error | Description
72+
--- | ---
73+
`Specify the "email" value.` | The value specified in the `email` argument is empty.
74+
`Specify the "password" value.` | The value specified value in the `password` argument is empty.
75+
`The account sign-in was incorrect or your account is disabled temporarily. Please wait and try again later.` | Authentication error. The email or password is incorrect, or the customer account is locked.
76+
77+
## Related topics
78+
79+
* [customer query]({{page.baseurl}}/graphql/queries/customer.html)
80+
* [revokeCustomerToken mutation]({{page.baseurl}}/graphql/mutations/revoke-customer-token.html)

src/guides/v2.4/performance-best-practices/configuration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ The **Developer** tab and options are only available in [Developer mode]({{ page
6363

6464
When you activate the **Enable JavaScript Bundling** option, you allow Magento to merge all JS resources into one or a set of bundles that are loaded in storefront pages. Bundling JS results in fewer requests to the server, which improves page performance. It also helps the browser cache JS resources on the first call and reuse them for all further browsing. This option also brings lazy evaluation, as all JS is loaded as text. It initiates analysis and evaluation of code only after specific actions are triggered on the page. However, this setting is not recommended for stores where the first page load time is extremely critical, because all JS content will be loaded on the first call.
6565

66+
{:.bs-callout-info}
67+
See [CSS and Javascript file optimization on Magento Commerce Cloud and Magento Commerce](https://support.magento.com/hc/en-us/articles/360044482152) in the _Magento Help Center_ for more information about optimizing CSS and Javascript.
68+
6669
### Bundling tips
6770

6871
* Magento recommends that you use third-party tools for minification and bundling (like [r.js](http://requirejs.org/)). Magento built-in mechanisms are not optimal and are shipped as fallback alternatives.

src/guides/v2.4/security/security-txt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ When security vulnerabilities are discovered by researchers, proper reporting ch
1212
Magento merchants can enter their contact information for [security issue reporting](https://docs.magento.com/user-guide/stores/security-issue-reporting.html) from the Magento _Admin_. For developers, the `Magento_Securitytxt` module provides the following functionality:
1313

1414
- Allows security configurations to be saved from the _Admin_.
15-
- Contains a router to match application action class for requests to the `well-known/security.txt` and `.well-known/security.txt.sig` files.
15+
- Contains a router to match application action class for requests to the `.well-known/security.txt` and `.well-known/security.txt.sig` files.
1616
- Serves the content of the `.well-known/security.txt` and `.well-known/security.txt.sig` files.
1717

1818
A valid `security.txt` file might look like the following:

src/marketplace/sellers/extension-create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Magento Marketplace does not support encrypted extensions at this time.
2525

2626
Testing your extension in advance reduces the time it takes to pass Technical Review. For a list of code sniffer rules, see [Magento Extension Quality Program Coding Standard][2].
2727

28-
1. Prepare, validate, and zip your extension as described in Packaging a Component for Magento version [2.x]({{ site.baseurl }}/guides/v2.3/extension-dev-guide/package/package_module.html) or [1.x]({{ site.baseurl }}/marketplace/sellers/packaging-v1x-extensions.html).
28+
1. Prepare, validate, and zip your extension as described in [Packaging a Component]({{site.baseurl}}/guides/v2.4/extension-dev-guide/package/package_module.html).
2929

3030
1. Prepare the following preliminary documentation:
3131

0 commit comments

Comments
 (0)