diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md index bbafbf252f0..27da1a22be0 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/howto-author-workflow.md @@ -1125,9 +1125,31 @@ Because of how replay-based workflows execute, you'll write logic that does thin {{% /alert %}} -## Testing your workflow +## Run the workflow & inspect the workflow execution with the Diagrid Dashboard -After authoring your workflow, test it using the Dapr CLI: +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. + +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). + +Diagrid Dashboard showing local workflow executions
+ +Start the Diagrid Dashboard container using Docker: + +```bash +docker run -p 8080:8080 ghcr.io/diagridio/diagrid-dashboard:latest +``` + +{{% alert title="Note" color="primary" %}} +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). +{{% /alert %}} + + +Open the dashboard in a browser at [http://localhost:8080](http://localhost:8080). + + +## Testing the workflow via the Dapr CLI + +After authoring the workflow, you can test it using the Dapr CLI: {{< tabpane text=true >}} diff --git a/daprdocs/content/en/getting-started/install-dapr-selfhost.md b/daprdocs/content/en/getting-started/install-dapr-selfhost.md index 616c71f4d2e..0848f61caaa 100644 --- a/daprdocs/content/en/getting-started/install-dapr-selfhost.md +++ b/daprdocs/content/en/getting-started/install-dapr-selfhost.md @@ -170,8 +170,6 @@ explorer "%USERPROFILE%\.dapr" {{< /tabpane >}} -
- ### Slim init 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, dapr init --slim ``` +### Other tooling (optional) -{{< button text="Next step: Use the Dapr API >>" page="getting-started/get-started-api.md" >}} +#### Diagrid Dashboard for Dapr Workflow + +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: + +Start the Diagrid Dashboard container using Docker: +```bash +docker run -p 8080:8080 ghcr.io/diagridio/diagrid-dashboard:latest +``` + +{{< button text="Next step: Use the Dapr API >>" page="getting-started/get-started-api.md" >}} diff --git a/daprdocs/static/images/workflow-overview/workflow-diagrid-dashboard.png b/daprdocs/static/images/workflow-overview/workflow-diagrid-dashboard.png new file mode 100644 index 00000000000..2e5aa34a970 Binary files /dev/null and b/daprdocs/static/images/workflow-overview/workflow-diagrid-dashboard.png differ