Skip to content

Commit 57471a6

Browse files
authored
Merge pull request #57806 from mletalie/OSDOCS-5591
Example command punctuation lacks consistency
2 parents 67c567d + d5b9a00 commit 57471a6

File tree

4 files changed

+34
-36
lines changed

4 files changed

+34
-36
lines changed

modules/rosa-common-commands.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
// Module included in the following assemblies:
33
//
44
// * cli_reference/rosa_cli/rosa-manage-objects-cli.adoc
5-
5+
:_content-type: REFERENCE
66
[id="rosa-common-commands_{context}"]
77
= Common commands and arguments
88

9-
109
These common commands and arguments are available for the `rosa` CLI.
1110

1211
[id="rosa-debug_{context}"]
@@ -26,13 +25,13 @@ $ rosa create cluster --cluster=<cluster_name> --debug
2625
Displays general help information for the `rosa` CLI and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as `version` or `create`.
2726

2827
.Examples
29-
Displays general help for the `rosa` CLI:
28+
Displays general help for the `rosa` CLI.
3029
[source,terminal]
3130
----
3231
$ rosa --help
3332
----
3433

35-
Displays general help for `version`:
34+
Displays general help for `version`.
3635
[source,terminal]
3736
----
3837
$ rosa version --help

modules/rosa-create-objects.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Module included in the following assemblies:
33
//
44
// * cli_reference/rosa_cli/rosa-manage-objects-cli.adoc
5-
5+
:_content-type: REFERENCE
66
[id="rosa-create-objects_{context}"]
77
= Create objects
88

@@ -94,7 +94,7 @@ $ rosa create admin --cluster=<cluster_name> | <cluster_id>
9494
|===
9595

9696
.Example
97-
Create a cluster administrator that can log in to a cluster named `mycluster`:
97+
Create a cluster administrator that can log in to a cluster named `mycluster`.
9898

9999
[source,terminal]
100100
----
@@ -208,21 +208,21 @@ When using `--private-link`, the `--subnet-ids` argument is required and only on
208208
|===
209209

210210
.Examples
211-
Create a cluster named `mycluster`:
211+
Create a cluster named `mycluster`.
212212

213213
[source,terminal]
214214
----
215215
$ rosa create cluster --cluster=mycluster
216216
----
217217

218-
Create a cluster with a specific AWS region:
218+
Create a cluster with a specific AWS region.
219219

220220
[source,terminal]
221221
----
222222
$ rosa create cluster --cluster=mycluster --region=us-east-2
223223
----
224224

225-
Create a cluster with autoscaling enabled on the default worker machine pool:
225+
Create a cluster with autoscaling enabled on the default worker machine pool.
226226

227227
[source,terminal]
228228
----
@@ -373,14 +373,14 @@ $ rosa create idp --cluster=<cluster_name> | <cluster_id> [arguments]
373373
|===
374374

375375
.Examples
376-
Add a GitHub identity provider to a cluster named `mycluster`:
376+
Add a GitHub identity provider to a cluster named `mycluster`.
377377

378378
[source,terminal]
379379
----
380380
$ rosa create idp --type=github --cluster=mycluster
381381
----
382382

383-
Add an identity provider following interactive prompts:
383+
Add an identity provider following interactive prompts.
384384

385385
[source,terminal]
386386
----
@@ -435,21 +435,21 @@ $ rosa create ingress --cluster=<cluster_name> | <cluster_id> [arguments]
435435
|===
436436

437437
.Examples
438-
Add an internal ingress to a cluster named `mycluster`:
438+
Add an internal ingress to a cluster named `mycluster`.
439439

440440
[source,terminal]
441441
----
442442
$ rosa create ingress --private --cluster=mycluster
443443
----
444444

445-
Add a public ingress to a cluster named `mycluster`:
445+
Add a public ingress to a cluster named `mycluster`.
446446

447447
[source,terminal]
448448
----
449449
$ rosa create ingress --cluster=mycluster
450450
----
451451

452-
Add an ingress with a route selector label match:s
452+
Add an ingress with a route selector label match.
453453

454454
[source,terminal]
455455
----
@@ -522,28 +522,28 @@ $ rosa create machinepool --cluster=<cluster_name> | <cluster_id> --replicas=<nu
522522
|===
523523

524524
.Examples
525-
Interactively add a machine pool to a cluster named `mycluster`:
525+
Interactively add a machine pool to a cluster named `mycluster`.
526526

527527
[source,terminal]
528528
----
529529
$ rosa create machinepool --cluster=mycluster --interactive
530530
----
531531

532-
Add a machine pool that is named `mp-1` to a cluster with autoscaling enabled:
532+
Add a machine pool that is named `mp-1` to a cluster with autoscaling enabled.
533533

534534
[source,terminal]
535535
----
536536
$ rosa create machinepool --cluster=mycluster --enable-autoscaling --min-replicas=2 --max-replicas=5 --name=mp-1
537537
----
538538

539-
Add a machine pool that is named `mp-1` with 3 replicas of `m5.xlarge` to a cluster:
539+
Add a machine pool that is named `mp-1` with 3 replicas of `m5.xlarge` to a cluster.
540540

541541
[source,terminal]
542542
----
543543
$ rosa create machinepool --cluster=mycluster --replicas=3 --instance-type=m5.xlarge --name=mp-1
544544
----
545545

546-
Add a machine pool with labels to a cluster:
546+
Add a machine pool with labels to a cluster.
547547

