Skip to content

Commit ef6f730

Browse files
magento-engcom-teammagento-engcom-team
committed
ENGCOM-5553: Fix external links to the Magento technical documentation #24036
- Merge Pull Request #24036 from magento-devdocs/magento2:ds_fix-docs - Merged commits: 1. f5770db 2. a62fdba 3. becb0e0
2 parents 47d887e + becb0e0 commit ef6f730

File tree

43 files changed

+8947
-92
lines changed

Some content is hidden

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

43 files changed

+8947
-92
lines changed

‎CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -612,11 +612,11 @@ To get detailed information about changes in Magento 2.3.0, see the [Release Not
612612

613613
2.2.0
614614
=============
615-
To get detailed information about changes in Magento 2.2.0, see the [Release Notes](https://devdocs.magento.com/guides/v2.2/release-notes/bk-release-notes.html)
615+
To get detailed information about changes in Magento 2.2.0, see the [Release Notes](https://devdocs.magento.com/guides/v2.3/release-notes/bk-release-notes.html)
616616

617617
2.1.0
618618
=============
619-
To get detailed information about changes in Magento 2.1.0, please visit [Magento Community Edition (CE) Release Notes](https://devdocs.magento.com/guides/v2.1/release-notes/ReleaseNotes2.1.0CE.html "Magento Community Edition (CE) Release Notes")
619+
To get detailed information about changes in Magento 2.1.0, please visit [Magento Community Edition (CE) Release Notes](https://devdocs.magento.com/guides/v2.3/release-notes/ReleaseNotes2.1.0CE.html "Magento Community Edition (CE) Release Notes")
620620

621621
2.0.0
622622
=============
@@ -1637,7 +1637,7 @@ Tests:
16371637
* Improved backend menu keyboard accessibility
16381638
* Accessibility improvements: WAI-ARIA in a product item on a category page and related products
16391639
* Checkout flow code can work with a separate DB storage
1640-
* <a href="https://devdocs.magento.com/guides/v1.0/release-notes/changes.html#change-devrc-unit">Unit tests moved to module directories</a>
1640+
* Unit tests moved to module directories
16411641
* Addressed naming inconsistencies in REST routes
16421642
* Added Advanced Developer workflow for frontend developers
16431643
* Setup

‎README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ To learn about issues, click [here][2]. To open an issue, click [here][3].
2020

2121
To suggest documentation improvements, click [here][4].
2222

23-
[1]: <https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html>
24-
[2]: <https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#report>
25-
[3]: <https://github.com/magento/magento2/issues>
26-
[4]: <https://devdocs.magento.com>
23+
[1]: https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html
24+
[2]: https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#report
25+
[3]: https://github.com/magento/magento2/issues
26+
[4]: https://devdocs.magento.com
2727

2828
<h3>Community Maintainers</h3>
2929
The members of this team have been recognized for their outstanding commitment to maintaining and improving Magento. Magento has granted them permission to accept, merge, and reject pull requests, as well as review issues, and thanks these Community Maintainers for their valuable contributions.

‎app/code/Magento/Analytics/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Magento_Analytics Module
22

3-
The Magento_Analytics module integrates your Magento instance with the [Magento Business Intelligence (MBI)](https://magento.com/products/business-intelligence) to use [Advanced Reporting](https://devdocs.magento.com/guides/v2.2/advanced-reporting/modules.html) functionality.
3+
The Magento_Analytics module integrates your Magento instance with the [Magento Business Intelligence (MBI)](https://magento.com/products/business-intelligence) to use [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html) functionality.
44

55
The module implements the following functionality:
66

@@ -16,8 +16,8 @@ The module implements the following functionality:
1616

1717
## Structure
1818

19-
Beyond the [usual module file structure](https://devdocs.magento.com/guides/v2.2/architecture/archi_perspectives/components/modules/mod_intro.html) the module contains a directory `ReportXml`.
20-
[Report XML](https://devdocs.magento.com/guides/v2.2/advanced-reporting/report-xml.html) is a markup language used to build reports for Advanced Reporting.
19+
Beyond the [usual module file structure](https://devdocs.magento.com/guides/v2.3/architecture/archi_perspectives/components/modules/mod_intro.html) the module contains a directory `ReportXml`.
20+
[Report XML](https://devdocs.magento.com/guides/v2.3/advanced-reporting/report-xml.html) is a markup language used to build reports for Advanced Reporting.
2121
The language declares SQL queries using XML declaration.
2222

2323
## Subscription Process

‎app/code/Magento/CatalogAnalytics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Magento_CatalogAnalytics module
22

3-
The Magento_CatalogAnalytics module configures data definitions for a data collection related to the Catalog module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.2/advanced-reporting/modules.html).
3+
The Magento_CatalogAnalytics module configures data definitions for a data collection related to the Catalog module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html).

‎app/code/Magento/CustomerAnalytics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Magento_CustomerAnalytics module
22

3-
The Magento_CustomerAnalytics module configures data definitions for a data collection related to the Customer module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.2/advanced-reporting/modules.html).
3+
The Magento_CustomerAnalytics module configures data definitions for a data collection related to the Customer module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html).

‎app/code/Magento/Deploy/Model/Filesystem.php

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ class Filesystem
2929
* Access permissions to the files are set during deploy Magento 2, directly after
3030
* uploading code of Magento. Also it is possible to specify the value
3131
* of inverse mask for setting access permissions to files generated by Magento.
32-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html
33-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html
32+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/install/post-install-umask.html
33+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/prereq/file-system-perms.html
3434
*/
3535
const PERMISSIONS_FILE = 0640;
3636

@@ -41,8 +41,8 @@ class Filesystem
4141
* Access permissions to the directories are set during deploy Magento 2, directly after
4242
* uploading code of Magento. Also it is possible to specify the value
4343
* of inverse mask for setting access permissions to directories generated by Magento.
44-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html
45-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html
44+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/install/post-install-umask.html
45+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/prereq/file-system-perms.html
4646
*/
4747
const PERMISSIONS_DIR = 0750;
4848

@@ -285,22 +285,7 @@ public function cleanupFilesystem($directoryCodeList)
285285
$excludePatterns = ['#.htaccess#', '#deployed_version.txt#'];
286286
foreach ($directoryCodeList as $code) {
287287
if ($code == DirectoryList::STATIC_VIEW) {
288-
$directoryPath = $this->directoryList->getPath(DirectoryList::STATIC_VIEW);
289-
if ($this->driverFile->isExists($directoryPath)) {
290-
$files = $this->driverFile->readDirectory($directoryPath);
291-
foreach ($files as $file) {
292-
foreach ($excludePatterns as $pattern) {
293-
if (preg_match($pattern, $file)) {
294-
continue 2;
295-
}
296-
}
297-
if ($this->driverFile->isFile($file)) {
298-
$this->driverFile->deleteFile($file);
299-
} else {
300-
$this->driverFile->deleteDirectory($file);
301-
}
302-
}
303-
}
288+
$this->cleanupStaticDirectory($excludePatterns);
304289
} else {
305290
$this->filesystem->getDirectoryWrite($code)
306291
->delete();
@@ -320,8 +305,8 @@ public function cleanupFilesystem($directoryCodeList)
320305
* Access permissions to the files and directories are set during deploy Magento 2, directly after
321306
* uploading code of Magento. Also it is possible to specify the value
322307
* of inverse mask for setting access permissions to files and directories generated by Magento.
323-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html
324-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html
308+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/install/post-install-umask.html
309+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/prereq/file-system-perms.html
325310
* @throws \Magento\Framework\Exception\FileSystemException
326311
*/
327312
protected function changePermissions($directoryCodeList, $dirPermissions, $filePermissions)
@@ -346,8 +331,8 @@ protected function changePermissions($directoryCodeList, $dirPermissions, $fileP
346331
* Access permissions to the files and directories are set during deploy Magento 2, directly after
347332
* uploading code of Magento. Also it is possible to specify the value
348333
* of inverse mask for setting access permissions to files and directories generated by Magento.
349-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html
350-
* @link https://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html
334+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/install/post-install-umask.html
335+
* @link https://devdocs.magento.com/guides/v2.3/install-gde/prereq/file-system-perms.html
351336
* @throws \Magento\Framework\Exception\FileSystemException
352337
*/
353338
public function lockStaticResources()
@@ -374,4 +359,30 @@ private function reinitCacheDirectories()
374359
$command = $this->functionCallPath . 'cache:flush';
375360
$this->shell->execute($command);
376361
}
362+
363+
/**
364+
* Cleanup directory with static view files.
365+
*
366+
* @param array $excludePatterns
367+
* @throws \Magento\Framework\Exception\FileSystemException
368+
*/
369+
private function cleanupStaticDirectory(array $excludePatterns): void
370+
{
371+
$directoryPath = $this->directoryList->getPath(DirectoryList::STATIC_VIEW);
372+
if ($this->driverFile->isExists($directoryPath)) {
373+
$files = $this->driverFile->readDirectory($directoryPath);
374+
foreach ($files as $file) {
375+
foreach ($excludePatterns as $pattern) {
376+
if (preg_match($pattern, $file)) {
377+
continue 2;
378+
}
379+
}
380+
if ($this->driverFile->isFile($file)) {
381+
$this->driverFile->deleteFile($file);
382+
} else {
383+
$this->driverFile->deleteDirectory($file);
384+
}
385+
}
386+
}
387+
}
377388
}

‎app/code/Magento/Indexer/Model/Message/Invalid.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ public function isDisplayed()
5959
*/
6060
public function getIdentity()
6161
{
62+
// phpcs:ignore Magento2.Security.InsecureFunction
6263
return md5('INDEX_INVALID');
6364
}
6465

@@ -74,7 +75,7 @@ public function getText()
7475
return __(
7576
'One or more <a href="%1">indexers are invalid</a>. Make sure your <a href="%2" target="_blank">Magento cron job</a> is running.',
7677
$url,
77-
'https://devdocs.magento.com/guides/v2.2/config-guide/cli/config-cli-subcommands-cron.html#create-or-remove-the-magento-crontab'
78+
'https://devdocs.magento.com/guides/v2.3/config-guide/cli/config-cli-subcommands-cron.html#create-or-remove-the-magento-crontab'
7879
);
7980
//@codingStandardsIgnoreEnd
8081
}

‎app/code/Magento/InstantPurchase/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Prerequisites to display the Instant Purchase button:
1010

1111
## Structure
1212

13-
In addition to [a typical file structure for a Magento 2 module](https://devdocs.magento.com/guides/v2.2/extension-dev-guide/build/module-file-structure.html) `PaymentMethodsIntegration` directory contains interfaces and basic implementation of integration vault payment method to the instant purchase.
13+
In addition to [a typical file structure for a Magento 2 module](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/build/module-file-structure.html) `PaymentMethodsIntegration` directory contains interfaces and basic implementation of integration vault payment method to the instant purchase.
1414

1515
## Extensibility
1616

@@ -22,7 +22,7 @@ All payments created for instant purchase also have `'instant-purchase' => true`
2222

2323
### Payment method integration
2424

25-
Instant purchase support may be implemented for any payment method with [vault support](https://devdocs.magento.com/guides/v2.1/payments-integrations/vault/vault-intro.html).
25+
Instant purchase support may be implemented for any payment method with [vault support](https://devdocs.magento.com/guides/v2.3/payments-integrations/vault/vault-intro.html).
2626
Basic implementation provided in `Magento\InstantPurchase\PaymentMethodIntegration` should be enough in most cases. It is not enabled by default to avoid issues on production sites and authors of vault payment method should verify correct work for instant purchase manually.
2727
To enable basic implementation just add single option to configuration of payemnt method in `config.xml`:
2828

@@ -52,7 +52,7 @@ Basic implementation is a good start point but it's recommended to provide own i
5252

5353
The `Magento_InstantPurchase` module does not introduce backward incompatible changes.
5454

55-
You can track [backward incompatible changes in patch releases](https://devdocs.magento.com/guides/v2.2/release-notes/changes/ce_changes.html).
55+
You can track [backward incompatible changes in patch releases](https://devdocs.magento.com/guides/v2.3/release-notes/backward-incompatible-changes/reference.html).
5656

5757
***
5858

‎app/code/Magento/Payment/Model/Method/AbstractMethod.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@
1818
/**
1919
* Payment method abstract model
2020
*
21+
* phpcs:disable Magento2.Classes.AbstractApi
2122
* @api
2223
* @SuppressWarnings(PHPMD.ExcessivePublicCount)
2324
* @SuppressWarnings(PHPMD.TooManyFields)
2425
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
2526
* @deprecated 100.0.6
2627
* @see \Magento\Payment\Model\Method\Adapter
27-
* @see https://devdocs.magento.com/guides/v2.1/payments-integrations/payment-gateway/payment-gateway-intro.html
28+
* @see https://devdocs.magento.com/guides/v2.3/payments-integrations/payment-gateway/payment-gateway-intro.html
2829
* @since 100.0.2
2930
*/
3031
abstract class AbstractMethod extends \Magento\Framework\Model\AbstractExtensibleModel implements

‎app/code/Magento/QuoteAnalytics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Magento_QuoteAnalytics
22

3-
The Magento_QuoteAnalytics module configures data definitions for a data collection related to the Quote module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.2/advanced-reporting/modules.html).
3+
The Magento_QuoteAnalytics module configures data definitions for a data collection related to the Quote module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html).

0 commit comments

Comments
 (0)