Skip to content

Commit 23cf5e2

Browse files
committed
Fix docs
Replace old devdocs links Fix Markdown according to the DevSite docs rules
1 parent bc1c7ba commit 23cf5e2

File tree

5 files changed

+8
-11
lines changed

5 files changed

+8
-11
lines changed

.github/CONTRIBUTING.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

88
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.
@@ -19,11 +19,11 @@ For more detailed information on contribution please read our [beginners guide](
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.
22-
3. PRs which include new logic or new features must be submitted along with:
23-
* Unit/integration test coverage
24-
* Proposed [documentation](https://devdocs.magento.com) updates. Documentation contributions can be submitted via the [devdocs GitHub](https://github.com/magento/devdocs).
25-
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.
26-
5. All automated tests must pass.
22+
5. PRs which include new logic or new features must be submitted along with:
23+
* Unit/integration test coverage
24+
* 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.
25+
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.
26+
7. All automated tests must pass.
2727

2828
## Contribution process
2929

app/code/Magento/Elasticsearch/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For information about a module installation in Magento 2, see [Enable or disable
1414

1515
## Structure
1616

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

2020
`SearchAdapter/` - the directory that contains solutions for adapting ElasticSearch query searching.

app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate.php

-1
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,6 @@ private function importData(array $fields, array $values)
295295
* @return Tablerate
296296
* @throws LocalizedException
297297
* @todo: this method should be refactored as soon as updated design will be provided
298-
* @see https://wiki.corp.x.com/display/MCOMS/Magento+Filesystem+Decisions
299298
*/
300299
public function uploadAndImport(DataObject $object)
301300
{

app/code/Magento/OrderCancellation/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,3 @@ This module allows to cancel an order and specify the order cancellation reason.
55
This functionality is enabled / disabled by a feature flag that is set at storeView level.
66

77
After the cancellation, the customer receive an email confirming it and this cancellation is reflected in the customer's order history.
8-
9-

app/code/Magento/ReleaseNotification/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ A clickable link to internal or external content in any text field will be creat
7474

7575
#### Link Format Example:
7676

77-
The text: `https://devdocs.magento.com/ [Magento DevDocs].` will appear as [Magento DevDocs](https://devdocs.magento.com/).
77+
The text: `https://developer.adobe.com/commerce/docs/ [Adobe Commerce Developer Documentation].` will appear as [Adobe Commerce Developer Documentation](https://developer.adobe.com/commerce/docs/).

0 commit comments

Comments
 (0)