Skip to content

Commit ac83d3c

Browse files
authored
Update patching docs to use hyphen instead of en dash (#826)
1 parent fff094e commit ac83d3c

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/preview/continuous-patching/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ az acr supply-chain workflow create -r <registryname> -g <resourcegroupname> -t
128128
```
129129
Example Command:
130130
```sh
131-
az acr supply-chain workflow create -r myRegistry -g myResourceGroup -t continuouspatchv1 -config ./continuouspatching.json --schedule 1d -dry-run
131+
az acr supply-chain workflow create -r myRegistry -g myResourceGroup -t continuouspatchv1 --config ./continuouspatching.json --schedule 1d --dry-run
132132
```
133133

134134
The ```--dry-run``` flag will output all specified artifacts by the JSON file configuration. Customers can verify that the right artifacts are selected. With the sample ubuntu configuration above, the following results should be displayed as output.
@@ -157,12 +157,12 @@ The ```--schedule``` parameter follows a fixed-day multiplier starting from day
157157

158158
Command Schema:
159159
```sh
160-
az acr supply-chain workflow create -r <registryname> -g <resourcegroupname> -t continuouspatchv1 -config <JSONfilename> --schedule <number of days> --run-immediately
160+
az acr supply-chain workflow create -r <registryname> -g <resourcegroupname> -t continuouspatchv1 --config <JSONfilename> --schedule <number of days> --run-immediately
161161
```
162162

163163
Example Command:
164164
```sh
165-
az acr supply-chain workflow create -r myRegistry -g myResourceGroup -t continuouspatchv1 -config ./continuouspatching.json --schedule 1d --run-immediately
165+
az acr supply-chain workflow create -r myRegistry -g myResourceGroup -t continuouspatchv1 --config ./continuouspatching.json --schedule 1d --run-immediately
166166
```
167167

168168
Upon a successful command (whether or not you include ```--run-immediately```), you will see:
@@ -185,9 +185,9 @@ Next, click on "Tasks” under "Services”. You should see 3 new tasks, named t
185185

186186
![PortalTasks](./media/portal_tasks1.png)
187187

188-
- cssc-trigger-workflow this task scans the configuration file and calls the scan task on each respective image.
189-
- cssc-scan-image this task scans the image for operating system vulnerabilities. This task will only trigger the patching task only if (1) operating system vulnerabilities were found, and (2) the image is not considered End of Service Life (EOSL). For more information on EOSL, please consult [Preview Limitations](#preview-limitations).
190-
- cssc-patch-image this task patches the image.
188+
- cssc-trigger-workflow - this task scans the configuration file and calls the scan task on each respective image.
189+
- cssc-scan-image - this task scans the image for operating system vulnerabilities. This task will only trigger the patching task only if (1) operating system vulnerabilities were found, and (2) the image is not considered End of Service Life (EOSL). For more information on EOSL, please consult [Preview Limitations](#preview-limitations).
190+
- cssc-patch-image - this task patches the image.
191191
These tasks work in conjunction to execute your continuous patching workflow.
192192

193193
You can also click on "Runs” within the "Tasks” view to see specific task runs. Here you can view status information on whether the task succeeded or failed, along with viewing a debug log.
@@ -248,7 +248,7 @@ az acr supply-chain workflow delete -r <registry> -g <resourceGroup> -t continuo
248248
```
249249
Example Command
250250
```sh
251-
az acr supply-chain workflow delete -r myregistry -g myresourcegroup t continuouspatchv1
251+
az acr supply-chain workflow delete -r myregistry -g myresourcegroup -t continuouspatchv1
252252
```
253253
Help command to see all required/optional flags
254254
```sh
@@ -261,7 +261,7 @@ Once a workflow is successfully deleted, the repository "csscpolicies/patchpolic
261261

262262
To list the most recently executed Continuous Patching tasks, the following List command is available:
263263
```sh
264-
az acr supply-chain workflow list -r <registryname> -g <resourcegroup> [-run-status <failed || successful || running>] -t continuouspatchv1
264+
az acr supply-chain workflow list -r <registryname> -g <resourcegroup> [--run-status <failed || successful || running>] -t continuouspatchv1
265265
```
266266

267267
A successful result will return the following information:
@@ -325,7 +325,7 @@ If the logs aren't sufficient, or an issue is persistent, or for any feedback, p
325325
**Possible CLI Outputs for 'List' Command**
326326

327327
```sh
328-
az acr supply-chain workflow list -r <registryname> -g <resourcegroup> [-run-status <Failed || Queued || Running || Skipped || Succeeded || Unknown>]
328+
az acr supply-chain workflow list -r <registryname> -g <resourcegroup> [--run-status <Failed || Queued || Running || Skipped || Succeeded || Unknown>]
329329
```
330330

331331
If scan and patch are successful
@@ -472,4 +472,4 @@ image: import:dotnetapp-manual
472472
patch task ID: xyz2
473473
last patched image: ---Not Available---
474474
workflow type: continuouspatchv1
475-
```
475+
```

0 commit comments

Comments
 (0)