Skip to content

Commit

Permalink
Merge pull request #8210 from commerce-docs/ds_COMDOX-569
Browse files Browse the repository at this point in the history
Fix links to docs and Markdown formatting
  • Loading branch information
sidolov authored Apr 13, 2023
2 parents c766d6c + 03f0d08 commit f87634a
Show file tree
Hide file tree
Showing 147 changed files with 518 additions and 341 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For more detailed information on contribution please read our [beginners guide](

## Contribution requirements

1. Contributions must adhere to the [Magento coding standards](https://devdocs.magento.com/guides/v2.4/coding-standards/bk-coding-standards.html).
1. Contributions must adhere to the [Magento coding standards](https://developer.adobe.com/commerce/php/coding-standards/).
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.
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.
4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ However, for those who need a full-featured eCommerce solution, we recommend [Ad

## Contribute

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.
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.

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

### Maintainers

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.
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.

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

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).

[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.

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.

## Communications
Expand Down
4 changes: 2 additions & 2 deletions app/bootstrap.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 80100) {
if (PHP_SAPI == 'cli') {
echo 'Magento supports PHP 8.1.0 or later. ' .
'Please read https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements-tech.html';
'Please read https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html';
} else {
echo <<<HTML
<div style="font:12px/1.35em arial, helvetica, sans-serif;">
<p>Magento supports PHP 8.1.0 or later. Please read
<a target="_blank" href="https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements-tech.html">
<a target="_blank" href="https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html">
Magento System Requirements</a>.
</div>
HTML;
Expand Down
2 changes: 1 addition & 1 deletion app/code/Magento/AdminAnalytics/README.md
Original file line number Diff line number Diff line change
@@ -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.
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.
2 changes: 1 addition & 1 deletion app/code/Magento/CacheInvalidate/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
The CacheInvalidate module is used to invalidate the Varnish cache if it is configured.
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.
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 changes: 1 addition & 1 deletion app/code/Magento/Captcha/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The Captcha module allows applying Turing test in the process of user authentication or similar tasks.
The Captcha module allows applying Turing test in the process of user authentication or similar tasks.
2 changes: 1 addition & 1 deletion app/code/Magento/CardinalCommerce/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The CardinalCommerce module provides a possibility to enable 3-D Secure 2.0 support for payment methods.
The CardinalCommerce module provides a possibility to enable 3-D Secure 2.0 support for payment methods.
122 changes: 62 additions & 60 deletions app/code/Magento/Catalog/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
#Magento_Catalog
# Magento_Catalog

Magento_Catalog module functionality is represented by the following sub-systems:
- Products Management. It includes CRUD operation of product, product media, product attributes, etc...
- Category Management. It includes CRUD operation of category, category attributes

- Products Management. It includes CRUD operation of product, product media, product attributes, etc...
- Category Management. It includes CRUD operation of category, category attributes

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

## Observer

This module observes the following events:
`etc/events.xml`
`magento_catalog_api_data_productinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
`magento_catalog_api_data_productinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
`magento_catalog_api_data_productinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
`magento_catalog_api_data_productinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
`magento_catalog_api_data_productinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
`magento_catalog_api_data_categoryinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
`magento_catalog_api_data_categoryinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
`magento_catalog_api_data_categoryinterface_save_after` event in
`Magento\Catalog\Observer\InvalidateCacheOnCategoryDesignChange` file.
`magento_catalog_api_data_categoryinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
`magento_catalog_api_data_categoryinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
`magento_catalog_api_data_categoryinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
`magento_catalog_api_data_categorytreeinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
`magento_catalog_api_data_categorytreeinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
`magento_catalog_api_data_categorytreeinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
`magento_catalog_api_data_categorytreeinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
`magento_catalog_api_data_categorytreeinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
`admin_system_config_changed_section_catalog` event in
`Magento\Catalog\Observer\SwitchPriceAttributeScopeOnConfigChange` file.
`catalog_product_save_before` event in
`Magento\Catalog\Observer\SetSpecialPriceStartDate` file.
`store_save_after` event in
`Magento\Catalog\Observer\SynchronizeWebsiteAttributesOnStoreChange` file.
`catalog_product_save_commit_after` event in
`Magento\Catalog\Observer\ImageResizeAfterProductSave` file.
`catalog_category_prepare_save` event in
`Magento\Catalog\Observer\CategoryDesignAuthorization` file.

`/etc/frontend/events.xml`
`customer_login` event in
`Magento\Catalog\Observer\Compare\BindCustomerLoginObserver` file.
`customer_logout` event in
`Magento\Catalog\Observer\Compare\BindCustomerLogoutObserver` file.

`/etc/adminhtml/events.xml`
`cms_wysiwyg_images_static_urls_allowed` event in
`Magento\Catalog\Observer\CatalogCheckIsUsingStaticUrlsAllowedObserver` file.
`catalog_category_change_products` event in
`Magento\Catalog\Observer\CategoryProductIndexer` file.
`category_move` event in
`Magento\Catalog\Observer\FlushCategoryPagesCache`

- `etc/events.xml`
- `magento_catalog_api_data_productinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
- `magento_catalog_api_data_productinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
- `magento_catalog_api_data_productinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
- `magento_catalog_api_data_productinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
- `magento_catalog_api_data_productinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
- `magento_catalog_api_data_categoryinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
- `magento_catalog_api_data_categoryinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
- `magento_catalog_api_data_categoryinterface_save_after` event in
`Magento\Catalog\Observer\InvalidateCacheOnCategoryDesignChange` file.
- `magento_catalog_api_data_categoryinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
- `magento_catalog_api_data_categoryinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
- `magento_catalog_api_data_categoryinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
- `magento_catalog_api_data_categorytreeinterface_save_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntitySave` file.
- `magento_catalog_api_data_categorytreeinterface_save_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntitySave` file.
- `magento_catalog_api_data_categorytreeinterface_delete_before` event in
`Magento\Framework\EntityManager\Observer\BeforeEntityDelete` file.
- `magento_catalog_api_data_categorytreeinterface_delete_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityDelete` file.
- `magento_catalog_api_data_categorytreeinterface_load_after` event in
`Magento\Framework\EntityManager\Observer\AfterEntityLoad` file.
`admin_system_config_changed_section_catalog` event in
`Magento\Catalog\Observer\SwitchPriceAttributeScopeOnConfigChange` file.
- `catalog_product_save_before` event in
`Magento\Catalog\Observer\SetSpecialPriceStartDate` file.
`store_save_after` event in
`Magento\Catalog\Observer\SynchronizeWebsiteAttributesOnStoreChange` file.
- `catalog_product_save_commit_after` event in
`Magento\Catalog\Observer\ImageResizeAfterProductSave` file.
- `catalog_category_prepare_save` event in
`Magento\Catalog\Observer\CategoryDesignAuthorization` file.
- `/etc/frontend/events.xml`
- `customer_login` event in
`Magento\Catalog\Observer\Compare\BindCustomerLoginObserver` file.
- `customer_logout` event in
`Magento\Catalog\Observer\Compare\BindCustomerLogoutObserver` file.
- `/etc/adminhtml/events.xml`
`cms_wysiwyg_images_static_urls_allowed` event in
`Magento\Catalog\Observer\CatalogCheckIsUsingStaticUrlsAllowedObserver` file.
- `catalog_category_change_products` event in
`Magento\Catalog\Observer\CategoryProductIndexer` file.
- `category_move` event in
`Magento\Catalog\Observer\FlushCategoryPagesCache`
2 changes: 1 addition & 1 deletion app/code/Magento/CatalogCmsGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# CatalogCmsGraphQl

**CatalogCmsGraphQl** provides type and resolver information for GraphQL attributes that have dependencies on the Catalog and Cms modules.
**CatalogCmsGraphQl** provides type and resolver information for GraphQL attributes that have dependencies on the Catalog and Cms modules.
2 changes: 1 addition & 1 deletion app/code/Magento/CatalogCustomerGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# CatalogCustomerGraphQl

**CatalogCustomerGraphQl** provides type and resolver information for GraphQL attributes that have dependences on the Catalog and Customer modules.
**CatalogCustomerGraphQl** provides type and resolver information for GraphQL attributes that have dependences on the Catalog and Customer modules.
2 changes: 1 addition & 1 deletion app/code/Magento/CatalogRuleGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# CatalogRuleGraphQl

The *Magento_CatalogRuleGraphQl* module applies catalog rules to products for GraphQL requests.
The *Magento_CatalogRuleGraphQl* module applies catalog rules to products for GraphQL requests.
4 changes: 2 additions & 2 deletions app/code/Magento/CatalogUrlRewrite/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Magento_CatalogUrlRewrite module

This module generate url rewrite fields for catalog and product.
This module generate url rewrite fields for catalog and product.

## Extensibility

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/).

[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.

A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it.
A lot of functionality in the module is on JavaScript, use [mixins](https://developer.adobe.com/commerce/frontend-core/javascript/mixins/) to extend it.
1 change: 1 addition & 0 deletions app/code/Magento/CatalogWidget/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# CatalogWidget

**CatalogWidget** contains various widgets that extend Catalog module functionality:

- Product List widget provides widget that contains product list created using rule based filter.
11 changes: 7 additions & 4 deletions app/code/Magento/Checkout/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# Magento_Checkout module

Magento\Checkout module allows merchant to register sale transaction with the customer. Module implements consumer flow
that includes such actions like adding products to cart, providing shipping and billing information and confirming
the purchase.

#### Observer

This module observes the following events
`etc/events.xml`
`sales_quote_save_after` event in
`sales_quote_save_after` event in
`Magento\Checkout\Observer\SalesQuoteSaveAfterObserver` file.
`/etc/frontend/events.xml`
`customer_login` event in `Magento\Checkout\Observer\LoadCustomerQuoteObserver`
file.
`customer_logout` event in `Magento\Checkout\Observer\UnsetAllObserver`

### Layouts
The module interacts with the following layout handles in the
### Layouts

The module interacts with the following layout handles in the
`view/frontend/layout`
`catalog_category_view`
`catalog_product_view`
Expand All @@ -30,4 +33,4 @@ the purchase.
`checkout_onepage_failure`
`checkout_onepage_review_item_renderers`
`checkout_onepage_success`
`default`
`default`
2 changes: 1 addition & 1 deletion app/code/Magento/CheckoutAgreements/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Magento\CheckoutAgreements module provides the ability add web store agreement that customers must accept before purchasing
products from store. The customer will need to accept the terms and conditions in the Order Review section of the
checkout process to be able to place an order if Terms and Conditions functionality is enabled.
checkout process to be able to place an order if Terms and Conditions functionality is enabled.
44 changes: 24 additions & 20 deletions app/code/Magento/Cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,29 +18,33 @@ The module interacts with the following layout handles:
The module interacts with the following layout handles:

`view/adminhtml/layout` directory:
- `cms_block_edit.xml`
- `cms_block_index.xml`
- `cms_block_new.xml`
- `cms_page_edit.xml`
- `cms_page_index.xml`
- `cms_page_new.xml`
- `cms_wysiwyg_images_contents.xml`
- `cms_wysiwyg_images_index.xml`

* `cms_block_edit.xml`
* `cms_block_index.xml`
* `cms_block_new.xml`
* `cms_page_edit.xml`
* `cms_page_index.xml`
* `cms_page_new.xml`
* `cms_wysiwyg_images_contents.xml`
* `cms_wysiwyg_images_index.xml`

The module interacts with the following layout handles in the `view/frontend/layout` directory:
- `cms_index_defaultindex.xml`
- `cms_index_defaultnoroute.xml`
- `cms_index_index.xml`
- `cms_index_nocookies.xml`
- `cms_noroute_index.xml`
- `cms_page_view.xml`
- `default.xml`
- `print.xml`

* `cms_index_defaultindex.xml`
* `cms_index_defaultnoroute.xml`
* `cms_index_index.xml`
* `cms_index_nocookies.xml`
* `cms_noroute_index.xml`
* `cms_page_view.xml`
* `default.xml`
* `print.xml`

### UI components

This module extends following ui components located in the `view/base/ui_component` directory:
This module extends following ui components located in the `view/adminhtml/ui_component` directory:
- `cms_block_form.xml`
- `cms_block_listing.xml`
- `cms_page_form.xml`
- `cms_page_listing.xml`

* `cms_block_form.xml`
* `cms_block_listing.xml`
* `cms_page_form.xml`
* `cms_page_listing.xml`
Loading

0 comments on commit f87634a

Please sign in to comment.