docs: Improve generator documents (#133)

* Add more generator instructions

Signed-off-by: Ender Demirkaya <[email protected]>

* Fix some generated files for samples

Signed-off-by: Ender Demirkaya <[email protected]>

---------

Signed-off-by: Ender Demirkaya <[email protected]>

Author: demirkayaender

new_samples/hello_world/README.md

@@ -80,6 +80,9 @@ Click on the workflow to see details:
 
 ![History tab with activity result](images/05-web-ui-history-activity-result.png)
 
+* In Summary tab, you will see the input and output to your workflow
+* Click on History tab to see individual steps.
+
 #### CLI
 
 List workflows using the following command:
@@ -118,7 +121,6 @@ If you see port conflicts when starting Docker, use `lsof` to find what's using
 ![Docker port conflict troubleshooting](images/06-docker-port-conflict-troubleshooting.png)
 
 See the main [README](../../README.md#docker-troubleshooting) for detailed Docker troubleshooting steps.
-
 ## References
 
 * The website: https://cadenceworkflow.io

new_samples/hello_world/generator/README.md

@@ -21,3 +21,8 @@ In most cases, the workflow code (e.g. `workflow.go`) is the part that users car
 * When creating a new sample, follow the steps mentioned in the README file in the main samples folder.
 * To update the sample workflow code, edit the workflow file directly.
 * To update the worker, client, or other boilerplate logic, edit the generator file. If your change applies to all samples, update the common generator file inside the `template` folder. Edit the generator file in this folder only when the change should affect this sample alone.
+* When you are done run the following command in the generator folder
+
+```bash
+go run .
+```

new_samples/hello_world/generator/README_specific.md

@@ -12,6 +12,14 @@ cadence --env development \
   --input '{"message":"Cadence"}'
 ```
 
+You should see output like this:
+
+![Trigger command output](images/02-trigger-command-started-workflow.png)
+
+And the worker will log the completed workflow:
+
+![Worker output showing workflow completed](images/01-worker-output-workflow-completed.png)
+
 Here are the details to this command:
 
 * `--domain` option describes under which domain to run this workflow
@@ -29,6 +37,18 @@ To see more options run `cadence --help`
 
 Click on `cadence-samples` domain in cadence-web to view your workflow.
 
+![Workflow list showing completed workflow](images/03-web-ui-workflow-list-completed.png)
+
+Click on the workflow to see details:
+
+* In Summary tab, you will see the input and output to your workflow
+
+![Summary tab](images/04-web-ui-summary-tab.png)
+
+* Click on History tab to see individual steps. Expand an activity to see its result:
+
+![History tab with activity result](images/05-web-ui-history-activity-result.png)
+
 * In Summary tab, you will see the input and output to your workflow
 * Click on History tab to see individual steps.
 
@@ -62,3 +82,11 @@ cadence --env development \
   workflow show \
   --wid <workflow_id>
 ```
+
+## Troubleshooting
+
+If you see port conflicts when starting Docker, use `lsof` to find what's using the port:
+
+![Docker port conflict troubleshooting](images/06-docker-port-conflict-troubleshooting.png)
+
+See the main [README](../../README.md#docker-troubleshooting) for detailed Docker troubleshooting steps.

new_samples/signal/generator/README.md

@@ -21,3 +21,8 @@ In most cases, the workflow code (e.g. `workflow.go`) is the part that users car
 * When creating a new sample, follow the steps mentioned in the README file in the main samples folder.
 * To update the sample workflow code, edit the workflow file directly.
 * To update the worker, client, or other boilerplate logic, edit the generator file. If your change applies to all samples, update the common generator file inside the `template` folder. Edit the generator file in this folder only when the change should affect this sample alone.
+* When you are done run the following command in the generator folder
+
+```bash
+go run .
+```

new_samples/template/README_generator.tmpl

@@ -21,3 +21,8 @@ In most cases, the workflow code (e.g. `workflow.go`) is the part that users car
 * When creating a new sample, follow the steps mentioned in the README file in the main samples folder.
 * To update the sample workflow code, edit the workflow file directly.
 * To update the worker, client, or other boilerplate logic, edit the generator file. If your change applies to all samples, update the common generator file inside the `template` folder. Edit the generator file in this folder only when the change should affect this sample alone.
+* When you are done run the following command in the generator folder
+
+```bash
+go run .
+```