Skip to content

Commit

Permalink
Merge pull request #8593 from commerce-docs/ds_fix-docs
Browse files Browse the repository at this point in the history
Minor fixes in docs
  • Loading branch information
okolesnyk authored Nov 19, 2023
2 parents 6f5a25e + 777c86d commit edd599b
Show file tree
Hide file tree
Showing 65 changed files with 88 additions and 91 deletions.
12 changes: 6 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Contributions to the Magento 2 codebase are done using the fork & pull model.
This contribution model has contributors maintaining their own fork of the Magento 2 repository.
The forked repository is then used to submit a request to the base repository to pull a set of changes.
The forked repository is then used to submit a request to the base repository to "pull" a set of changes.
For more information on pull requests please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/).

Contributions can take the form of new components or features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes or optimizations.
Expand All @@ -19,11 +19,11 @@ For more detailed information on contribution please read our [beginners guide](
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.
3. PRs which include new logic or new features must be submitted along with:
* Unit/integration test coverage
* Proposed [documentation](https://devdocs.magento.com) updates. Documentation contributions can be submitted via the [devdocs GitHub](https://github.com/magento/devdocs).
4. For larger features or changes, please [open an issue](https://github.com/magento/magento2/issues) to discuss the proposed changes prior to development. This may prevent duplicate or unnecessary effort and allow other contributors to provide input.
5. All automated tests must pass.
5. PRs which include new logic or new features must be submitted along with:
* Unit/integration test coverage
* Proposed [documentation](https://developer.adobe.com/commerce) updates. Use feedback buttons __Edit in GitHub__ and __Log an issue__ at the top of a relevant topic.
6. For larger features or changes, please [open an issue](https://github.com/magento/magento2/issues) to discuss the proposed changes prior to development. This may prevent duplicate or unnecessary effort and allow other contributors to provide input.
7. All automated tests must pass.

## Contribution process

Expand Down
2 changes: 1 addition & 1 deletion 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://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.
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://experienceleague.adobe.com/docs/commerce-admin/user-guides/home.html), 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 Down
2 changes: 1 addition & 1 deletion app/code/Magento/Analytics/etc/config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<otp>https://advancedreporting.rjmetrics.com/otp</otp>
<report>https://advancedreporting.rjmetrics.com/report</report>
<notify_data_changed>https://advancedreporting.rjmetrics.com/report</notify_data_changed>
<documentation>https://docs.magento.com/user-guide/reports/advanced-reporting.html</documentation>
<documentation>https://experienceleague.adobe.com/docs/commerce-admin/start/reporting/business-intelligence.html#advanced-reporting</documentation>
</url>
<integration_name>Magento Analytics user</integration_name>
<general>
Expand Down
2 changes: 1 addition & 1 deletion app/code/Magento/Backend/Block/Store/Switcher.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Switcher extends \Magento\Backend\Block\Template
/**
* URL for store switcher hint
*/
public const HINT_URL = 'https://docs.magento.com/user-guide/configuration/scope.html';
public const HINT_URL = 'https://experienceleague.adobe.com/docs/commerce-admin/start/setup/websites-stores-views.html#scope-settings'; // @codingStandardsIgnoreLine

/**
* Name of website variable
Expand Down
2 changes: 1 addition & 1 deletion app/code/Magento/Backup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Magento_Backup module allows administrators to perform backups and rollbacks

The Magento_Backup module does not affect the storefront.

For more information about this module, see [Magento Backups](https://docs.magento.com/user-guide/system/backups.html)
For more information about this module, see [Backups](https://experienceleague.adobe.com/docs/commerce-admin/systems/tools/backups.html)

## Extensibility

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ protected function customizeNameListeners(array $meta)

$urlKeyConfig = [
'tooltip' => [
'link' => 'https://docs.magento.com/user-guide/catalog/catalog-urls.html',
'link' => 'https://experienceleague.adobe.com/docs/commerce-admin/catalog/catalog/catalog-urls.html',
'description' => __(
'The URL key should consist of lowercase characters with hyphens to separate words.'
),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ protected function getFieldsForFieldset()
$websitesList = $this->getWebsitesList();
$isNewProduct = !$this->locator->getProduct()->getId();
$tooltip = [
'link' => 'https://docs.magento.com/user-guide/configuration/scope.html',
'link' => 'https://experienceleague.adobe.com/docs/commerce-admin/start/setup/websites-stores-views.html#scope-settings', // @codingStandardsIgnoreLine
'description' => __(
'If your Magento installation has multiple websites, ' .
'you can edit the scope to use the product on specific sites.'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
</validation>
<dataType>number</dataType>
<tooltip>
<link>https://docs.magento.com/user-guide/configuration/scope.html</link>
<link>https://experienceleague.adobe.com/docs/commerce-admin/start/setup/websites-stores-views.html#scope-settings</link>
<description>What is this?</description>
</tooltip>
<label translate="true">Websites</label>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
</validation>
<dataType>int</dataType>
<tooltip>
<link>https://docs.magento.com/user-guide/configuration/scope.html</link>
<link>https://experienceleague.adobe.com/docs/commerce-admin/start/setup/websites-stores-views.html#scope-settings</link>
<description>What is this?</description>
</tooltip>
<label translate="true">Store View</label>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@
</validation>
<dataType>int</dataType>
<tooltip>
<link>https://docs.magento.com/user-guide/configuration/scope.html</link>
<link>https://experienceleague.adobe.com/docs/commerce-admin/start/setup/websites-stores-views.html#scope-settings</link>
<description>What is this?</description>
</tooltip>
<label translate="true">Store View</label>
Expand Down
6 changes: 3 additions & 3 deletions app/code/Magento/Customer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,9 +348,9 @@ For information about a UI component in Magento 2, see [Overview of UI component

More information can get at articles:

- [Customer Configurations](https://docs.magento.com/user-guide/configuration/customers/customer-configuration.html)
- [Customer Attributes](https://docs.magento.com/user-guide/stores/attributes-customer.html)
- [Customer Address Attributes](https://docs.magento.com/user-guide/stores/attributes-customer-address.html)
- [Customer Configurations](https://experienceleague.adobe.com/docs/commerce-admin/config/customers/customer-configuration.html)
- [Customer Attributes](https://experienceleague.adobe.com/docs/commerce-admin/customers/customer-accounts/attributes/attribute-properties.html)
- [Customer Address Attributes](https://experienceleague.adobe.com/docs/commerce-admin/customers/customer-accounts/attributes/address-attributes.html)
- [EAV And Extension Attributes](https://developer.adobe.com/commerce/php/development/components/attributes/)
- [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
</validation>
<dataType>number</dataType>
<tooltip>
<link>https://docs.magento.com/user-guide/configuration/scope.html</link>
<link>https://experienceleague.adobe.com/docs/commerce-admin/start/setup/websites-stores-views.html#scope-settings</link>
<description translate="true">If your Magento installation has multiple websites, you can edit the scope to associate the customer with a specific site.</description>
</tooltip>
<imports>
Expand Down
4 changes: 2 additions & 2 deletions app/code/Magento/CustomerImportExport/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ For more information about a layout in Magento 2, see the [Layout documentation]

You can get more information about import/export processes in magento at the articles:

- [Import](https://docs.magento.com/user-guide/system/data-import.html)
- [Export](https://docs.magento.com/user-guide/system/data-export.html)
- [Import](https://experienceleague.adobe.com/docs/commerce-admin/systems/data-transfer/import/data-import.html)
- [Export](https://experienceleague.adobe.com/docs/commerce-admin/systems/data-transfer/data-export.html)
4 changes: 2 additions & 2 deletions app/code/Magento/Elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For information about a module installation in Magento 2, see [Enable or disable

## Structure

`ElasticAdapter/` - the directory that contains the core files for providing support to ElasticSearch 7.x and 8.x
`ElasticAdapter/` - the directory that contains the core files for providing support to ElasticSearch 7.x and 8.x
version.

`SearchAdapter/` - the directory that contains solutions for adapting ElasticSearch query searching.
Expand All @@ -27,7 +27,7 @@ For information about significant changes in patch releases, see [2.4.x Release

More information about ElasticSearch are at articles:

- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html).
- [Configuring Catalog Search](https://experienceleague.adobe.com/docs/commerce-admin/catalog/catalog/search/search-configuration.html).
- [Installation Guide/Elasticsearch](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/prerequisites/search-engine/overview.html).
- [Configure and maintain Elasticsearch](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/search/overview-search.html).
- Magento Commerce Cloud - [set up Elasticsearch service](https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/configure/service/elasticsearch.html).
2 changes: 1 addition & 1 deletion app/code/Magento/Elasticsearch7/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For information about significant changes in patch releases, see [2.4.x Release

More information about ElasticSearch are at articles:

- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html).
- [Configuring Catalog Search](https://experienceleague.adobe.com/docs/commerce-admin/catalog/catalog/search/search-configuration.html).
- [Installation Guide/Elasticsearch](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/prerequisites/search-engine/overview.html).
- [Configure and maintain Elasticsearch](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/search/overview-search.html).
- Magento Commerce Cloud - [set up Elasticsearch service](https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/configure/service/elasticsearch.html).
4 changes: 2 additions & 2 deletions app/code/Magento/Email/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For information about significant changes in patch releases, see [2.4.x Release

More information about email templates are at articles:

- [Marketing/Email](https://docs.magento.com/user-guide/marketing/email-templates.html)
- [Email templates list](https://docs.magento.com/user-guide/marketing/email-template-list.html)
- [Marketing/Email](https://experienceleague.adobe.com/docs/commerce-admin/systems/communications/email-templates.html)
- [Email templates list](https://experienceleague.adobe.com/docs/commerce-admin/systems/communications/email-templates.html#email-template-list)
- [Customize email templates](https://developer.adobe.com/commerce/frontend-core/guide/templates/email/)
- [Migrating custom email templates](https://developer.adobe.com/commerce/frontend-core/guide/templates/email-migration/#nested-arrays)
4 changes: 2 additions & 2 deletions app/code/Magento/EncryptionKey/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ This module introduces the following layouts and layout handles in the `view/adm

## Additional information

For information about significant changes in patch releases, see [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html).
For information about significant changes in patch releases, see [Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html).

Some more information you can get at [Encryption Key](https://docs.magento.com/user-guide/system/encryption-key.html) article.
Some more information you can get at [Encryption Key](https://experienceleague.adobe.com/docs/commerce-admin/systems/security/encryption-key.html) article.
4 changes: 2 additions & 2 deletions app/code/Magento/Fedex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ This module introduces the following layouts in the `view/frontend/layout` direc

You can get more information about delivery method in magento at the articles:

- [FedEx Configuration Settings](https://docs.magento.com/user-guide/shipping/fedex.html)
- [Delivery Methods Configuration](https://docs.magento.com/user-guide/configuration/sales/delivery-methods.html)
- [FedEx Configuration Settings](https://experienceleague.adobe.com/docs/commerce-admin/stores-sales/delivery/shipping-carriers/fedex.html)
- [Delivery Methods Configuration](https://experienceleague.adobe.com/docs/commerce-admin/config/sales/delivery-methods.html)
- [Add custom shipping carrier](https://developer.adobe.com/commerce/php/tutorials/frontend/custom-checkout/add-shipping-carrier/)
2 changes: 1 addition & 1 deletion app/code/Magento/GiftMessage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ For information about a public API in Magento 2, see [Public interfaces & APIs](

## Additional information

[Learn more about Gift Options and Gift Message](https://docs.magento.com/user-guide/sales/gift-options.html).
[Learn more about Gift Options and Gift Message](https://experienceleague.adobe.com/docs/commerce-admin/stores-sales/point-of-purchase/cart/cart-configuration.html#gift-options).
2 changes: 1 addition & 1 deletion app/code/Magento/GoogleAdwords/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ For more information about a layout in Magento 2, see the [Layout documentation]

## Additional information

[Learn how to configure Google AdWords](https://docs.magento.com/user-guide/marketing/google-adwords.html).
[Learn how to configure Google AdWords](https://experienceleague.adobe.com/docs/commerce-admin/marketing/google-tools/google-adwords.html).
2 changes: 1 addition & 1 deletion app/code/Magento/GoogleAnalytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ For more information about a layout in Magento 2, see the [Layout documentation]

## Additional information

[Learn how to configure Google Analytics](https://docs.magento.com/user-guide/marketing/google-universal-analytics.html).
[Learn how to configure Google Analytics](https://experienceleague.adobe.com/docs/commerce-admin/marketing/google-tools/google-analytics.html).
2 changes: 1 addition & 1 deletion app/code/Magento/GoogleGtag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ For more information about a layout in Magento 2, see the [Layout documentation]

## Additional information

[Learn how to configure Google Analytics](https://docs.magento.com/user-guide/marketing/google-universal-analytics.html).
[Learn how to configure Google Analytics](https://experienceleague.adobe.com/docs/commerce-admin/marketing/google-tools/google-analytics.html).
2 changes: 1 addition & 1 deletion app/code/Magento/GoogleOptimizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ This allows to save different codes for products and categories on different sto
This functionality can be switched on and off on the configuration page (`Stores -> Configuration -> General -> Google Api -> Google Analytics`).
Also this functionality depends on Google Analytics module and configuration options.

[Learn how to configure Google Content Experiments](https://docs.magento.com/user-guide/marketing/google-content-experiments.html).
[Learn how to configure Google Content Experiments](https://experienceleague.adobe.com/docs/commerce-admin/marketing/google-tools/google-content-experiments.html).
4 changes: 2 additions & 2 deletions app/code/Magento/GroupedImportExport/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ Extension developers can interact with the Magento_GroupedImportExport module. F

You can get more information about import/export processes in magento at the articles:

- [Import](https://docs.magento.com/user-guide/system/data-import.html)
- [Export](https://docs.magento.com/user-guide/system/data-export.html)
- [Import](https://experienceleague.adobe.com/docs/commerce-admin/systems/data-transfer/import/data-import.html)
- [Export](https://experienceleague.adobe.com/docs/commerce-admin/systems/data-transfer/data-export.html)
2 changes: 1 addition & 1 deletion app/code/Magento/GroupedProduct/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ For information about a public API in Magento 2, see [Public interfaces & APIs](

## Additional information

For more information about creating grouped product, see [Creating Grouped Product](https://docs.magento.com/user-guide/catalog/product-create-grouped.html).
For more information about creating grouped product, see [Creating Grouped Product](https://experienceleague.adobe.com/docs/commerce-admin/catalog/products/types/product-create-grouped.html).
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ private function getImportBehaviorTooltip()
{
$html = '<div class="admin__field-tooltip tooltip">
<a class="admin__field-tooltip-action action-help" target="_blank" title="What is this?"
href="https://docs.magento.com/user-guide/system/data-import.html"><span>'
href="https://experienceleague.adobe.com/docs/commerce-admin/systems/data-transfer/import/data-import.html"><span>' // @codingStandardsIgnoreLine
. __('What is this?')
. '</span></a></div>';
return $html;
Expand Down
4 changes: 2 additions & 2 deletions app/code/Magento/ImportExport/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,5 @@ For information about a public API in Magento 2, see [Public interfaces & APIs](
You can get more information about import/export processes in magento at the articles:

- [Create custom import entity](https://developer.adobe.com/commerce/php/tutorials/backend/create-custom-import-entity/)
- [Import](https://docs.magento.com/user-guide/system/data-import.html)
- [Export](https://docs.magento.com/user-guide/system/data-export.html)
- [Import](https://experienceleague.adobe.com/docs/commerce-admin/systems/data-transfer/import/data-import.html)
- [Export](https://experienceleague.adobe.com/docs/commerce-admin/systems/data-transfer/data-export.html)
2 changes: 1 addition & 1 deletion app/code/Magento/Indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ More information can get at articles:
- [Learn more about Indexer optimization](https://developer.adobe.com/commerce/php/development/components/indexing/optimization/)
- [Learn more how to add custom indexer](https://developer.adobe.com/commerce/php/development/components/indexing/custom-indexer/)
- [Learn how to manage indexers](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cli/manage-indexers.html)
- [Learn more about Index Management](https://docs.magento.com/user-guide/system/index-management.html)
- [Learn more about Index Management](https://experienceleague.adobe.com/docs/commerce-admin/systems/tools/index-management.html)
Loading

0 comments on commit edd599b

Please sign in to comment.