Skip to content

Commit 28eba6d

Browse files
authored
Regenerate tcld command reference docs (#5119)
Fixes the "The `tcld namespace capacity` command manage namespace capacity." grammar error and similar cases across the tcld reference, plus restores the plain-English e.g./i.e. wording from a prior hand patch that a straight regeneration would have reverted. The actual fix is in the gen-docs tool template in the tcld repo (unmerged PR temporalio/tcld#499); this just copies its corrected output into the docs repo. Fixes #5113
1 parent bad0c7a commit 28eba6d

15 files changed

Lines changed: 147 additions & 147 deletions

docs/cloud/tcld/account.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515

1616
{/* This is an auto-generated file. Do not edit directly. */}
1717

18-
The `tcld account` command account operations.
18+
`tcld account`: Account operations.
1919

2020
Alias: `a`
2121

@@ -26,19 +26,19 @@ Alias: `a`
2626

2727
### get
2828

29-
The `tcld account get` command get account information.
29+
`tcld account get`: Get account information.
3030

3131
Alias: `g`
3232

3333
### list-regions
3434

35-
The `tcld account list-regions` command lists all regions where the account can provision namespaces.
35+
`tcld account list-regions`: Lists all regions where the account can provision namespaces.
3636

3737
Alias: `l`
3838

3939
### metrics
4040

41-
The `tcld account metrics` command configures the metrics endpoint for the Temporal Cloud Account.
41+
`tcld account metrics`: Configures the metrics endpoint for the Temporal Cloud Account.
4242

4343
Alias: `m`
4444

@@ -48,15 +48,15 @@ Alias: `m`
4848

4949
#### enable
5050

51-
The `tcld account metrics enable` command enables the metrics endpoint. CA Certificates *must* be configured prior to enabling the endpoint.
51+
`tcld account metrics enable`: Enables the metrics endpoint. CA Certificates *must* be configured prior to enabling the endpoint.
5252

5353
#### disable
5454

55-
The `tcld account metrics disable` command disables the metrics endpoint.
55+
`tcld account metrics disable`: Disables the metrics endpoint.
5656

5757
#### accepted-client-ca
5858

59-
The `tcld account metrics accepted-client-ca` command manages configuration of ca certificates for the external metrics endpoint.
59+
`tcld account metrics accepted-client-ca`: Manages configuration of ca certificates for the external metrics endpoint.
6060

6161
Alias: `ca`
6262

@@ -67,7 +67,7 @@ Alias: `ca`
6767

6868
##### add
6969

70-
The `tcld account metrics accepted-client-ca add` command add a new ca accepted client ca certificate.
70+
`tcld account metrics accepted-client-ca add`: Add a new ca accepted client ca certificate.
7171

7272
Alias: `a`
7373

@@ -97,7 +97,7 @@ Alias: `f`
9797

9898
##### remove
9999

100-
The `tcld account metrics accepted-client-ca remove` command remove existing certificates.
100+
`tcld account metrics accepted-client-ca remove`: Remove existing certificates.
101101

102102
Alias: `r`
103103

@@ -133,7 +133,7 @@ Alias: `fp`
133133

134134
##### set
135135

136-
The `tcld account metrics accepted-client-ca set` command set the accepted client ca certificate.
136+
`tcld account metrics accepted-client-ca set`: Set the accepted client ca certificate.
137137

138138
Alias: `s`
139139

@@ -163,13 +163,13 @@ Alias: `f`
163163

164164
##### list
165165

166-
The `tcld account metrics accepted-client-ca list` command list the accepted client ca certificates currently configured for the account metrics endpoint.
166+
`tcld account metrics accepted-client-ca list`: List the accepted client ca certificates currently configured for the account metrics endpoint.
167167

168168
Alias: `l`
169169

170170
### audit-log
171171

172-
The `tcld account audit-log` command audit log commands.
172+
`tcld account audit-log`: audit log commands.
173173

174174
Alias: `al`
175175

@@ -178,7 +178,7 @@ Alias: `al`
178178

179179
#### kinesis
180180

181-
The `tcld account audit-log kinesis` command manage Kinesis audit log sink.
181+
`tcld account audit-log kinesis`: Manage Kinesis audit log sink.
182182

183183
Alias: `k`
184184

@@ -191,7 +191,7 @@ Alias: `k`
191191

192192
##### create
193193

194-
The `tcld account audit-log kinesis create` command create a kinesis audit log sink.
194+
`tcld account audit-log kinesis create`: Create a kinesis audit log sink.
195195

196196
Alias: `c`
197197

@@ -219,7 +219,7 @@ Alias: `re`
219219

220220
##### validate
221221

222-
The `tcld account audit-log kinesis validate` command validate kinesis audit log sink.
222+
`tcld account audit-log kinesis validate`: Validate kinesis audit log sink.
223223

224224
Alias: `v`
225225

@@ -247,7 +247,7 @@ Alias: `re`
247247

248248
##### update
249249

250-
The `tcld account audit-log kinesis update` command update a kinesis audit log sink.
250+
`tcld account audit-log kinesis update`: Update a kinesis audit log sink.
251251

252252
Alias: `u`
253253

@@ -285,7 +285,7 @@ Alias: `re`
285285

286286
##### get
287287

288-
The `tcld account audit-log kinesis get` command get audit log sink.
288+
`tcld account audit-log kinesis get`: Get audit log sink.
289289

290290
Alias: `g`
291291

@@ -295,7 +295,7 @@ Provide a name for the sink
295295

296296
##### delete
297297

298-
The `tcld account audit-log kinesis delete` command delete audit log sink.
298+
`tcld account audit-log kinesis delete`: Delete audit log sink.
299299

300300
Alias: `d`
301301

@@ -311,7 +311,7 @@ Alias: `v`
311311

312312
##### list
313313

314-
The `tcld account audit-log kinesis list` command list audit log sinks.
314+
`tcld account audit-log kinesis list`: List audit log sinks.
315315

316316
Alias: `l`
317317

@@ -325,7 +325,7 @@ The page token for list operations
325325

326326
#### pubsub
327327

328-
The `tcld account audit-log pubsub` command manage PubSub audit log sink.
328+
`tcld account audit-log pubsub`: Manage PubSub audit log sink.
329329

330330
Alias: `ps`
331331

@@ -338,7 +338,7 @@ Alias: `ps`
338338

339339
##### create
340340

341-
The `tcld account audit-log pubsub create` command create a pubsub audit log sink.
341+
`tcld account audit-log pubsub create`: Create a pubsub audit log sink.
342342

343343
Alias: `c`
344344

@@ -360,7 +360,7 @@ Alias: `tn`
360360

361361
##### validate
362362

363-
The `tcld account audit-log pubsub validate` command validate pubsub audit log sink.
363+
`tcld account audit-log pubsub validate`: Validate pubsub audit log sink.
364364

365365
Alias: `v`
366366

@@ -382,7 +382,7 @@ Alias: `tn`
382382

383383
##### update
384384

385-
The `tcld account audit-log pubsub update` command update a pubsub audit log sink.
385+
`tcld account audit-log pubsub update`: Update a pubsub audit log sink.
386386

387387
Alias: `u`
388388

@@ -414,7 +414,7 @@ Alias: `tn`
414414

415415
##### get
416416

417-
The `tcld account audit-log pubsub get` command get audit log sink.
417+
`tcld account audit-log pubsub get`: Get audit log sink.
418418

419419
Alias: `g`
420420

@@ -424,7 +424,7 @@ Provide a name for the sink
424424

425425
##### delete
426426

427-
The `tcld account audit-log pubsub delete` command delete audit log sink.
427+
`tcld account audit-log pubsub delete`: Delete audit log sink.
428428

429429
Alias: `d`
430430

@@ -440,7 +440,7 @@ Alias: `v`
440440

441441
##### list
442442

443-
The `tcld account audit-log pubsub list` command list audit log sinks.
443+
`tcld account audit-log pubsub list`: List audit log sinks.
444444

445445
Alias: `l`
446446

docs/cloud/tcld/apikey.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515

1616
{/* This is an auto-generated file. Do not edit directly. */}
1717

18-
The `tcld apikey` command aPIKey operations.
18+
`tcld apikey`: APIKey operations.
1919

2020
Alias: `ak`
2121

@@ -28,7 +28,7 @@ Alias: `ak`
2828

2929
### create
3030

31-
The `tcld apikey create` command create an apikey. Make sure to copy the secret or else you will not be able to retrieve it again.
31+
`tcld apikey create`: Create an apikey. Make sure to copy the secret or else you will not be able to retrieve it again.
3232

3333
Alias: `c`
3434

@@ -68,7 +68,7 @@ Alias: `r`
6868

6969
### get
7070

71-
The `tcld apikey get` command get an apikey.
71+
`tcld apikey get`: Get an apikey.
7272

7373
Alias: `g`
7474

@@ -80,7 +80,7 @@ Alias: `i`
8080

8181
### list
8282

83-
The `tcld apikey list` command list API keys.
83+
`tcld apikey list`: List API keys.
8484

8585
Alias: `l`
8686

@@ -98,7 +98,7 @@ Alias: `ot`
9898

9999
### delete
100100

101-
The `tcld apikey delete` command delete an apikey.
101+
`tcld apikey delete`: Delete an apikey.
102102

103103
Alias: `d`
104104

@@ -122,7 +122,7 @@ Alias: `r`
122122

123123
### disable
124124

125-
The `tcld apikey disable` command disable an apikey.
125+
`tcld apikey disable`: Disable an apikey.
126126

127127
Alias: `da`
128128

@@ -146,7 +146,7 @@ Alias: `r`
146146

147147
### enable
148148

149-
The `tcld apikey enable` command enable a disabled apikey.
149+
`tcld apikey enable`: Enable a disabled apikey.
150150

151151
Alias: `ea`
152152

docs/cloud/tcld/connectivity-rule.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515

1616
{/* This is an auto-generated file. Do not edit directly. */}
1717

18-
The `tcld connectivity-rule` command connectivity rule operations.
18+
`tcld connectivity-rule`: Connectivity rule operations.
1919

2020
Alias: `cr`
2121

@@ -26,7 +26,7 @@ Alias: `cr`
2626

2727
### create
2828

29-
The `tcld connectivity-rule create` command create a connectivity rule.
29+
`tcld connectivity-rule create`: Create a connectivity rule.
3030

3131
Alias: `c`
3232

@@ -56,7 +56,7 @@ Alias: `gpi`
5656

5757
### get
5858

59-
The `tcld connectivity-rule get` command get a connectivity rule.
59+
`tcld connectivity-rule get`: Get a connectivity rule.
6060

6161
Alias: `g`
6262

@@ -68,7 +68,7 @@ Alias: `id`
6868

6969
### list
7070

71-
The `tcld connectivity-rule list` command list connectivity rules.
71+
`tcld connectivity-rule list`: list connectivity rules.
7272

7373
Alias: `l`
7474

@@ -80,7 +80,7 @@ Alias: `n`
8080

8181
### delete
8282

83-
The `tcld connectivity-rule delete` command delete a connectivity rule.
83+
`tcld connectivity-rule delete`: Delete a connectivity rule.
8484

8585
Alias: `d`
8686

docs/cloud/tcld/feature.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ tags:
1515

1616
{/* This is an auto-generated file. Do not edit directly. */}
1717

18-
The `tcld feature` command feature commands.
18+
`tcld feature`: feature commands.
1919

2020
Alias: `f`
2121

2222
- [tcld feature get](#get)
2323

2424
### get
2525

26-
The `tcld feature get` command get all feature flags Value.
26+
`tcld feature get`: get all feature flags Value.
2727

2828
Alias: `g`
2929

docs/cloud/tcld/generate-certificates.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515

1616
{/* This is an auto-generated file. Do not edit directly. */}
1717

18-
The `tcld generate-certificates` command commands for generating certificate authority and end-entity TLS certificates.
18+
`tcld generate-certificates`: Commands for generating certificate authority and end-entity TLS certificates.
1919

2020
Alias: `gen`
2121

@@ -24,7 +24,7 @@ Alias: `gen`
2424

2525
### certificate-authority-certificate
2626

27-
The `tcld generate-certificates certificate-authority-certificate` command generate a certificate authority certificate.
27+
`tcld generate-certificates certificate-authority-certificate`: Generate a certificate authority certificate.
2828

2929
Alias: `ca`
3030

@@ -60,7 +60,7 @@ Alias: `rsa`
6060

6161
### end-entity-certificate
6262

63-
The `tcld generate-certificates end-entity-certificate` command generate an end-entity certificate.
63+
`tcld generate-certificates end-entity-certificate`: Generate an end-entity certificate.
6464

6565
Alias: `leaf`
6666

docs/cloud/tcld/login.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515

1616
{/* This is an auto-generated file. Do not edit directly. */}
1717

18-
The `tcld login` command login as user.
18+
`tcld login`: Login as user.
1919

2020
Alias: `l`
2121

docs/cloud/tcld/logout.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515

1616
{/* This is an auto-generated file. Do not edit directly. */}
1717

18-
The `tcld logout` command logout current user.
18+
`tcld logout`: Logout current user.
1919

2020
Alias: `lo`
2121

0 commit comments

Comments
 (0)