548548
[source,terminal]
549549
----
@@ -566,7 +566,7 @@ $ rosa create ocm-role [flags]
566566
|===
567567
|Option |Definition
568568

569-
|--admin
569+
|--admin
570570
|Enable admin capabilities for the role.
571571

572572
|--debug

modules/rosa-list-objects.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * cli_reference/rosa_cli/rosa-manage-objects-cli.adoc
4-
4+
:_content-type: REFERENCE
55
[id="rosa-list-objects_{context}"]
66
= List and describe objects
77

@@ -122,7 +122,7 @@ $ rosa list idps --cluster=<cluster_name> | <cluster_id> [arguments]
122122
|===
123123

124124
.Example
125-
List all identity providers (IDPs) for a cluster named `mycluster`:
125+
List all identity providers (IDPs) for a cluster named `mycluster`.
126126

127127
[source,terminal]
128128
----
@@ -168,7 +168,7 @@ $ rosa list ingresses --cluster=<cluster_name> | <cluster_id> [arguments]
168168
|===
169169

170170
.Example
171-
List all API and ingress endpoints for a cluster named `mycluster`:
171+
List all API and ingress endpoints for a cluster named `mycluster`.
172172

173173
[source,terminal]
174174
----
@@ -204,7 +204,7 @@ $ rosa list instance-types [arguments]
204204
|===
205205

206206
.Example
207-
List all instance types:
207+
List all instance types.
208208

209209
[source,terminal]
210210
----
@@ -250,7 +250,7 @@ $ rosa list machinepools --cluster=<cluster_name> | <cluster_id> [arguments]
250250
|===
251251

252252
.Example
253-
List all of the machine pools on a cluster named `mycluster`:
253+
List all of the machine pools on a cluster named `mycluster`.
254254

255255
[source,terminal]
256256
----
@@ -296,7 +296,7 @@ $ rosa list regions [arguments]
296296
|===
297297

298298
.Example
299-
List all of the available regions:
299+
List all of the available regions.
300300

301301
[source,terminal]
302302
----
@@ -342,7 +342,7 @@ $ rosa list upgrades --cluster=<cluster_name> | <cluster_id> [arguments]
342342
|===
343343

344344
.Example
345-
List all of the available upgrades for a cluster named `mycluster`:
345+
List all of the available upgrades for a cluster named `mycluster`.
346346

347347
[source,terminal]
348348
----
@@ -387,7 +387,7 @@ $ rosa list users --cluster=<cluster_name> | <cluster_id> [arguments]
387387
|===
388388

389389
.Example
390-
List all of the cluster administrators and dedicated administrators for a cluster named `mycluster`:
390+
List all of the cluster administrators and dedicated administrators for a cluster named `mycluster`.
391391

392392
[source,terminal]
393393
----
@@ -424,7 +424,7 @@ $ rosa list versions [arguments]
424424
|===
425425

426426
.Example
427-
List all of the OpenShift Container Platform versions:
427+
List all of the OpenShift Container Platform versions.
428428

429429
[source,terminal]
430430
----
@@ -470,7 +470,7 @@ $ rosa describe admin --cluster=<cluster_name> | <cluster_id> [arguments]
470470
|===
471471

472472
.Example
473-
Describe the `cluster-admin` user for a cluster named `mycluster`:
473+
Describe the `cluster-admin` user for a cluster named `mycluster`.
474474

475475
[source,terminal]
476476
----
@@ -507,7 +507,7 @@ $ rosa describe addon <addon_id> | <addon_name> [arguments]
507507
|===
508508

509509
.Example
510-
Describe an add-on named `dbaas-operator`:
510+
Describe an add-on named `dbaas-operator`.
511511

512512
[source,terminal]
513513
----
@@ -553,7 +553,7 @@ $ rosa describe cluster --cluster=<cluster_name> | <cluster_id> [arguments]
553553
|===
554554

555555
.Example
556-
Describe a cluster named `mycluster`:
556+
Describe a cluster named `mycluster`.
557557
[source,terminal]
558558
----
559559
$ rosa describe cluster --cluster=mycluster

modules/rosa-upgrade-cluster-cli.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
// Module included in the following assemblies:
33
//
44
// * cli_reference/rosa_cli/rosa-manage-objects-cli.adoc
5-
5+
:_content-type: REFERENCE
66
[id="rosa-upgrading-cluster_{context}"]
77
= Upgrade and delete upgrade for clusters
88

9-
109
This section describes the `upgrade` command usage for clusters.
1110

1211
[id="rosa-upgrade-cluster_{context}"]
@@ -54,14 +53,14 @@ $ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
5453
|===
5554

5655
.Examples
57-
Interactively schedule an upgrade on a cluster named `mycluster`:
56+
Interactively schedule an upgrade on a cluster named `mycluster`.
5857

5958
[source,terminal]
6059
----
6160
$ rosa upgrade cluster --cluster=mycluster --interactive
6261
----
6362

64-
Schedule a cluster upgrade within the hour on a cluster named `mycluster`:
63+
Schedule a cluster upgrade within the hour on a cluster named `mycluster`.
6564

6665
[source,terminal]
6766
----
@@ -71,7 +70,7 @@ $ rosa upgrade cluster --cluster=mycluster --version 4.5.20
7170
[id="rosa-delete-upgrade-cluster_{context}"]
7271
== delete upgrade
7372

74-
Cancel a scheduled cluster upgrade:
73+
Cancel a scheduled cluster upgrade.
7574

7675
.Syntax
7776
[source,terminal]

0 commit comments

Comments
 (0)