diff --git a/daprdocs/content/en/contributing/contributing-overview.md b/daprdocs/content/en/contributing/contributing-overview.md index 4e84c5071..b78669994 100644 --- a/daprdocs/content/en/contributing/contributing-overview.md +++ b/daprdocs/content/en/contributing/contributing-overview.md @@ -18,7 +18,7 @@ See the [Dapr community repository](https://github.com/dapr/community) for more 1. **Docs**: This [repository](https://github.com/dapr/docs) contains the documentation for Dapr. You can contribute by updating existing documentation, fixing errors, or adding new content to improve user experience and clarity. Please see the specific guidelines for [docs contributions]({{< ref contributing-docs >}}). -2. **Quickstarts**: The Quickstarts [repository](https://github.com/dapr/quickstarts) provides simple, step-by-step guides to help users get started with Dapr quickly. Contributions in this repository involve creating new quickstarts, improving existing ones, or ensuring they stay up-to-date with the latest features. +2. **Quickstarts**: The Quickstarts [repository](https://github.com/dapr/quickstarts) provides simple, step-by-step guides to help users get started with Dapr quickly. [Contributions in this repository](https://github.com/dapr/quickstarts/blob/master/CONTRIBUTING.md) involve creating new quickstarts, improving existing ones, or ensuring they stay up-to-date with the latest features. 3. **Runtime**: The Dapr runtime [repository](https://github.com/dapr/dapr) houses the core runtime components. Here, you can contribute by fixing bugs, optimizing performance, implementing new features, or enhancing existing ones. diff --git a/daprdocs/content/en/contributing/daprbot.md b/daprdocs/content/en/contributing/daprbot.md index 2e35fd491..b4b53d0bf 100644 --- a/daprdocs/content/en/contributing/daprbot.md +++ b/daprdocs/content/en/contributing/daprbot.md @@ -2,7 +2,7 @@ type: docs title: "Dapr bot reference" linkTitle: "Dapr bot" -weight: 15 +weight: 70 description: "List of Dapr bot capabilities." --- diff --git a/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md b/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md index 2ed1f81bd..a76b02344 100644 --- a/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md +++ b/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md @@ -41,15 +41,18 @@ Style and tone conventions should be followed throughout all Dapr documentation ## Diagrams and images -Diagrams and images are invaluable visual aids for documentation pages. Diagrams are kept in a [Dapr Diagrams Deck](https://github.com/dapr/docs/tree/v1.11/daprdocs/static/presentations), which includes guidance on style and icons. +Diagrams and images are invaluable visual aids for documentation pages. Use the diagram style and icons in the [Dapr Diagrams template deck](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/presentations). -As you create diagrams for your documentation: +The process for creating diagrams for your documentation: -- Save them as high-res PNG files into the [images folder](https://github.com/dapr/docs/tree/v1.11/daprdocs/static/images). -- Name your PNG files using the convention of a concept or building block so that they are grouped. +1. Download the [Dapr Diagrams template deck](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/presentations) to use the icons and colors. +1. Add a new slide and create your diagram. +1. Screen capture the diagram as high-res PNG file and save in the [images folder](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/images). +1. Name your PNG files using the convention of a concept or building block so that they are grouped. - For example: `service-invocation-overview.png`. - For more information on calling out images using shortcode, see the [Images guidance](#images) section below. -- Add the diagram to the correct section in the `Dapr-Diagrams.pptx` deck so that they can be amended and updated during routine refresh. +1. Add the diagram to the appropriate section in your documentation using the HTML `` tag. +1. In your PR, comment the diagram slide (not the screen capture) so it can be reviewed and added to the diagram deck by maintainers. ## Contributing a new docs page diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/subscription-methods.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/subscription-methods.md index 436c16295..62ed2811e 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/pubsub/subscription-methods.md +++ b/daprdocs/content/en/developing-applications/building-blocks/pubsub/subscription-methods.md @@ -37,17 +37,16 @@ metadata: spec: topic: orders routes: - default: /checkout + default: /orders pubsubname: pubsub scopes: - orderprocessing -- checkout ``` Here the subscription called `order`: - Uses the pub/sub component called `pubsub` to subscribes to the topic called `orders`. -- Sets the `route` field to send all topic messages to the `/checkout` endpoint in the app. -- Sets `scopes` field to scope this subscription for access only by apps with IDs `orderprocessing` and `checkout`. +- Sets the `route` field to send all topic messages to the `/orders` endpoint in the app. +- Sets `scopes` field to scope this subscription for access only by apps with ID `orderprocessing`. When running Dapr, set the YAML component file path to point Dapr to the component. @@ -113,7 +112,7 @@ In your application code, subscribe to the topic specified in the Dapr pub/sub c ```csharp //Subscribe to a topic -[HttpPost("checkout")] +[HttpPost("orders")] public void getCheckout([FromBody] int orderId) { Console.WriteLine("Subscriber received : " + orderId); @@ -128,7 +127,7 @@ public void getCheckout([FromBody] int orderId) import io.dapr.client.domain.CloudEvent; //Subscribe to a topic -@PostMapping(path = "/checkout") +@PostMapping(path = "/orders") public Mono getCheckout(@RequestBody(required = false) CloudEvent cloudEvent) { return Mono.fromRunnable(() -> { try { @@ -146,7 +145,7 @@ public Mono getCheckout(@RequestBody(required = false) CloudEvent from cloudevents.sdk.event import v1 #Subscribe to a topic -@app.route('/checkout', methods=['POST']) +@app.route('/orders', methods=['POST']) def checkout(event: v1.Event) -> None: data = json.loads(event.Data()) logging.info('Subscriber received: ' + str(data)) @@ -163,7 +162,7 @@ const app = express() app.use(bodyParser.json({ type: 'application/*+json' })); // listen to the declarative route -app.post('/checkout', (req, res) => { +app.post('/orders', (req, res) => { console.log(req.body); res.sendStatus(200); }); @@ -178,7 +177,7 @@ app.post('/checkout', (req, res) => { var sub = &common.Subscription{ PubsubName: "pubsub", Topic: "orders", - Route: "/checkout", + Route: "/orders", } func eventHandler(ctx context.Context, e *common.TopicEvent) (retry bool, err error) { @@ -191,7 +190,7 @@ func eventHandler(ctx context.Context, e *common.TopicEvent) (retry bool, err er {{< /tabs >}} -The `/checkout` endpoint matches the `route` defined in the subscriptions and this is where Dapr sends all topic messages to. +The `/orders` endpoint matches the `route` defined in the subscriptions and this is where Dapr sends all topic messages to. ### Streaming subscriptions @@ -325,7 +324,7 @@ In the example below, you define the values found in the [declarative YAML subsc ```csharp [Topic("pubsub", "orders")] -[HttpPost("/checkout")] +[HttpPost("/orders")] public async Task>Checkout(Order order, [FromServices] DaprClient daprClient) { // Logic @@ -337,7 +336,7 @@ or ```csharp // Dapr subscription in [Topic] routes orders topic to this route -app.MapPost("/checkout", [Topic("pubsub", "orders")] (Order order) => { +app.MapPost("/orders", [Topic("pubsub", "orders")] (Order order) => { Console.WriteLine("Subscriber received : " + order); return Results.Ok(order); }); @@ -359,7 +358,7 @@ app.UseEndpoints(endpoints => ```java private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(); -@Topic(name = "checkout", pubsubName = "pubsub") +@Topic(name = "orders", pubsubName = "pubsub") @PostMapping(path = "/orders") public Mono handleMessage(@RequestBody(required = false) CloudEvent cloudEvent) { return Mono.fromRunnable(() -> { @@ -370,6 +369,7 @@ public Mono handleMessage(@RequestBody(required = false) CloudEvent { res.json([ { pubsubname: "pubsub", - topic: "checkout", + topic: "orders", routes: { rules: [ { @@ -480,7 +480,7 @@ func configureSubscribeHandler(w http.ResponseWriter, _ *http.Request) { t := []subscription{ { PubsubName: "pubsub", - Topic: "checkout", + Topic: "orders", Routes: routes{ Rules: []rule{ { diff --git a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md index efdac157c..b0392fa78 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md +++ b/daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md @@ -135,7 +135,7 @@ Because workflow retry policies are configured in code, the exact developer expe | --- | --- | | **Maximum number of attempts** | The maximum number of times to execute the activity or child workflow. | | **First retry interval** | The amount of time to wait before the first retry. | -| **Backoff coefficient** | The amount of time to wait before each subsequent retry. | +| **Backoff coefficient** | The coefficient used to determine the rate of increase of back-off. For example a coefficient of 2 doubles the wait of each subsequent retry. | | **Maximum retry interval** | The maximum amount of time to wait before each subsequent retry. | | **Retry timeout** | The overall timeout for retries, regardless of any configured max number of attempts. | diff --git a/daprdocs/content/en/getting-started/quickstarts/workflow-quickstart.md b/daprdocs/content/en/getting-started/quickstarts/workflow-quickstart.md index da1ec1590..0c2c92b36 100644 --- a/daprdocs/content/en/getting-started/quickstarts/workflow-quickstart.md +++ b/daprdocs/content/en/getting-started/quickstarts/workflow-quickstart.md @@ -10,6 +10,10 @@ description: Get started with the Dapr Workflow building block Dapr Workflow is currently in beta. [See known limitations for {{% dapr-latest-version cli="true" %}}]({{< ref "workflow-overview.md#limitations" >}}). {{% /alert %}} +{{% alert title="Note" color="primary" %}} +Redis is currently used as the state store component for Workflows in the Quickstarts. However, Redis does not support transaction rollbacks and should not be used in production as an actor state store. +{{% /alert %}} + Let's take a look at the Dapr [Workflow building block]({{< ref workflow-overview.md >}}). In this Quickstart, you'll create a simple console application to demonstrate Dapr's workflow programming model and the workflow management APIs. In this guide, you'll: @@ -1356,4 +1360,4 @@ Join the discussion in our [discord channel](https://discord.com/channels/778680 - Walk through a more in-depth [.NET SDK example workflow](https://github.com/dapr/dotnet-sdk/tree/master/examples/Workflow) - Learn more about [Workflow as a Dapr building block]({{< ref workflow-overview >}}) -{{< button text="Explore Dapr tutorials >>" page="getting-started/tutorials/_index.md" >}} \ No newline at end of file +{{< button text="Explore Dapr tutorials >>" page="getting-started/tutorials/_index.md" >}} diff --git a/daprdocs/static/presentations/Dapr-Diagrams-template.pptx.zip b/daprdocs/static/presentations/Dapr-Diagrams-template.pptx.zip new file mode 100644 index 000000000..3a871010f Binary files /dev/null and b/daprdocs/static/presentations/Dapr-Diagrams-template.pptx.zip differ diff --git a/daprdocs/static/presentations/Dapr-Diagrams.pptx.zip b/daprdocs/static/presentations/Dapr-Diagrams.pptx.zip deleted file mode 100644 index 206d01600..000000000 Binary files a/daprdocs/static/presentations/Dapr-Diagrams.pptx.zip and /dev/null differ diff --git a/sdkdocs/dotnet b/sdkdocs/dotnet index b8e276728..03038fa51 160000 --- a/sdkdocs/dotnet +++ b/sdkdocs/dotnet @@ -1 +1 @@ -Subproject commit b8e276728935c66b0a335b5aa2ca4102c560dd3d +Subproject commit 03038fa519670b583eabcef1417eacd55c3e44c8 diff --git a/sdkdocs/go b/sdkdocs/go index 7c03c7ce5..dd9a2d5a3 160000 --- a/sdkdocs/go +++ b/sdkdocs/go @@ -1 +1 @@ -Subproject commit 7c03c7ce58d100a559ac1881bc0c80d6dedc5ab9 +Subproject commit dd9a2d5a3c4481b8a6bda032df8f44f5eaedb370 diff --git a/sdkdocs/java b/sdkdocs/java index a98327e7d..0b7a051b7 160000 --- a/sdkdocs/java +++ b/sdkdocs/java @@ -1 +1 @@ -Subproject commit a98327e7d9a81611b0d7e91e59ea23ad48271948 +Subproject commit 0b7a051b79c7a394e9bd4f57bd40778fb5f29897 diff --git a/sdkdocs/js b/sdkdocs/js index 7350742b6..76866c878 160000 --- a/sdkdocs/js +++ b/sdkdocs/js @@ -1 +1 @@ -Subproject commit 7350742b6869cc166633d1f4d17d76fbdbb12921 +Subproject commit 76866c878a6e79bb889c83f3930172ddb20f1624 diff --git a/sdkdocs/python b/sdkdocs/python index 64a4f2f66..6e90e84b1 160000 --- a/sdkdocs/python +++ b/sdkdocs/python @@ -1 +1 @@ -Subproject commit 64a4f2f6658e9023e8ea080eefdb019645cae802 +Subproject commit 6e90e84b166ac7ea603b78894e9e1b92dc456014