Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit d9db3ab

Browse files
authored
Merge pull request magento-commerce/devdocs#2619
DOC-515: Rearrange QPT and add a widget
2 parents 0cbe58c + 9154a54 commit d9db3ab

File tree

11 files changed

+261
-45
lines changed

11 files changed

+261
-45
lines changed

src/_data/toc/software-update-guide.yml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,21 +69,22 @@ pages:
6969
- label: Add or update components
7070
url: /install-gde/install/cli/dev_add-update.html
7171

72-
- label: Apply patches
73-
url: /comp-mgr/patching.html
72+
- label: Quality Patches Tool
73+
url: /quality-patches/tool.html
74+
versionless: true
7475
children:
7576

76-
- label: Quality Patches Tool
77-
url: /comp-mgr/patching/mqp.html
78-
children:
77+
- label: Usage
78+
url: /quality-patches/usage.html
79+
versionless: true
7980

80-
- label: Quality patches for Adobe Commerce
81-
url: /quality-patches/release-notes-commerce.html
82-
versionless: true
81+
- label: Release notes
82+
url: /quality-patches/release-notes.html
83+
versionless: true
8384

84-
- label: Quality patches for Magento Open Source
85-
url: /quality-patches/release-notes-open-source.html
86-
versionless: true
85+
- label: Apply patches
86+
url: /comp-mgr/patching.html
87+
children:
8788

8889
- label: Command Line
8990
url: /comp-mgr/patching/command-line.html

