Skip to content

Commit 2f353cb

Browse files
committed
Add visual walkthrough screenshots to hello_world README
1 parent 63e96d4 commit 2f353cb

10 files changed

+34
-1
lines changed

new_samples/hello_world/README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ 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+
2226
## Steps to run sample
2327

2428
Inside the folder this sample is defined, run the following command:
@@ -43,6 +47,14 @@ cadence --env development \
4347
--input '{"message":"Cadence"}'
4448
```
4549

50+
You should see output like this:
51+
52+
![Trigger command output](images/02-trigger-command-started-workflow.png)
53+
54+
And the worker will log the completed workflow:
55+
56+
![Worker output showing workflow completed](images/01-worker-output-workflow-completed.png)
57+
4658
Here are the details to this command:
4759

4860
* `--domain` option describes under which domain to run this workflow
@@ -60,8 +72,21 @@ To see more options run `cadence --help`
6072

6173
Click on `cadence-samples` domain in cadence-web to view your workflow.
6274

75+
![Workflow list showing completed workflow](images/03-web-ui-workflow-list-completed.png)
76+
77+
Click on the workflow to see details:
78+
6379
* In Summary tab, you will see the input and output to your workflow
64-
* Click on History tab to see individual steps.
80+
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)
86+
87+
Expand an activity to see its result:
88+
89+
![History tab with activity result expanded](images/07-web-ui-history-activity-result.png)
6590

6691
#### CLI
6792

@@ -94,6 +119,14 @@ cadence --env development \
94119
--wid <workflow_id>
95120
```
96121

122+
## Troubleshooting
123+
124+
If you see port conflicts when starting Docker, use `lsof` to find what's using the port:
125+
126+
![Docker port conflict troubleshooting](images/08-docker-port-conflict-troubleshooting.png)
127+
128+
See the main [README](../../README.md#docker-troubleshooting) for detailed Docker troubleshooting steps.
129+
97130
## References
98131

99132
* The website: https://cadenceworkflow.io
92.7 KB
Loading
53.7 KB
Loading
174 KB
Loading
198 KB
Loading
222 KB
Loading
229 KB
Loading
322 KB
Loading
265 KB
Loading
307 KB
Loading

0 commit comments

Comments
 (0)