Skip to content

Commit 2920500

Browse files
dshevtsovdshevtsov
committed
Fix links to docs and Markdown formatting
1 parent d2bacc2 commit 2920500

File tree

147 files changed

+518
-341
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+518
-341
lines changed

Diff for: ‎.github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ For more detailed information on contribution please read our [beginners guide](
1515

1616
## Contribution requirements
1717

18-
1. Contributions must adhere to the [Magento coding standards](https://devdocs.magento.com/guides/v2.4/coding-standards/bk-coding-standards.html).
18+
1. Contributions must adhere to the [Magento coding standards](https://developer.adobe.com/commerce/php/coding-standards/).
1919
2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request being merged quickly and without additional clarification requests.
2020
3. Commits must be accompanied by meaningful commit messages. Please see the [Magento Pull Request Template](https://github.com/magento/magento2/blob/HEAD/.github/PULL_REQUEST_TEMPLATE.md) for more information.
2121
4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug.

Diff for: ‎README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ However, for those who need a full-featured eCommerce solution, we recommend [Ad
2626

2727
## Contribute
2828

29-
Our [Community](https://opensource.magento.com/) is large and diverse, and our project is enormous. As a contributor, you have countless opportunities to impact product development and delivery by introducing new features or improving existing ones, enhancing test coverage, updating documentation for [developers](https://devdocs.magento.com/) and [end-users](https://docs.magento.com/user-guide/), catching and fixing code bugs, suggesting points for optimization, and sharing your great ideas.
29+
Our [Community](https://opensource.magento.com/) is large and diverse, and our project is enormous. As a contributor, you have countless opportunities to impact product development and delivery by introducing new features or improving existing ones, enhancing test coverage, updating documentation for [developers](https://developer.adobe.com/commerce/docs/) and [end-users](https://docs.magento.com/user-guide/), catching and fixing code bugs, suggesting points for optimization, and sharing your great ideas.
3030

3131
- [Contribute to the code](https://developer.adobe.com/commerce/contributor/guides/code-contributions/)
3232
- [Report an issue](https://developer.adobe.com/commerce/contributor/guides/code-contributions/#report)
@@ -36,7 +36,7 @@ Our [Community](https://opensource.magento.com/) is large and diverse, and our p
3636

3737
### Maintainers
3838

39-
We encourage experts from the Community to help us with GitHub routines such as accepting, merging, or rejecting pull requests and reviewing issues. Adobe has granted the Community Maintainers permission to accept, merge, and reject pull requests, as well as review issues. Thanks to invaluable input from the Community Maintainers team, we can significantly improve contribution quality and accelerate the time to deliver your updates to production.
39+
We encourage experts from the Community to help us with GitHub routines such as accepting, merging, or rejecting pull requests and reviewing issues. Adobe has granted the Community Maintainers permission to accept, merge, and reject pull requests, as well as review issues. Thanks to invaluable input from the Community Maintainers team, we can significantly improve contribution quality and accelerate the time to deliver your updates to production.
4040

4141
- [Learn more about the Maintainer role](https://developer.adobe.com/commerce/contributor/guides/maintainers/)
4242
- [Maintainer's Handbook](https://developer.adobe.com/commerce/contributor/guides/maintainers/handbook/)
@@ -64,9 +64,9 @@ Stay up-to-date on the latest security news and patches by signing up for [Secur
6464
## Licensing
6565

6666
Each Magento source file included in this distribution is licensed under OSL 3.0 or the terms and conditions of the applicable ordering document between Licensee/Customer and Adobe (or Magento).
67-
67+
6868
[Open Software License (OSL 3.0)](https://opensource.org/licenses/osl-3.0.php) – Please see [LICENSE.txt](LICENSE.txt) for the full text of the OSL 3.0 license.
69-
69+
7070
Subject to Licensee's/Customer's payment of fees and compliance with the terms and conditions of the applicable ordering document between Licensee/Customer and Adobe (or Magento), the terms and conditions of the applicable ordering between Licensee/Customer and Adobe (or Magento) supersede the OSL 3.0 license for each source file.
7171

7272
## Communications

Diff for: ‎app/bootstrap.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@
1717
if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 80100) {
1818
if (PHP_SAPI == 'cli') {
1919
echo 'Magento supports PHP 8.1.0 or later. ' .
20-
'Please read https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements-tech.html';
20+
'Please read https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html';
2121
} else {
2222
echo <<<HTML
2323
<div style="font:12px/1.35em arial, helvetica, sans-serif;">
2424
<p>Magento supports PHP 8.1.0 or later. Please read
25-
<a target="_blank" href="https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements-tech.html">
25+
<a target="_blank" href="https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html">
2626
Magento System Requirements</a>.
2727
</div>
2828
HTML;

Diff for: ‎app/code/Magento/AdminAnalytics/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The Magento\AdminAnalytics module gathers information about the features Magento administrators use. This information will be used to help improve the user experience on the Magento Admin.
1+
The Magento\AdminAnalytics module gathers information about the features Magento administrators use. This information will be used to help improve the user experience on the Magento Admin.

Diff for: ‎app/code/Magento/CacheInvalidate/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
The CacheInvalidate module is used to invalidate the Varnish cache if it is configured.
2-
It listens for events that request the cache to be flushed or cause the cache to be invalid, then sends Varnish a purge request using cURL.
2+
It listens for events that request the cache to be flushed or cause the cache to be invalid, then sends Varnish a purge request using cURL.

Diff for: ‎app/code/Magento/Captcha/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The Captcha module allows applying Turing test in the process of user authentication or similar tasks.
1+
The Captcha module allows applying Turing test in the process of user authentication or similar tasks.

Diff for: ‎app/code/Magento/CardinalCommerce/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The CardinalCommerce module provides a possibility to enable 3-D Secure 2.0 support for payment methods.
1+
The CardinalCommerce module provides a possibility to enable 3-D Secure 2.0 support for payment methods.

Diff for: ‎app/code/Magento/Catalog/README.md

+62-60
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
#Magento_Catalog
1+
# Magento_Catalog
2+
23
Magento_Catalog module functionality is represented by the following sub-systems:
3-
- Products Management. It includes CRUD operation of product, product media, product attributes, etc...
4-
- Category Management. It includes CRUD operation of category, category attributes
4+
5+
- Products Management. It includes CRUD operation of product, product media, product attributes, etc...
6+
- Category Management. It includes CRUD operation of category, category attributes
57

68
Catalog module provides mechanism for creating new product type in the system.
79
Catalog module provides API filtering that allows to limit product selection with advanced filters.
@@ -12,61 +14,61 @@ Catalog module provides API filtering that allows to limit product selection wit
1214
(https://developer.adobe.com/commerce/php/development/build/component-file-structure/).
1315

1416
## Observer
17+
1518
This module observes the following events:
16-
`etc/events.xml`
17-
`magento_catalog_api_data_productinterface_save_before` event in
18-
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
19-
`magento_catalog_api_data_productinterface_save_after` event in
20-
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
21-
`magento_catalog_api_data_productinterface_delete_before` event in
22-
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
23-
`magento_catalog_api_data_productinterface_delete_after` event in
24-
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
25-
`magento_catalog_api_data_productinterface_load_after` event in
26-
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
27-
`magento_catalog_api_data_categoryinterface_save_before` event in
28-
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
29-
`magento_catalog_api_data_categoryinterface_save_after` event in
30-
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
31-
`magento_catalog_api_data_categoryinterface_save_after` event in
32-
`Magento\Catalog\Observer\InvalidateCacheOnCategoryDesignChange` file.
33-
`magento_catalog_api_data_categoryinterface_delete_before` event in
34-
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
35-
`magento_catalog_api_data_categoryinterface_delete_after` event in
36-
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
37-
`magento_catalog_api_data_categoryinterface_load_after` event in
38-
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
39-
`magento_catalog_api_data_categorytreeinterface_save_before` event in
40-
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
41-
`magento_catalog_api_data_categorytreeinterface_save_after` event in
42-
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
43-
`magento_catalog_api_data_categorytreeinterface_delete_before` event in
44-
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
45-
`magento_catalog_api_data_categorytreeinterface_delete_after` event in
46-
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
47-
`magento_catalog_api_data_categorytreeinterface_load_after` event in
48-
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
49-
`admin_system_config_changed_section_catalog` event in
50-
`Magento\Catalog\Observer\SwitchPriceAttributeScopeOnConfigChange` file.
51-
`catalog_product_save_before` event in
52-
`Magento\Catalog\Observer\SetSpecialPriceStartDate` file.
53-
`store_save_after` event in
54-
`Magento\Catalog\Observer\SynchronizeWebsiteAttributesOnStoreChange` file.
55-
`catalog_product_save_commit_after` event in
56-
`Magento\Catalog\Observer\ImageResizeAfterProductSave` file.
57-
`catalog_category_prepare_save` event in
58-
`Magento\Catalog\Observer\CategoryDesignAuthorization` file.
59-
60-
`/etc/frontend/events.xml`
61-
`customer_login` event in
62-
`Magento\Catalog\Observer\Compare\BindCustomerLoginObserver` file.
63-
`customer_logout` event in
64-
`Magento\Catalog\Observer\Compare\BindCustomerLogoutObserver` file.
65-
66-
`/etc/adminhtml/events.xml`
67-
`cms_wysiwyg_images_static_urls_allowed` event in
68-
`Magento\Catalog\Observer\CatalogCheckIsUsingStaticUrlsAllowedObserver` file.
69-
`catalog_category_change_products` event in
70-
`Magento\Catalog\Observer\CategoryProductIndexer` file.
71-
`category_move` event in
72-
`Magento\Catalog\Observer\FlushCategoryPagesCache`
19+
20+
- `etc/events.xml`
21+
- `magento_catalog_api_data_productinterface_save_before` event in
22+
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
23+
- `magento_catalog_api_data_productinterface_save_after` event in
24+
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
25+
- `magento_catalog_api_data_productinterface_delete_before` event in
26+
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
27+
- `magento_catalog_api_data_productinterface_delete_after` event in
28+
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
29+
- `magento_catalog_api_data_productinterface_load_after` event in
30+
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
31+
- `magento_catalog_api_data_categoryinterface_save_before` event in
32+
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
33+
- `magento_catalog_api_data_categoryinterface_save_after` event in
34+
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
35+
- `magento_catalog_api_data_categoryinterface_save_after` event in
36+
`Magento\Catalog\Observer\InvalidateCacheOnCategoryDesignChange` file.
37+
- `magento_catalog_api_data_categoryinterface_delete_before` event in
38+
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
39+
- `magento_catalog_api_data_categoryinterface_delete_after` event in
40+
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
41+
- `magento_catalog_api_data_categoryinterface_load_after` event in
42+
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
43+
- `magento_catalog_api_data_categorytreeinterface_save_before` event in
44+
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
45+
- `magento_catalog_api_data_categorytreeinterface_save_after` event in
46+
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
47+
- `magento_catalog_api_data_categorytreeinterface_delete_before` event in
48+
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
49+
- `magento_catalog_api_data_categorytreeinterface_delete_after` event in
50+
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
51+
- `magento_catalog_api_data_categorytreeinterface_load_after` event in
52+
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
53+
`admin_system_config_changed_section_catalog` event in
54+
`Magento\Catalog\Observer\SwitchPriceAttributeScopeOnConfigChange` file.
55+
- `catalog_product_save_before` event in
56+
`Magento\Catalog\Observer\SetSpecialPriceStartDate` file.
57+
`store_save_after` event in
58+
`Magento\Catalog\Observer\SynchronizeWebsiteAttributesOnStoreChange` file.
59+
- `catalog_product_save_commit_after` event in
60+
`Magento\Catalog\Observer\ImageResizeAfterProductSave` file.
61+
- `catalog_category_prepare_save` event in
62+
`Magento\Catalog\Observer\CategoryDesignAuthorization` file.
63+
- `/etc/frontend/events.xml`
64+
- `customer_login` event in
65+
`Magento\Catalog\Observer\Compare\BindCustomerLoginObserver` file.
66+
- `customer_logout` event in
67+
`Magento\Catalog\Observer\Compare\BindCustomerLogoutObserver` file.
68+
- `/etc/adminhtml/events.xml`
69+
`cms_wysiwyg_images_static_urls_allowed` event in
70+
`Magento\Catalog\Observer\CatalogCheckIsUsingStaticUrlsAllowedObserver` file.
71+
- `catalog_category_change_products` event in
72+
`Magento\Catalog\Observer\CategoryProductIndexer` file.
73+
- `category_move` event in
74+
`Magento\Catalog\Observer\FlushCategoryPagesCache`

Diff for: ‎app/code/Magento/CatalogCmsGraphQl/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# CatalogCmsGraphQl
22

3-
**CatalogCmsGraphQl** provides type and resolver information for GraphQL attributes that have dependencies on the Catalog and Cms modules.
3+
**CatalogCmsGraphQl** provides type and resolver information for GraphQL attributes that have dependencies on the Catalog and Cms modules.

Diff for: ‎app/code/Magento/CatalogCustomerGraphQl/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# CatalogCustomerGraphQl
22

3-
**CatalogCustomerGraphQl** provides type and resolver information for GraphQL attributes that have dependences on the Catalog and Customer modules.
3+
**CatalogCustomerGraphQl** provides type and resolver information for GraphQL attributes that have dependences on the Catalog and Customer modules.

Diff for: ‎app/code/Magento/CatalogRuleGraphQl/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# CatalogRuleGraphQl
22

3-
The *Magento_CatalogRuleGraphQl* module applies catalog rules to products for GraphQL requests.
3+
The *Magento_CatalogRuleGraphQl* module applies catalog rules to products for GraphQL requests.

Diff for: ‎app/code/Magento/CatalogUrlRewrite/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Magento_CatalogUrlRewrite module
22

3-
This module generate url rewrite fields for catalog and product.
3+
This module generate url rewrite fields for catalog and product.
44

55
## Extensibility
66

77
Extension developers can interact with the Magento_CatalogUrlRewrite module. For more information about the Magento extension mechanism, see [Magento plugins](https://developer.adobe.com/commerce/php/development/components/plugins/).
88

99
[The Magento dependency injection mechanism](https://developer.adobe.com/commerce/php/development/components/dependency-injection/) enables you to override the functionality of the Magento_CatalogUrlRewrite module.
1010

11-
A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it.
11+
A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it.

Diff for: ‎app/code/Magento/CatalogWidget/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# CatalogWidget
22

33
**CatalogWidget** contains various widgets that extend Catalog module functionality:
4+
45
- Product List widget provides widget that contains product list created using rule based filter.

Diff for: ‎app/code/Magento/Checkout/README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
# Magento_Checkout module
2+
23
Magento\Checkout module allows merchant to register sale transaction with the customer. Module implements consumer flow
34
that includes such actions like adding products to cart, providing shipping and billing information and confirming
45
the purchase.
56

67
#### Observer
8+
79
This module observes the following events
810
`etc/events.xml`
9-
`sales_quote_save_after` event in
11+
`sales_quote_save_after` event in
1012
`Magento\Checkout\Observer\SalesQuoteSaveAfterObserver` file.
1113
`/etc/frontend/events.xml`
1214
`customer_login` event in `Magento\Checkout\Observer\LoadCustomerQuoteObserver`
1315
file.
1416
`customer_logout` event in `Magento\Checkout\Observer\UnsetAllObserver`
1517

16-
### Layouts
17-
The module interacts with the following layout handles in the
18+
### Layouts
19+
20+
The module interacts with the following layout handles in the
1821
`view/frontend/layout`
1922
`catalog_category_view`
2023
`catalog_product_view`
@@ -30,4 +33,4 @@ the purchase.
3033
`checkout_onepage_failure`
3134
`checkout_onepage_review_item_renderers`
3235
`checkout_onepage_success`
33-
`default`
36+
`default`

Diff for: ‎app/code/Magento/CheckoutAgreements/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Magento\CheckoutAgreements module provides the ability add web store agreement that customers must accept before purchasing
22
products from store. The customer will need to accept the terms and conditions in the Order Review section of the
3-
checkout process to be able to place an order if Terms and Conditions functionality is enabled.
3+
checkout process to be able to place an order if Terms and Conditions functionality is enabled.

Diff for: ‎app/code/Magento/Cms/README.md

+24-20
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,33 @@ The module interacts with the following layout handles:
1818
The module interacts with the following layout handles:
1919

2020
`view/adminhtml/layout` directory:
21-
- `cms_block_edit.xml`
22-
- `cms_block_index.xml`
23-
- `cms_block_new.xml`
24-
- `cms_page_edit.xml`
25-
- `cms_page_index.xml`
26-
- `cms_page_new.xml`
27-
- `cms_wysiwyg_images_contents.xml`
28-
- `cms_wysiwyg_images_index.xml`
21+
22+
* `cms_block_edit.xml`
23+
* `cms_block_index.xml`
24+
* `cms_block_new.xml`
25+
* `cms_page_edit.xml`
26+
* `cms_page_index.xml`
27+
* `cms_page_new.xml`
28+
* `cms_wysiwyg_images_contents.xml`
29+
* `cms_wysiwyg_images_index.xml`
2930

3031
The module interacts with the following layout handles in the `view/frontend/layout` directory:
31-
- `cms_index_defaultindex.xml`
32-
- `cms_index_defaultnoroute.xml`
33-
- `cms_index_index.xml`
34-
- `cms_index_nocookies.xml`
35-
- `cms_noroute_index.xml`
36-
- `cms_page_view.xml`
37-
- `default.xml`
38-
- `print.xml`
32+
33+
* `cms_index_defaultindex.xml`
34+
* `cms_index_defaultnoroute.xml`
35+
* `cms_index_index.xml`
36+
* `cms_index_nocookies.xml`
37+
* `cms_noroute_index.xml`
38+
* `cms_page_view.xml`
39+
* `default.xml`
40+
* `print.xml`
3941

4042
### UI components
43+
4144
This module extends following ui components located in the `view/base/ui_component` directory:
4245
This module extends following ui components located in the `view/adminhtml/ui_component` directory:
43-
- `cms_block_form.xml`
44-
- `cms_block_listing.xml`
45-
- `cms_page_form.xml`
46-
- `cms_page_listing.xml`
46+
47+
* `cms_block_form.xml`
48+
* `cms_block_listing.xml`
49+
* `cms_page_form.xml`
50+
* `cms_page_listing.xml`

0 commit comments

Comments
 (0)