Skip to content

Commit 0db7f31

Browse files
CI: Automatic .md and .mdx formatting
1 parent 2c5f079 commit 0db7f31

File tree

10 files changed

+275
-272
lines changed

10 files changed

+275
-272
lines changed

docs/cli/activity.mdx

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,28 @@
1-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3-
---
1+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2+
43
id: activity
54
title: Temporal CLI activity command reference
65
sidebar_label: activity
76
description: Learn how to use Temporal Activity commands for completing or failing Activity Executions in your Workflow. Optimize your Temporal Workflow management effectively.
87
toc_max_heading_level: 4
98
keywords:
10-
- activity
11-
- activity complete
12-
- activity update-options
13-
- activity pause
14-
- activity unpause
15-
- activity reset
16-
- activity execution
17-
- activity fail
18-
- cli reference
19-
- cli-feature
20-
- command-line-interface-cli
21-
- temporal cli
22-
tags:
23-
- Activities
24-
- Temporal CLI
9+
10+
- activity
11+
- activity complete
12+
- activity update-options
13+
- activity pause
14+
- activity unpause
15+
- activity reset
16+
- activity execution
17+
- activity fail
18+
- cli reference
19+
- cli-feature
20+
- command-line-interface-cli
21+
- temporal cli
22+
tags:
23+
- Activities
24+
- Temporal CLI
25+
2526
---
2627

2728
## complete
@@ -374,7 +375,7 @@ Pause an Activity.
374375
If the Activity is not currently running (e.g. because it previously
375376
failed), it will not be run again until it is unpaused.
376377

377-
However, if the Activity is currently running, it will run until the next
378+
However, if the Activity is currently running, it will run until the next
378379
time it fails, completes, or times out, at which point the pause will kick in.
379380

380381
If the Activity is on its last retry attempt and fails, the failure will
@@ -390,7 +391,7 @@ temporal activity pause \
390391
--workflow-id YourWorkflowId
391392
```
392393

393-
To later unpause the activity, see [unpause](#unpause). You may also want to
394+
To later unpause the activity, see [unpause](#unpause). You may also want to
394395
[reset](#reset) the activity to unpause it while also starting it from the beginning.
395396

396397
Use the following options to change the behavior of this command.
@@ -553,31 +554,31 @@ Override target TLS server name.
553554

554555
## reset
555556

556-
Reset an activity. This restarts the activity as if it were first being
557-
scheduled. That is, it will reset both the number of attempts and the
558-
activity timeout, as well as, optionally, the
557+
Reset an activity. This restarts the activity as if it were first being
558+
scheduled. That is, it will reset both the number of attempts and the
559+
activity timeout, as well as, optionally, the
559560
[heartbeat details](#reset-heartbeats).
560561

561-
If the activity may be executing (i.e. it has not yet timed out), the
562+
If the activity may be executing (i.e. it has not yet timed out), the
562563
reset will take effect the next time it fails, heartbeats, or times out.
563-
If is waiting for a retry (i.e. has failed or timed out), the reset
564+
If is waiting for a retry (i.e. has failed or timed out), the reset
564565
will apply immediately.
565566

566-
If the activity is already paused, it will be unpaused by default.
567+
If the activity is already paused, it will be unpaused by default.
567568
You can specify `keep_paused` to prevent this.
568569

569-
If the activity is paused and the `keep_paused` flag is not provided,
570-
it will be unpaused. If the activity is paused and `keep_paused` flag
570+
If the activity is paused and the `keep_paused` flag is not provided,
571+
it will be unpaused. If the activity is paused and `keep_paused` flag
571572
is provided - it will stay paused.
572573

573574
Activities can be specified by their Activity ID or Activity Type.
574575

575576
### Resetting activities that heartbeat {#reset-heartbeats}
576577

577-
Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure)
578+
Activities that heartbeat will receive a [Canceled failure](/references/failures#cancelled-failure)
578579
the next time they heartbeat after a reset.
579580

580-
If, in your Activity, you need to do any cleanup when an Activity is
581+
If, in your Activity, you need to do any cleanup when an Activity is
581582
reset, handle this error and then re-throw it when you've cleaned up.
582583

583584
If the `reset_heartbeats` flag is set, the heartbeat details will also be cleared.
@@ -786,8 +787,8 @@ temporal activity unpause \
786787
--reset-heartbeats
787788
```
788789

789-
Activities can be unpaused in bulk via a visibility Query list filter.
790-
For example, if you want to unpause activities of type Foo that you
790+
Activities can be unpaused in bulk via a visibility Query list filter.
791+
For example, if you want to unpause activities of type Foo that you
791792
previously paused, do:
792793

