Skip to content

Commit fdd6973

Browse files
authored
Patcher-214 update remaining screenshots to v0.3.3 (#931)
* Fixed typos * Updated screenshots * Updated changelog descriptions * Minor text tweaks
1 parent bd966ee commit fdd6973

File tree

14 files changed

+36
-48
lines changed

14 files changed

+36
-48
lines changed

_docs-sources/patcher/running-patcher/report.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,20 @@ The `patcher report` command is a read-only version of Patcher that shows the ch
44

55
After scanning for dependencies, Patcher will show you the 'Modules View', similar to the screenshot below.
66

7-
![Patcher Report screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-overview-futd.png)
7+
![Patcher report screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-overview-futd.png)
88

99
### Navigation commands
1010

1111
1. While in the modules view, press `u` to see the usages. It shows all places where module is being used:
1212

13-
![Patcher Usages screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-usages.png)
13+
![Patcher usages screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-usages.png)
1414

1515
2. While in the modules view, press `v` to see the changelogs from a module. Press `o` to open the page in the browser.
1616

17-
![Patcher Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-changelog.png)
17+
![Patcher changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-changelog.png)
1818

19-
:::info
20-
Some modules do not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
19+
Some modules including third party modules may not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
2120

22-
:::
23-
24-
![Patcher No Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-no-changelog.png)
21+
![Patcher no changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-no-changelog.png)
2522

2623

_docs-sources/patcher/running-patcher/update.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,36 +25,33 @@ If Patcher can update one or more usages of a module to a newer version, then Pa
2525

2626
* "Hit «b» to update all usages to the next version, even if it's a breaking change."
2727

28-
![Patcher Update screenshot showing dependency that can be updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-update-available.png)
28+
![Patcher update screenshot showing dependency that can be updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-update-available.png)
2929

3030
Pressing `ENTER` will update all the usages of that module to either the highest version before the next closest breaking change or the latest version of the dependecy, whichever is encountered first.
3131

3232
Pressing `b` will update all the usages of that module to either the next closest breaking change or the latest version of the dependency, whichever is encountered first.
3333

3434
After updating the "Up to date" column is changed to show "Updated". This indicates that at least one of the dependencies on that module have been updated.
3535

36-
![Patcher Update screenshot showing dependency that has been updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-updated.png)
36+
![Patcher update screenshot showing dependency that has been updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-updated.png)
3737

3838
When you quit Patcher, it writes the details of all the updates to stdout in YAML format, for example:
3939

40-
![Patcher Update screenshot showing YAML output](/img/guides/stay-up-to-date/patcher/patcher-update-yaml-output.png)
40+
![Patcher update screenshot showing YAML output](/img/guides/stay-up-to-date/patcher/patcher-update-yaml-output.png)
4141

4242
### Navigation commands
4343

4444
1. While in the modules view, press `u` to see the usages. It shows all places where module is being used:
4545

46-
![Patcher Usages screenshot showing module with multiple usages](/img/guides/stay-up-to-date/patcher/patcher-update-usages-update-available.png)
46+
![Patcher usages screenshot showing module with multiple usages](/img/guides/stay-up-to-date/patcher/patcher-update-usages-update-available.png)
4747

4848
2. While in the modules view, press `v` to see the changelogs from a module. Press `o` to open the page in the browser.
4949

50-
![Patcher Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-changelog.png)
50+
![Patcher changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-changelog.png)
5151

52-
:::info
53-
Some modules do not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
52+
Some modules including third party modules may not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
5453

55-
:::
56-
57-
![Patcher No Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-no-changelog.png)
54+
![Patcher no changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-no-changelog.png)
5855

5956
## Non-Interactive Mode
6057

@@ -88,7 +85,7 @@ patcher update --non-interactive --update-strategy next-breaking
8885

8986
## Support for Third Party Modules
9087

91-
Starting in `0.3.3`, Patcher provides limited support for updating third party modules, this includes your own modules. The updates to third party module are limited to bumping the semver patch version.
88+
Beginning with version `0.3.3`, Patcher provides limited support for updating third party modules, including your own modules. The updates to third party module are limited to bumping the semver patch version.
9289

9390
Third party modules are supported in both interactive mode and non-interactive mode.
9491

_docs-sources/patcher/running-patcher/upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The `patcher upgrade cis` command is only available in `v0.1.x`.
66

7-
This will upgrade your service catalogs to the latest module versions in the context of CIS v1.5.
7+
This will upgrade your service catalog to the latest module versions in the context of CIS v1.5.
88

99
For the CIS AWS Foundations Benchmark v1.5 upgrade, refer to [the upgrade guide](https://docs.gruntwork.io/guides/stay-up-to-date/cis/cis-1.5.0/).
1010

_docs-sources/patcher/update-strategies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ This is an example of the YAML that Patcher writes to `stdout` describing these
4545
4646
The **next breaking** strategy will update a dependency to either the next closest breaking change or the latest version of the dependency, whichever is encountered first.
4747
48-
So if Patcher encounters a breaking change that it cannot patch then it will update the dependencies to the version with the breaking change and stop. Otherwise, if no breaking chnages are encountered it will update the dependencies the latest version of that module.
48+
So if Patcher encounters a breaking change that it cannot patch then it will update the dependencies to the version with the breaking change and stop. Otherwise, if no breaking changes are encountered it will update the dependencies the latest version of that module.
4949
5050
This may result in an update that requires manual intervention. If so, Patcher will provide additional information to help you understand what needs to be done.
5151
52-
Patcher does this by writing a `README-TO-COMPLETE-UPDATE.md` into the folder containing the dependendency. If more than one dependency in a folder has been update to a breaking version, then the `README-TO-COMPLETE-UPDATE.md` file will contain a release note extracts for each breaking change in that folder.
52+
Patcher does this by writing a `README-TO-COMPLETE-UPDATE.md` into the folder containing the dependency. If more than one dependency in a folder has been updated to a breaking version, then the `README-TO-COMPLETE-UPDATE.md` file will contain a release note extract for each breaking change in that folder.
5353

5454
For example, for the dependencies on `terraform-aws-security/custom-iam-entity` in `infrastructure-live/dev`:
5555
- `_global/ops-admin-role/terragrunt.hcl` will be updated from `0.65.6` to `0.68.2`, the latest version

docs/patcher/running-patcher/report.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,28 @@ The `patcher report` command is a read-only version of Patcher that shows the ch
44

55
After scanning for dependencies, Patcher will show you the 'Modules View', similar to the screenshot below.
66

7-
![Patcher Report screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-overview-futd.png)
7+
![Patcher report screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-overview-futd.png)
88

99
### Navigation commands
1010

1111
1. While in the modules view, press `u` to see the usages. It shows all places where module is being used:
1212

13-
![Patcher Usages screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-usages.png)
13+
![Patcher usages screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-usages.png)
1414

1515
2. While in the modules view, press `v` to see the changelogs from a module. Press `o` to open the page in the browser.
1616

17-
![Patcher Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-changelog.png)
17+
![Patcher changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-changelog.png)
1818

19-
:::info
20-
Some modules do not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
19+
Some modules including third party modules may not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
2120

22-
:::
23-
24-
![Patcher No Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-no-changelog.png)
21+
![Patcher no changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-report-no-changelog.png)
2522

2623

2724

2825

2926
<!-- ##DOCS-SOURCER-START
3027
{
3128
"sourcePlugin": "local-copier",
32-
"hash": "d6f9fd3e76d5fd54e54c22b3a2433cca"
29+
"hash": "c1edfeb185cc8f36c8c8d7b28b410d2d"
3330
}
3431
##DOCS-SOURCER-END -->

docs/patcher/running-patcher/update.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,36 +25,33 @@ If Patcher can update one or more usages of a module to a newer version, then Pa
2525

2626
* "Hit «b» to update all usages to the next version, even if it's a breaking change."
2727

28-
![Patcher Update screenshot showing dependency that can be updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-update-available.png)
28+
![Patcher update screenshot showing dependency that can be updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-update-available.png)
2929

3030
Pressing `ENTER` will update all the usages of that module to either the highest version before the next closest breaking change or the latest version of the dependecy, whichever is encountered first.
3131

3232
Pressing `b` will update all the usages of that module to either the next closest breaking change or the latest version of the dependency, whichever is encountered first.
3333

3434
After updating the "Up to date" column is changed to show "Updated". This indicates that at least one of the dependencies on that module have been updated.
3535

36-
![Patcher Update screenshot showing dependency that has been updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-updated.png)
36+
![Patcher update screenshot showing dependency that has been updated](/img/guides/stay-up-to-date/patcher/patcher-update-overview-updated.png)
3737

3838
When you quit Patcher, it writes the details of all the updates to stdout in YAML format, for example:
3939

40-
![Patcher Update screenshot showing YAML output](/img/guides/stay-up-to-date/patcher/patcher-update-yaml-output.png)
40+
![Patcher update screenshot showing YAML output](/img/guides/stay-up-to-date/patcher/patcher-update-yaml-output.png)
4141

4242
### Navigation commands
4343

4444
1. While in the modules view, press `u` to see the usages. It shows all places where module is being used:
4545

46-
![Patcher Usages screenshot showing module with multiple usages](/img/guides/stay-up-to-date/patcher/patcher-update-usages-update-available.png)
46+
![Patcher usages screenshot showing module with multiple usages](/img/guides/stay-up-to-date/patcher/patcher-update-usages-update-available.png)
4747

4848
2. While in the modules view, press `v` to see the changelogs from a module. Press `o` to open the page in the browser.
4949

50-
![Patcher Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-changelog.png)
50+
![Patcher changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-changelog.png)
5151

52-
:::info
53-
Some modules do not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
52+
Some modules including third party modules may not have a CHANGELOGS.md file. In this case, press `o` to open the releases page for that repository.
5453

55-
:::
56-
57-
![Patcher No Changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-no-changelog.png)
54+
![Patcher no changelogs screenshot](/img/guides/stay-up-to-date/patcher/patcher-update-no-changelog.png)
5855

5956
## Non-Interactive Mode
6057

@@ -88,7 +85,7 @@ patcher update --non-interactive --update-strategy next-breaking
8885

8986
## Support for Third Party Modules
9087

91-
Starting in `0.3.3`, Patcher provides limited support for updating third party modules, this includes your own modules. The updates to third party module are limited to bumping the semver patch version.
88+
Beginning with version `0.3.3`, Patcher provides limited support for updating third party modules, including your own modules. The updates to third party module are limited to bumping the semver patch version.
9289

9390
Third party modules are supported in both interactive mode and non-interactive mode.
9491

@@ -109,6 +106,6 @@ Patcher cannot update from `4.0.x` to `5.0.0` and will instead show a `?` in the
109106
<!-- ##DOCS-SOURCER-START
110107
{
111108
"sourcePlugin": "local-copier",
112-
"hash": "3d1d1fa039d2693c8799c4931f991dc5"
109+
"hash": "ef694de362e2022b29aeb7702efa81a1"
113110
}
114111
##DOCS-SOURCER-END -->

docs/patcher/running-patcher/upgrade.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The `patcher upgrade cis` command is only available in `v0.1.x`.
66

7-
This will upgrade your service catalogs to the latest module versions in the context of CIS v1.5.
7+
This will upgrade your service catalog to the latest module versions in the context of CIS v1.5.
88

99
For the CIS AWS Foundations Benchmark v1.5 upgrade, refer to [the upgrade guide](https://docs.gruntwork.io/guides/stay-up-to-date/cis/cis-1.5.0/).
1010

@@ -13,6 +13,6 @@ For the CIS AWS Foundations Benchmark v1.5 upgrade, refer to [the upgrade guide]
1313
<!-- ##DOCS-SOURCER-START
1414
{
1515
"sourcePlugin": "local-copier",
16-
"hash": "8d6569fc57af78e9ce138a63a48f74d7"
16+
"hash": "7d941e817f1029ce7855955940943a58"
1717
}
1818
##DOCS-SOURCER-END -->

docs/patcher/update-strategies.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ This is an example of the YAML that Patcher writes to `stdout` describing these
4545
4646
The **next breaking** strategy will update a dependency to either the next closest breaking change or the latest version of the dependency, whichever is encountered first.
4747
48-
So if Patcher encounters a breaking change that it cannot patch then it will update the dependencies to the version with the breaking change and stop. Otherwise, if no breaking chnages are encountered it will update the dependencies the latest version of that module.
48+
So if Patcher encounters a breaking change that it cannot patch then it will update the dependencies to the version with the breaking change and stop. Otherwise, if no breaking changes are encountered it will update the dependencies the latest version of that module.
4949
5050
This may result in an update that requires manual intervention. If so, Patcher will provide additional information to help you understand what needs to be done.
5151
52-
Patcher does this by writing a `README-TO-COMPLETE-UPDATE.md` into the folder containing the dependendency. If more than one dependency in a folder has been update to a breaking version, then the `README-TO-COMPLETE-UPDATE.md` file will contain a release note extracts for each breaking change in that folder.
52+
Patcher does this by writing a `README-TO-COMPLETE-UPDATE.md` into the folder containing the dependency. If more than one dependency in a folder has been updated to a breaking version, then the `README-TO-COMPLETE-UPDATE.md` file will contain a release note extract for each breaking change in that folder.
5353

5454
For example, for the dependencies on `terraform-aws-security/custom-iam-entity` in `infrastructure-live/dev`:
5555
- `_global/ops-admin-role/terragrunt.hcl` will be updated from `0.65.6` to `0.68.2`, the latest version
@@ -99,6 +99,6 @@ Here are the release notes for version v0.62.0:
9999
<!-- ##DOCS-SOURCER-START
100100
{
101101
"sourcePlugin": "local-copier",
102-
"hash": "8d061baf95ac0bf189c1a5f0b390e965"
102+
"hash": "10db644584a7900aa21dbf422a64586f"
103103
}
104104
##DOCS-SOURCER-END -->
439 KB
Loading
358 KB
Loading

0 commit comments

Comments
 (0)