Skip to content

Commit 89adef8

Browse files
committed
Clean up hello_world README: remove redundant screenshots
Signed-off-by: Diana Zawadzki <[email protected]>
1 parent 5c39111 commit 89adef8

11 files changed

+79
-121
lines changed

new_samples/README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,43 +33,41 @@ cadence --env development \
3333
Try to inspect the log message for the output.
3434

3535
### Signal Workflow
36-
This workflow demonstrate a basic signal workflow. It takes your name as input parameter
37-
and greet you based on languages you pick. To start the workflow, try the following CLI.
36+
This workflow demonstrates a basic signal workflow. It waits for a signal to complete.
37+
To start the workflow, try the following CLI.
3838

3939
```bash
4040
cadence --env development \
4141
--domain cadence-samples \
4242
workflow start \
43-
--workflow_type cadence_samples.SignalGreeterMultiLanguageWorkflow \
43+
--workflow_type cadence_samples.SimpleSignalWorkflow \
4444
--tl cadence-samples-worker \
45-
--et 6000 \
46-
--input '{"name":"Uber"}'
45+
--et 600
4746
```
4847

49-
A workflow ID and run ID will be return in your terminal. Copy the workflow ID and replace
50-
to the CLI below to trigger the signal. Try to change the input language value and inspect what
51-
happens in the log. Also, try to inspect what happened after you interact with the signal multiple times.
48+
A workflow ID and run ID will be returned in your terminal. Copy the workflow ID and use
49+
the CLI below to send a signal. The workflow will continue running until it receives a
50+
`complete` signal with the value `true`.
5251

5352
```bash
5453
cadence --env development \
5554
--domain cadence-samples \
5655
workflow signal \
57-
--workflow_id <Your workflow ID> \
58-
--name "language" \
59-
--input '"english"'
56+
--wid <Your workflow ID> \
57+
--name "complete" \
58+
--input 'false'
6059
```
6160

62-
To cancel the workflow, try the following CLI.
61+
To complete the workflow, send the signal with `true`:
6362

6463
```bash
6564
cadence --env development \
6665
--domain cadence-samples \
6766
workflow signal \
68-
--workflow_id <Your workflow ID> \
69-
--name "cancel" \
67+
--wid <Your workflow ID> \
68+
--name "complete" \
7069
--input 'true'
7170
```
72-
The workflow should have a status of fail.
7371

7472
### Dynamic workflow
7573
This dynamic workflow is very similar to the Hello World workflow above, but instead of passing the

new_samples/hello_world/README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@ cadence --env development --domain cadence-samples domain register
1919

2020
Refresh the [domains page](http://localhost:8088/domains) from step 2 to verify `cadence-samples` is registered.
2121

22-
A fresh domain with no workflows looks like this:
23-
24-
![Fresh domain with no workflows](images/04-web-ui-fresh-domain-no-workflows.png)
25-
2622
## Steps to run sample
2723

2824
Inside the folder this sample is defined, run the following command:
@@ -78,15 +74,11 @@ Click on the workflow to see details:
7874

7975
* In Summary tab, you will see the input and output to your workflow
8076

81-
![Summary tab](images/05-web-ui-summary-tab.png)
82-
83-
* Click on History tab to see individual steps
84-
85-
![History tab showing workflow execution](images/09-web-ui-history-timeline-view.png)
77+
![Summary tab](images/04-web-ui-summary-tab.png)
8678

87-
Expand an activity to see its result:
79+
* Click on History tab to see individual steps. Expand an activity to see its result:
8880

89-
![History tab with activity result expanded](images/07-web-ui-history-activity-result.png)
81+
![History tab with activity result](images/05-web-ui-history-activity-result.png)
9082

9183
#### CLI
9284

@@ -123,7 +115,7 @@ cadence --env development \
123115

124116
If you see port conflicts when starting Docker, use `lsof` to find what's using the port:
125117

126-
![Docker port conflict troubleshooting](images/08-docker-port-conflict-troubleshooting.png)
118+
![Docker port conflict troubleshooting](images/06-docker-port-conflict-troubleshooting.png)
127119

128120
See the main [README](../../README.md#docker-troubleshooting) for detailed Docker troubleshooting steps.
129121

Binary file not shown.
-229 KB
Binary file not shown.
Binary file not shown.

new_samples/worker/worker.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ func StartWorker() {
4646
w.RegisterActivityWithOptions(workflows.HelloWorldActivity, activity.RegisterOptions{Name: "cadence_samples.HelloWorldActivity"})
4747

4848
// Signal workflow registration
49-
w.RegisterWorkflowWithOptions(workflows.SignalGreeterMultiLanguageWorkflow, workflow.RegisterOptions{Name: "cadence_samples.SignalGreeterMultiLanguageWorkflow"})
50-
w.RegisterActivityWithOptions(workflows.GenerateGreetingMessage, activity.RegisterOptions{Name: "cadence_samples.GenerateGreetingMessage"})
49+
w.RegisterWorkflowWithOptions(workflows.SimpleSignalWorkflow, workflow.RegisterOptions{Name: "cadence_samples.SimpleSignalWorkflow"})
50+
w.RegisterActivityWithOptions(workflows.SimpleSignalActivity, activity.RegisterOptions{Name: "cadence_samples.SimpleSignalActivity"})
5151

5252
// Dynamic workflow registration
5353
w.RegisterWorkflowWithOptions(workflows.DynamicWorkflow, workflow.RegisterOptions{Name: "cadence_samples.DynamicWorkflow"})

new_samples/workflows/signal_greeter_multi_language.go

Lines changed: 0 additions & 92 deletions
This file was deleted.

0 commit comments

Comments
 (0)