src/_data/whats-new.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ entries:
330330
- Major Update
331331
- 2.4.3
332332
- description: Added [Community quality patches release notes](https://github.com/magento/quality-patches/blob/master/community-release-notes.md)
333-
to a table of contents at [Commerce Quality Patches](https://devdocs.magento.com/guides/v2.4/comp-mgr/patching/mqp.html).
333+
to a table of contents at [Commerce Quality Patches](https://devdocs.magento.com/quality-patches/usage.html).
334334
versions: 2.x
335335
type: Major Update
336336
date: August 27, 2021
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
The [Quality Patches Tool](https://github.com/magento/quality-patches) delivers individual patches developed by Adobe and the {{ site.data.var.ce }} community. It allows you to apply, revert, and view general information about all individual patches that are available for the installed version of {{ site.data.var.ee }} or {{ site.data.var.ce }}. You can apply patches to {{site.data.var.ee}} and {{site.data.var.ce}} projects regardless of who developed the patch. For example, you can apply a patch developed by the community to {{site.data.var.ee}} projects.
22

33
{:.bs-callout-info}
4-
See [Apply patches]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) for instructions on applying patches to your {{ site.data.var.ee }} or {{ site.data.var.ce }} projects.
4+
See [Apply patches]({{ site.baseurl }}/quality-patches/usage.html) for instructions on applying patches to your {{ site.data.var.ee }} or {{ site.data.var.ce }} projects.
55
See [Patches available in the Quality Patches Tool](https://support.magento.com/hc/en-us/sections/360010506631-Patches-available-in-MQP-tool-) for additional patch details.

src/cloud/project/project-patch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ functional_areas:
1414
Both packages improve the integration of all {{site.data.var.ee}} versions with Cloud environments and support quick delivery of critical, optional, and custom fixes. You can use these packages to apply, revert, and view general information about all individual patches that are available for Magento.
1515

1616
{:.bs-callout-tip}
17-
You can use the [Quality Patches Tool]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) and [{{ site.data.var.mcp-prod }}](#standalone) packages as stand-alone packages for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects. We recommend using the Quality Patches Tool for non-Cloud projects.
17+
You can use the [Quality Patches Tool]({{ site.baseurl }}/quality-patches/usage.html) and [{{ site.data.var.mcp-prod }}](#standalone) packages as stand-alone packages for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects. We recommend using the Quality Patches Tool for non-Cloud projects.
1818

1919
When you deploy changes to the remote environment, `{{site.data.var.ct}}` uses {{ site.data.var.mcp-package }} and `magento/quality-patches` to check for pending patches and applies them automatically in the following order:
2020

@@ -201,7 +201,7 @@ To apply and test a custom patch on a Cloud environment:
201201

202202
## Apply patches to a non-Cloud project {#standalone}
203203

204-
Use the [Quality Patches Tool]({{ site.baseurl }}{{ site.gdeurl }}/comp-mgr/patching/mqp.html) for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects.
204+
Use the [Quality Patches Tool]({{ site.baseurl }}/quality-patches/usage.html) for {{ site.data.var.ce }} and {{ site.data.var.ee }} projects.
205205

206206
## Revert a patch in a local environment
207207

src/common/js/qpt.app.min.js

Lines changed: 179 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/guides/v2.4/comp-mgr/patching/mqp.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/quality-patches/release-notes-open-source.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

src/quality-patches/release-notes-commerce.md renamed to src/quality-patches/release-notes.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
---
22
group: software-update-guide
3-
title: Quality patches for Adobe Commerce
3+
title: Release notes
44
functional_areas:
55
- Setup
66
- Configuration
77
- Upgrade
8-
redirect_from: /quality-patches/release-notes.html
8+
redirect_from:
9+
- /quality-patches/release-notes-commerce.html
10+
- /quality-patches/release-notes-open-source.html
911
---
1012

1113
{% include install/patch/quality-patch-intro.md %}
1214

13-
For information about quality patches created by the community for {{site.data.var.ce}}, see the [release notes](https://github.com/magento/quality-patches/blob/master/community-release-notes.md).
15+
{: .bs-callout-info}
16+
For information about quality patches created by the Community for {{site.data.var.ce}}, see the [release notes](https://github.com/magento/quality-patches/blob/master/community-release-notes.md).
1417

1518
<!-- The release notes include:
1619
@@ -138,7 +141,7 @@ For information about quality patches created by the community for {{site.data.v
138141

139142
## v1.0.20
140143

141-
- **MDVA-36170** _(for Magento `>=2.3.4 <2.4.2`)_-This fixes the issue where the GraphqQL query is not caching by using the category cache tag.
144+
- **MDVA-36170** _(for Magento `>=2.3.4 <2.4.2`)_-This fixes the issue where the GraphQL query is not caching by using the category cache tag.
142145
- **MDVA-33168** _(for Magento `>=2.3.3 <2.4.2`)_-Fixes the issue when updating a product attribute via API all other attributes change to an empty value.
143146
- **MDVA-19640** _(for Magento `>=2.3.0`)_-Fixes the issue where Advanced Reporting is not showing any data.
144147
- **MDVA-11189** _(for Magento `>=2.3.0 <2.3.5`)_-Fixes the issue when after importing a .csv file to update product stock, rows from the cataloginventory_stock table are deleted.

src/quality-patches/tool.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
group: software-update-guide
3+
title: Quality Patches Tool
4+
functional_areas:
5+
- Upgrade
6+
---
7+
8+
The [Quality Patches Tool][github] is a command-line tool that delivers
9+
quality patches for {{site.data.var.ee}} and {{site.data.var.ce}}.
10+
11+
It allows you to:
12+
13+
* View general information about the latest quality patches
14+
* Apply quality patches
15+
* Revert applied patches
16+
17+
**{{site.data.var.ee}} support** and the **{{site.data.var.ce}} community** develop quality patches.
18+
19+
{: .bs-callout-note}
20+
The Quality Patches Tool is for quality patches only. Security patches
21+
are available in the [Magento Security Center][security] .
22+
23+
## Available patches {#patch-grid}
24+
25+
<div id="root"></div>
26+
27+
<script src="{{ site.baseurl }}/common/js/qpt.app.min.js?v=1"></script>
28+
29+
## Related topics {#related-topics}
30+
31+
* [Quality Patches Tool release notes][notes]
32+
* [How to install and use Quality Patches Tool for Adobe Commerce on
33+
cloud infrastructure][cloud]
34+
* [How to install and use Quality Patches Tool for Adobe Commerce &
35+
Magento Open Source][standalone]
36+
37+
<!-- link definitions -->
38+
[cloud]: {{ site.baseurl }}/cloud/project/project-patch.html
39+
[github]: https://github.com/magento/quality-patches
40+
[notes]: {{ site.baseurl }}/quality-patches/release-notes.html
41+
[security]: https://magento.com/security/patches
42+
[standalone]: {{ site.baseurl }}/quality-patches/usage.html

src/guides/v2.3/comp-mgr/patching/mqp.md renamed to src/quality-patches/usage.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
---
22
group: software-update-guide
3-
title: Quality Patches Tool
3+
title: Usage
44
functional_areas:
55
- Upgrade
6+
redirect_from:
7+
- guides/v2.4/comp-mgr/patching/mqp.html
8+
- guides/v2.3/comp-mgr/patching/mqp.html
69
---
710

811
{% include install/patch/quality-patch-intro.md %}
912

1013
{:.bs-callout-warning}
1114
We do not recommend using the Quality Patches Tool to apply large numbers of patches because it increases the complexity of your code, which makes upgrading to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }} more difficult.
1215

13-
#### Install
16+
## Install
1417

1518
{:.bs-callout-info}
1619
If it is not already installed, you must install [Git](https://github.com/git-guides/install-git) or [Patch](https://man7.org/linux/man-pages/man1/patch.1.html) before installing the Quality Patches Tool.
@@ -20,7 +23,7 @@ Add the `magento/quality-patches` Composer package to your `composer.json` file:
2023
composer require magento/quality-patches
2124
```
2225

23-
#### View individual patches
26+
## View individual patches
2427

2528
To view the list of individual patches available for your version of {{ site.data.var.ee }} or {{ site.data.var.ce }}:
2629

@@ -86,10 +89,10 @@ The status table contains the following types of information:
8689
{:.bs-callout-info}
8790
After upgrading to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }}, you must re-apply patches if the patches are not included in the new version. See [Re-apply patches after an upgrade](#upgrade).
8891

89-
#### Apply individual patches
92+
## Apply individual patches
9093

9194
{:.bs-callout-warning}
92-
We strongly recommend testing all patches in a staging or development environment before deploying to production. We also strongly recommend backing up your data before applying a patch. See [Back up and roll back the file system]({{ page.baseurl }}/install-gde/install/cli/install-cli-backup.html).
95+
We strongly recommend testing all patches in a staging or development environment before deploying to production. We also strongly recommend backing up your data before applying a patch. See [Back up and roll back the file system][backup].
9396

9497
To apply a single patch, run the following command where `MAGETWO-XXXX` is the patch ID specified in the status table:
9598

@@ -112,10 +115,10 @@ You must clean the cache after applying patches to see changes in the Magento ap
112115
{:.bs-callout-info}
113116
Consider keeping a list of applied patches in a separate location. You might need to re-apply some of them after upgrading to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }}. See [Re-apply patches after an upgrade](#upgrade).
114117

115-
#### Revert individual patches
118+
## Revert individual patches
116119

117120
{:.bs-callout-warning}
118-
We strongly recommend testing all patches in a staging or development environment before deploying to production. We also strongly recommend backing up your data before applying a patch. See [Back up and roll back the file system]({{ page.baseurl }}/install-gde/install/cli/install-cli-backup.html).
121+
We strongly recommend testing all patches in a staging or development environment before deploying to production. We also strongly recommend backing up your data before applying a patch. See [Back up and roll back the file system][backup].
119122

120123
To revert a single patch, run the following command where `MAGETWO-XXXX` is the patch ID specified in the status table:
121124

@@ -141,7 +144,7 @@ You must clean the cache after reverting patches to see changes in the Magento a
141144
./bin/magento cache:clean
142145
```
143146

144-
#### Get updates
147+
## Get updates
145148

146149
Magento periodically releases new individual patches. You must update the Quality Patches Tool to get new individual patches:
147150

@@ -158,7 +161,7 @@ New add patches display at the bottom of the table.
158161
./vendor/bin/magento-patches status
159162
```
160163

161-
#### Re-apply patches after an upgrade {#upgrade}
164+
## Re-apply patches after an upgrade {#upgrade}
162165

163166
When you upgrade to a new version of {{ site.data.var.ee }} or {{ site.data.var.ce }}, you must re-apply patches if the patches are not included in the new version.
164167

@@ -190,6 +193,9 @@ To re-apply patches:
190193
{:.bs-callout-info}
191194
When you run the `status` command, the patches that where included in the new version are no longer displayed in the table of available patches.
192195

193-
#### Logging
196+
## Logging
194197

195198
The Quality Patches Tool logs all operations in the `<Magento_root>/var/log/patch.log` file.
199+
200+
<!-- link definitions -->
201+
[backup]: {{ site.baseurl }}{{ site.gdeurl }}/install-gde/install/cli/install-cli-backup.html

0 commit comments

Comments
 (0)