From 16beee2a3302b4adc3076defb6cd84076b164aea Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Mon, 31 Jul 2023 17:21:40 -0400 Subject: [PATCH] mark review Signed-off-by: Hannah Hunter --- .../building-blocks/bindings/bindings-overview.md | 4 ++-- .../building-blocks/bindings/howto-bindings.md | 4 ++-- .../building-blocks/bindings/howto-triggers.md | 4 ++-- daprdocs/content/en/reference/api/bindings_api.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md b/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md index c8d795ff6e9..1b691732e35 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md @@ -59,14 +59,14 @@ Read the [Use output bindings to interface with external resources guide]({{< re ## Binding directions (optional) -You can provide information via the `direction` metadata field to indicate the direction supported by the binding component. With one of the following metadata values, the Dapr sidecar avoids the `"wait for the app to become ready"` state: +You can provide the `direction` metadata field to indicate the direction(s) supported by the binding component. In doing so, the Dapr sidecar avoids the `"wait for the app to become ready"` state reducing the lifecycle dependency between the Dapr sidecar and the application: - `"input"` - `"output"` - `"input, output"` {{% alert title="Note" color="primary" %}} -All bindings should include the `direction` property. +It is highly recommended that all bindings should include the `direction` property. {{% /alert %}} [See a full example of the bindings `direction` metadata.]({{< ref "bindings_api.md#binding-direction-optional" >}}) diff --git a/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md b/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md index 9d98c0faeb7..1822f543a6d 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md +++ b/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md @@ -61,7 +61,7 @@ spec: - name: publishTopic value: sample - name: authRequired - value: "false" + value: false - name: direction value: output ``` @@ -93,7 +93,7 @@ spec: - name: publishTopic value: sample - name: authRequired - value: "false" + value: false - name: direction value: output ``` diff --git a/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-triggers.md b/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-triggers.md index d922878549f..56a24b0aece 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-triggers.md +++ b/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-triggers.md @@ -66,7 +66,7 @@ spec: - name: publishTopic value: sample - name: authRequired - value: "false" + value: false - name: direction value: input ``` @@ -98,7 +98,7 @@ spec: - name: publishTopic value: sample - name: authRequired - value: "false" + value: false - name: direction value: input ``` diff --git a/daprdocs/content/en/reference/api/bindings_api.md b/daprdocs/content/en/reference/api/bindings_api.md index 660798f0080..1dbe37b7ee0 100644 --- a/daprdocs/content/en/reference/api/bindings_api.md +++ b/daprdocs/content/en/reference/api/bindings_api.md @@ -41,7 +41,7 @@ If running on kubernetes apply the component to your cluster. In some scenarios, it would be useful to provide additional information to Dapr to indicate the direction supported by the binding component. -Providing the supported binding direction helps the Dapr sidecar avoid the `"wait for the app to become ready"` state, where it waits indefinitely for the application to become available. +Providing the binding `direction` helps the Dapr sidecar avoid the `"wait for the app to become ready"` state, where it waits indefinitely for the application to become available. This decouples the lifecycle dependency between the Dapr sidecar and the application. You can specify the `direction` field as part of the component's metadata. The valid values for this field are: - `"input"` @@ -49,7 +49,7 @@ You can specify the `direction` field as part of the component's metadata. The v - `"input, output"` {{% alert title="Note" color="primary" %}} -All bindings should include the `direction` property. +It is highly recommended that all bindings should include the `direction` property. {{% /alert %}} Here a few scenarios when the `"direction"` metadata field could help: