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

Commit 1b7366c

Browse files
authored
MC-40585: Removed acronym SUT entries and changed naming convention for the Upgrade Compability Tool (#8553)
* removed acronym SUT entries, changed naming convention to upgrade compatibility tool in all areas of docs * Modified commands with uct instead of sut * Fixed page-header.html * Fixed topic after technical ENG review * Removed link to tools repo * Fixed linting issues appear after pulling from master * Removed mentions to Magento Upgrade Compatibility Tool as per email from Surya * Fixed linting issues * Fixed -m command information * Fixed internal linking * Reviewed section about -m command option * Reviewed whats new
1 parent d423330 commit 1b7366c

File tree

17 files changed

+212
-198
lines changed

17 files changed

+212
-198
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,26 @@ pages:
2121
- label: Update and upgrade checklist
2222
url: /comp-mgr/prereq/prereq_compman-checklist.html
2323

24-
- label: Safe Upgrade Tool
25-
url: /safe-upgrade-tool/introduction.html
24+
- label: Upgrade Compatibility Tool
25+
url: /upgrade-compatibility-tool/introduction.html
2626
versionless: true
2727
edition: ee-only
2828
children:
2929

3030
- label: Prerequisites
31-
url: /safe-upgrade-tool/prerequisites.html
31+
url: /upgrade-compatibility-tool/prerequisites.html
3232
versionless: true
3333

3434
- label: Install
35-
url: /safe-upgrade-tool/install.html
35+
url: /upgrade-compatibility-tool/install.html
3636
versionless: true
3737

3838
- label: Run the tool
39-
url: /safe-upgrade-tool/run.html
39+
url: /upgrade-compatibility-tool/run.html
4040
versionless: true
4141

4242
- label: Developer information
43-
url: /safe-upgrade-tool/developer.html
43+
url: /upgrade-compatibility-tool/developer.html
4444
versionless: true
4545

4646
- label: Magento Marketplace example

src/_data/whats-new.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ entries:
3030
link: https://github.com/magento/devdocs/pull/8547
3131
contributor: dobooth
3232
profile: https://github.com/dobooth
33-
- description: Added the [Safe Upgrade Tool](https://devdocs.magento.com/safe-upgrade-tool/introduction.html)
33+
- description: Added the [Upgrade Compatibility Tool](https://devdocs.magento.com/upgrade-compatibility-tool/introduction.html)
3434
topics to the Software Update Guide section.
3535
versions: ''
3636
type: Major Update, New Topic

src/_includes/layout/page-header.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ <h2 class="page-subtitle no_toc">{{ page.subtitle }}</h2>
4242
</div>
4343
{% endif %}
4444

45-
{% if page.url contains "safe-upgrade-tool/" %}
45+
{% if page.url contains "upgrade-compatibility-tool/" %}
4646
<div class="message-banner">
47-
This tool is an ALPHA version with limited scope, available for all Magento Commerce merchants, and only validating PHP Magento APIs and GraphQL schema. If you are a Magento Commerce user you can download it at the <a href="https://repo.magento.com/">Magento repo</a>.
47+
The Upgrade Compatibility Tool is an ALPHA version with limited scope, available for all Magento Commerce merchants, and only validating PHP Magento APIs and GraphQL schema. If you are a Magento Commerce user you can download it at the <a href="https://repo.magento.com/">Magento repo</a>.
4848
</div>
4949
{% endif %}
5050

src/guides/v2.3/comp-mgr/bk-compman-upgrade-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Related topics
5454
Complete the tasks discussed in [Prerequisites].
5555

5656
{:.bs-callout-info}
57-
See the [Safe Upgrade Tool ALPHA]({{site.baseurl}}/safe-upgrade-tool/introduction.html) for more information about the new Magento CLI tool that helps you update your Magento software.
57+
See the [Upgrade Compatibility Tool ALPHA]({{site.baseurl}}/upgrade-compatibility-tool/introduction.html) page for more information about the new Magento command line tool that helps you update your Magento software.
5858

5959
<!-- ABBREVIATIONS -->
6060

src/guides/v2.3/extension-dev-guide/framework/datetime.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,5 @@ use Magento\Framework\Stdlib\DateTime;
4848
{
4949
return $this->dataTime->formatDate(time());
5050
}
51+
...
5152
```

src/guides/v2.4/comp-mgr/bk-compman-upgrade-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Related topics
4949
Complete the tasks discussed in [Prerequisites].
5050

5151
{:.bs-callout-info}
52-
See the [Safe Upgrade Tool ALPHA]({{site.baseurl}}/safe-upgrade-tool/introduction.html) for more information about the new Magento CLI tool that helps you update your Magento software.
52+
See the [Upgrade Compatibility Tool ALPHA]({{site.baseurl}}/upgrade-compatibility-tool/introduction.html) page for more information about the new Magento command line tool that helps you update your Magento software.
5353

5454
<!-- ABBREVIATIONS -->
5555

src/safe-upgrade-tool/install.md

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

src/safe-upgrade-tool/introduction.md

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

src/safe-upgrade-tool/prerequisites.md

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

src/safe-upgrade-tool/developer.md renamed to src/upgrade-compatibility-tool/developer.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,25 @@ functional_areas:
66
- Upgrade
77
---
88

9-
This topic contains information for developers who want to know more technical information about the Magento Safe Upgrade Tool ALPHA (SUT). It is focused on developers who work closely with the Magento source code. You can use this knowledge to customize the SUT's components.
9+
This topic contains information for developers who want to know more technical information about the Upgrade Compatibility Tool ALPHA. It is focused on developers who work closely with the Magento source code. You can use this knowledge to customize the tool's components.
1010

1111
## Magento API index integration
1212

1313
Magento API index integration is an internal integration solution that comprehends a set of tools to explore Magento Extensions developed by Magento, an Adobe Company, Magento Partners and 3rd party vendors based on static code analysis.
1414

1515
The integration with Magento API index is done through:
1616

17-
`Sut\Domain\MRay\MRayInterface`
17+
`sut\Domain\MRay\MRayInterface`
1818

1919
It is implemented through the `config/services.yaml` file. Its value decides where the response of methods `api()` and `modules()` comes from.
2020

21-
Edit this file to customize the response according to your installation. Just replace the value assigned to `Sut\Domain\MRay\MRayInterface`:
21+
Edit this file to customize the response according to your installation. Just replace the value assigned to `sut\Domain\MRay\MRayInterface`:
2222

2323
### Example of a custom value
2424

25-
`Sut\Domain\MRay\MRayInterface : "@sut_mray_mock"`
25+
`sut\Domain\MRay\MRayInterface : "@sut_mray_mock"`
2626

27-
In the previous example, the SUT uses `@sut_mray_mock` as the `MRayInterface` implementation. The responses from the `api()` and `modules()` methods come from the following files:
27+
In the previous example, the Upgrade Compatibility Tool uses `@sut_mray_mock` as the `MRayInterface` implementation. The responses from the `api()` and `modules()` methods come from the following files:
2828

2929
* `dev/mray_mock_files/api.json`
3030
* `dev/mray_mock_files/modules.json`
@@ -59,7 +59,7 @@ To run the integration tests, execute one of the following commands:
5959

6060
## JS unit testing for GraphQL
6161

62-
We used the [Jest](https://jestjs.io/docs/en/getting-started.html) framework to create these JS unit tests:
62+
The [Jest](https://jestjs.io/docs/en/getting-started.html) framework was used to create these JS unit tests:
6363

6464
{:.bs-callout-info}
6565
To run JS unit tests for GraphQL, you must have Node.js installed.
@@ -99,7 +99,7 @@ This score is based on the results extracted from the analysis:
9999
* Number of issues identified
100100
* Severity of issues identified
101101

102-
The SUT calculates this score according to the following formula:
102+
The Upgrade Compatibility Tool calculates this score according to the following formula:
103103

104104
### Complexity score formula
105105

0 commit comments

Comments
 (0)