793794
```
@@ -996,8 +997,8 @@ Override target TLS server name.
996997
## update-options
997998

998999
Update the options of a running Activity that were passed into it from
999-
a Workflow. Updates are incremental, only changing the specified
1000-
options.
1000+
a Workflow. Updates are incremental, only changing the specified
1001+
options.
10011002

10021003
For example:
10031004

@@ -1207,4 +1208,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
12071208
**--tls-server-name** _string_
12081209

12091210
Override target TLS server name.
1210-

docs/cli/batch.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
1-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3-
---
1+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2+
43
id: batch
54
title: Temporal CLI batch command reference
65
sidebar_label: batch
76
description: Use Temporal CLI to manage multiple Workflow Executions with Batch Jobs that can Cancel, Signal, or Terminate Workflows. Filter and monitor Batch Jobs effectively.
87
toc_max_heading_level: 4
98
keywords:
10-
- batch
11-
- batch describe
12-
- batch list
13-
- batch terminate
14-
- cli reference
15-
- cli-feature
16-
- command-line-interface-cli
17-
- temporal cli
18-
tags:
19-
- Temporal CLI
9+
10+
- batch
11+
- batch describe
12+
- batch list
13+
- batch terminate
14+
- cli reference
15+
- cli-feature
16+
- command-line-interface-cli
17+
- temporal cli
18+
tags:
19+
- Temporal CLI
20+
2021
---
2122

2223
## describe
@@ -504,4 +505,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
504505
**--tls-server-name** _string_
505506

506507
Override target TLS server name.
507-

docs/cli/config.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3-
---
1+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2+
43
id: config
54
title: Temporal CLI config command reference
65
sidebar_label: config
76
description: Temporal CLI 'config' commands allow the getting, setting, deleting, and listing of configuration properties for connecting to Temporal.
87
toc_max_heading_level: 4
98
keywords:
10-
- cli reference
11-
- command-line-interface-cli
12-
- configuration
13-
- config
14-
- config delete
15-
- config get
16-
- config list
17-
- config set
18-
- environment
19-
- temporal cli
20-
tags:
21-
- Temporal CLI
9+
10+
- cli reference
11+
- command-line-interface-cli
12+
- configuration
13+
- config
14+
- config delete
15+
- config get
16+
- config list
17+
- config set
18+
- environment
19+
- temporal cli
20+
tags:
21+
- Temporal CLI
22+
2223
---
2324

2425
## delete
@@ -813,4 +814,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
813814
**--tls-server-name** _string_
814815

815816
Override target TLS server name.
816-

docs/cli/env.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3-
---
1+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2+
43
id: env
54
title: Temporal CLI env command reference
65
sidebar_label: env
76
description: Temporal CLI 'env' commands allow the configuration, setting, deleting, and listing of environmental properties, making it easy to manage Temporal Server instances.
87
toc_max_heading_level: 4
98
keywords:
10-
- cli reference
11-
- command-line-interface-cli
12-
- configuration
13-
- env
14-
- env delete
15-
- env get
16-
- env list
17-
- env set
18-
- environment
19-
- temporal cli
20-
tags:
21-
- Temporal CLI
9+
10+
- cli reference
11+
- command-line-interface-cli
12+
- configuration
13+
- env
14+
- env delete
15+
- env get
16+
- env list
17+
- env set
18+
- environment
19+
- temporal cli
20+
tags:
21+
- Temporal CLI
22+
2223
---
2324

2425
## delete
@@ -682,4 +683,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
682683
**--tls-server-name** _string_
683684

684685
Override target TLS server name.
685-

docs/cli/operator.mdx

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,43 @@
1-
{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.
2-
This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
3-
---
1+
## {/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}
2+
43
id: operator
54
title: Temporal CLI operator command reference
65
sidebar_label: operator
76
description: Operator commands in Temporal allow actions on Namespaces, Search Attributes, Clusters and Nexus Endpoints using specific subcommands. Execute with "temporal operator [command] [subcommand] [options]".
87
toc_max_heading_level: 4
98
keywords:
10-
- cli reference
11-
- cluster
12-
- cluster health
13-
- cluster list
14-
- cluster remove
15-
- cluster upsert
16-
- command-line-interface-cli
17-
- describe
18-
- namespace
19-
- namespace create
20-
- namespace delete
21-
- namespace describe
22-
- namespace list
23-
- nexus
24-
- nexus endpoint
25-
- nexus endpoint create
26-
- nexus endpoint delete
27-
- nexus endpoint get
28-
- nexus endpoint list
29-
- nexus endpoint update
30-
- operator
31-
- search attribute
32-
- search attribute create
33-
- search attribute list
34-
- search attribute remove
35-
- system
36-
- temporal cli
37-
- update
38-
tags:
39-
- Temporal CLI
9+
10+
- cli reference
11+
- cluster
12+
- cluster health
13+
- cluster list
14+
- cluster remove
15+
- cluster upsert
16+
- command-line-interface-cli
17+
- describe
18+
- namespace
19+
- namespace create
20+
- namespace delete
21+
- namespace describe
22+
- namespace list
23+
- nexus
24+
- nexus endpoint
25+
- nexus endpoint create
26+
- nexus endpoint delete
27+
- nexus endpoint get
28+
- nexus endpoint list
29+
- nexus endpoint update
30+
- operator
31+
- search attribute
32+
- search attribute create
33+
- search attribute list
34+
- search attribute remove
35+
- system
36+
- temporal cli
37+
- update
38+
tags:
39+
- Temporal CLI
40+
4041
---
4142

4243
## cluster
@@ -1034,7 +1035,7 @@ Create a new Namespace on the Temporal Service:
10341035
temporal operator namespace create \
10351036
--namespace YourNewNamespaceName \
10361037
[options]
1037-
````
1038+
```
10381039

10391040
Create a Namespace with multi-region data replication:
10401041

@@ -3351,4 +3352,3 @@ Path to x509 private key. Can't be used with --tls-key-data.
33513352
**--tls-server-name** _string_
33523353

33533354
Override target TLS server name.
3354-

0 commit comments

Comments
 (0)