Skip to content

Commit 3cd7e07

Browse files
authored
Update authoring workflow page with Diagrid Dashboard (#4962)
* Add Diagrid dashboard Signed-off-by: Marc Duiker <[email protected]> * Add link validation ignore Signed-off-by: Marc Duiker <[email protected]> * update workflow dashboard image Signed-off-by: Marc Duiker <[email protected]> * Updated dashboard image location Signed-off-by: Marc Duiker <[email protected]> * Update link to Diagrid Dashboard Signed-off-by: Marc Duiker <[email protected]> * Update Diagrid Dashboard link Signed-off-by: Marc Duiker <[email protected]> * Update link to Diagrid Dashboard reference docs Signed-off-by: Marc Duiker <[email protected]> --------- Signed-off-by: Marc Duiker <[email protected]>
1 parent f1988f9 commit 3cd7e07

File tree

3 files changed

+35
-5
lines changed

3 files changed

+35
-5
lines changed

daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1125,9 +1125,31 @@ Because of how replay-based workflows execute, you'll write logic that does thin
11251125

11261126
{{% /alert %}}
11271127

1128-
## Testing your workflow
1128+
## Run the workflow & inspect the workflow execution with the Diagrid Dashboard
11291129

1130-
After authoring your workflow, test it using the Dapr CLI:
1130+
Start the workflow application via your IDE or the Dapr CLI ([Dapr multi-app run]({{% ref multi-app-overview.md %}}) if you want to start multiple applications, or regular [Dapr run command](#testing-the-workflow-via-the-dapr-cli) for one application, and schedule a new workflow instance.
1131+
1132+
Use the local [Diagrid Dashboard](https://diagrid.ws/diagrid-dashboard-docs) to visualize and inspect your workflow state, and drill down to see detailed workflow execution history. The dashboard runs as a container and is connected to the state store that is used by Dapr workflows (by default a local Redis instance).
1133+
1134+
<img src="/images/workflow-overview/workflow-diagrid-dashboard.png" width=800 alt="Diagrid Dashboard showing local workflow executions"/><br/>
1135+
1136+
Start the Diagrid Dashboard container using Docker:
1137+
1138+
```bash
1139+
docker run -p 8080:8080 ghcr.io/diagridio/diagrid-dashboard:latest
1140+
```
1141+
1142+
{{% alert title="Note" color="primary" %}}
1143+
If you're using another state store than the default Redis instance, you need to provide some additional arguments to run the container, see the [Diagrid Dashboard reference docs](https://diagrid.ws/diagrid-dashboard-docs).
1144+
{{% /alert %}}
1145+
1146+
<!-- IGNORE_LINKS -->
1147+
Open the dashboard in a browser at [http://localhost:8080](http://localhost:8080).
1148+
<!-- END_IGNORE -->
1149+
1150+
## Testing the workflow via the Dapr CLI
1151+
1152+
After authoring the workflow, you can test it using the Dapr CLI:
11311153

11321154
{{< tabpane text=true >}}
11331155

daprdocs/content/en/getting-started/install-dapr-selfhost.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,6 @@ explorer "%USERPROFILE%\.dapr"
170170

171171
{{< /tabpane >}}
172172

173-
<br>
174-
175173
### Slim init
176174

177175
To install the CLI without any default configuration files or Docker containers, use the `--slim` flag. [Learn more about the `init` command and its flags.]({{% ref dapr-init.md %}})
@@ -180,6 +178,16 @@ To install the CLI without any default configuration files or Docker containers,
180178
dapr init --slim
181179
```
182180

181+
### Other tooling (optional)
183182

184-
{{< button text="Next step: Use the Dapr API >>" page="getting-started/get-started-api.md" >}}
183+
#### Diagrid Dashboard for Dapr Workflow
184+
185+
If you're planning to build Dapr Workflow applications, you can install the [Diagrid Dashboard](https://diagrid.ws/diagrid-dashboard-docs) to visualize workflow state during local development:
186+
187+
Start the Diagrid Dashboard container using Docker:
185188

189+
```bash
190+
docker run -p 8080:8080 ghcr.io/diagridio/diagrid-dashboard:latest
191+
```
192+
193+
{{< button text="Next step: Use the Dapr API >>" page="getting-started/get-started-api.md" >}}
328 KB
Loading

0 commit comments

Comments
 (0)