Merge branch 'v1.12' into bindings-dir

dapr · Oct 12, 2023 · 43937c4 · 43937c4
2 parents 84e9dc1 + b114768
commit 43937c4
Show file tree

Hide file tree

Showing 27 changed files with 354 additions and 278 deletions.
diff --git a/.github/holopin.yml b/.github/holopin.yml
@@ -0,0 +1,6 @@
+organization: dapr
+defaultSticker: clmjkxscc122740fl0mkmb7egi
+stickers:
+  -
+    id: clmjkxscc122740fl0mkmb7egi
+    alias: ghc2023
diff --git a/.github/workflows/website-root.yml b/.github/workflows/website-root.yml
@@ -4,11 +4,11 @@ on:
   workflow_dispatch:
   push:
     branches:
-      - v1.11
+      - v1.12
   pull_request:
     types: [opened, synchronize, reopened, closed]
     branches:
-      - v1.11
+      - v1.12
 
 concurrency:
   # Cancel the previously triggered build for only PR build.

diff --git a/README.md b/README.md
@@ -14,8 +14,8 @@ The following branches are currently maintained:
 
 | Branch                                                       | Website                    | Description                                                                                      |
 | ------------------------------------------------------------ | -------------------------- | ------------------------------------------------------------------------------------------------ |
-| [v1.11](https://github.com/dapr/docs) (primary)               | https://docs.dapr.io       | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
-| [v1.12](https://github.com/dapr/docs/tree/v1.12) (pre-release) | https://v1-12.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.12+ go here.                |
+| [v1.12](https://github.com/dapr/docs) (primary)               | https://docs.dapr.io       | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. |
+| [v1.13](https://github.com/dapr/docs/tree/v1.13) (pre-release) | https://v1-13.docs.dapr.io/ | Pre-release documentation. Doc updates that are only applicable to v1.13+ go here.                |
 
 For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/docs-contrib/contributing-docs/#branch-guidance) document.
 

diff --git a/daprdocs/config.toml b/daprdocs/config.toml
@@ -1,5 +1,5 @@
 # Site Configuration
-baseURL = "https://v1-12.docs.dapr.io"
+baseURL = "https://docs.dapr.io"
 title = "Dapr Docs"
 theme = "docsy"
 disableFastRender = true
@@ -168,20 +168,23 @@ offlineSearch = false
 github_repo = "https://github.com/dapr/docs"
 github_project_repo = "https://github.com/dapr/dapr"
 github_subdir = "daprdocs"
-github_branch = "v1.11"
+github_branch = "v1.12"
 
 # Versioning
-version_menu = "v1.11 (latest)"
-version = "v1.11"
+version_menu = "v1.12 (latest)"
+version = "v1.12"
 archived_version = false
 url_latest_version = "https://docs.dapr.io"
 
 [[params.versions]]
-  version = "v1.12 (preview)"
-  url = "#"
+  version = "v1.13 (preview)"
+  url = "https://v1-13.docs.dapr.io"
 [[params.versions]]
-  version = "v1.11 (latest)"
+  version = "v1.12 (latest)"
   url = "https://docs.dapr.io"
+[[params.versions]]
+  version = "v1.11"
+  url = "https://v1-11.docs.dapr.io"
 [[params.versions]]
   version = "v1.10"
   url = "https://v1-10.docs.dapr.io"

diff --git a/...nt/en/developing-applications/building-blocks/actors/actors-timers-reminders.md b/...nt/en/developing-applications/building-blocks/actors/actors-timers-reminders.md
@@ -137,7 +137,7 @@ Refer [api spec]({{< ref "actors_api.md#invoke-reminder" >}}) for more details.
 
 ## Error handling
 
-When an actor's method completes successfully, the runtime will contineu to invoke the method at the specified timer or reminder schedule. However, if the method throws an exception, the runtime catches it and logs the error message in the Dapr sidecar logs, without retrying. 
+When an actor's method completes successfully, the runtime will continue to invoke the method at the specified timer or reminder schedule. However, if the method throws an exception, the runtime catches it and logs the error message in the Dapr sidecar logs, without retrying. 
 
 To allow actors to recover from failures and retry after a crash or restart, you can persist an actor's state by configuring a state store, like Redis or Azure Cosmos DB. 
 

diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-bulk.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-bulk.md
@@ -81,13 +81,13 @@ async function start() {
     {
       entryID: "entry-2",
       contentType: "application/cloudevents+json",
-      event: { 
+      event: {
         specversion: "1.0",
         source: "/some/source",
         type: "example",
-        id: "1234", 
-        data: "foo message 2", 
-        datacontenttype: "text/plain" 
+        id: "1234",
+        data: "foo message 2",
+        datacontenttype: "text/plain"
       },
     },
     {
@@ -115,7 +115,7 @@ using System.Collections.Generic;
 using Dapr.Client;
 
 const string PubsubName = "my-pubsub-name";
-const string TopicName = "topic-a";        
+const string TopicName = "topic-a";
 IReadOnlyList<object> BulkPublishData = new List<object>() {
     new { Id = "17", Amount = 10m },
     new { Id = "18", Amount = 20m },
@@ -130,10 +130,10 @@ if (res == null) {
 }
 if (res.FailedEntries.Count > 0)
 {
-    Console.WriteLine("Some events failed to be published!");   
+    Console.WriteLine("Some events failed to be published!");
     foreach (var failedEntry in res.FailedEntries)
     {
-        Console.WriteLine("EntryId: " + failedEntry.Entry.EntryId + " Error message: " + 
+        Console.WriteLine("EntryId: " + failedEntry.Entry.EntryId + " Error message: " +
                           failedEntry.ErrorMessage);
     }
 }
@@ -205,7 +205,7 @@ func main() {
         {
             "entryId": "b1f40bd6-4af2-11ed-b878-0242ac120002",
             "event":  {
-                "message": "second JSON message"   
+                "message": "second JSON message"
             },
             "contentType": "application/json"
         }
@@ -236,7 +236,7 @@ curl -X POST http://localhost:3500/v1.0-alpha1/publish/bulk/my-pubsub-name/topic
         {
             "entryId": "b1f40bd6-4af2-11ed-b878-0242ac120002",
             "event":  {
-                "message": "second JSON message"   
+                "message": "second JSON message"
             },
             "contentType": "application/json"
         },
@@ -258,7 +258,7 @@ Invoke-RestMethod -Method Post -ContentType 'application/json' -Uri 'http://loca
         {
             "entryId": "b1f40bd6-4af2-11ed-b878-0242ac120002",
             "event":  {
-                "message": "second JSON message"   
+                "message": "second JSON message"
             },
             "contentType": "application/json"
         },
@@ -271,7 +271,7 @@ Invoke-RestMethod -Method Post -ContentType 'application/json' -Uri 'http://loca
 
 ## Subscribing messages in bulk
 
-The bulk subscribe API allows you to subscribe multiple messages from a topic in a single request. 
+The bulk subscribe API allows you to subscribe multiple messages from a topic in a single request.
 As we know from [How to: Publish & Subscribe to topics]({{< ref howto-publish-subscribe.md >}}), there are two ways to subscribe to topic(s):
 
 - **Declaratively** - subscriptions are defined in an external file.
@@ -286,7 +286,7 @@ metadata:
   name: order-pub-sub
 spec:
   topic: orders
-  routes: 
+  routes:
     default: /checkout
   pubsubname: order-pub-sub
   bulkSubscribe:
@@ -300,11 +300,11 @@ scopes:
 
 In the example above, `bulkSubscribe` is _optional_. If you use `bulkSubscribe`, then:
 - `enabled` is mandatory and enables or disables bulk subscriptions on this topic
-- You can optionally configure the max number of messages (`maxMessagesCount`) delivered in a bulk message. 
-Default value of `maxMessagesCount` for components not supporting bulk subscribe is 100 i.e. for default bulk events between App and Dapr. Please refer [How components handle publishing and subscribing to bulk messages]({{< ref pubsub-bulk >}}). 
+- You can optionally configure the max number of messages (`maxMessagesCount`) delivered in a bulk message.
+Default value of `maxMessagesCount` for components not supporting bulk subscribe is 100 i.e. for default bulk events between App and Dapr. Please refer [How components handle publishing and subscribing to bulk messages]({{< ref pubsub-bulk >}}).
 If a component supports bulk subscribe, then default value for this parameter can be found in that component doc.
 - You can optionally provide the max duration to wait (`maxAwaitDurationMs`) before a bulk message is sent to the app.
-Default value of `maxAwaitDurationMs` for components not supporting bulk subscribe is 1000 i.e. for default bulk events between App and Dapr. Please refer [How components handle publishing and subscribing to bulk messages]({{< ref pubsub-bulk >}}). 
+Default value of `maxAwaitDurationMs` for components not supporting bulk subscribe is 1000 i.e. for default bulk events between App and Dapr. Please refer [How components handle publishing and subscribing to bulk messages]({{< ref pubsub-bulk >}}).
 If a component supports bulk subscribe, then default value for this parameter can be found in that component doc.
 
 The application receives an `EntryId` associated with each entry (individual message) in the bulk message. This `EntryId` must be used by the app to communicate the status of that particular entry. If the app fails to notify on an `EntryId` status, it's considered a `RETRY`.
@@ -313,16 +313,16 @@ A JSON-encoded payload body with the processing status against each entry needs
 
 ```json
 {
-  "statuses": 
-  [ 
+  "statuses":
+  [
     {
     "entryId": "<entryId1>",
     "status": "<status>"
-    }, 
+    },
     {
     "entryId": "<entryId2>",
     "status": "<status>"
-    } 
+    }
   ]
 }
 ```
@@ -477,37 +477,21 @@ For event publish/subscribe, two kinds of network transfers are involved.
 1. From/To *App* To/From *Dapr*.
 1. From/To *Dapr* To/From *Pubsub Broker*.
 
-These are the opportunities where optimization is possible. When optimized, a Bulk requests are, which reduce number of overall calls and thus increase throughput and provide better latency.
+These are the opportunities where optimization is possible. When optimized, Bulk requests are made, which reduce the overall number of calls and thus increases throughput and provides better latency.
 
 On enabling Bulk Publish and/or Bulk Subscribe, the communication between the App and Dapr sidecar (Point 1 above) is optimized for **all components**.
 
-Optimization from Dapr sidecar to the pub/sub broker would depend on a number of factors, for example:
-- If the broker inherently supports Bulk pub/sub
-- If the Dapr component is updated to support the use of bulk APIs provided by the broker. 
+Optimization from Dapr sidecar to the pub/sub broker depends on a number of factors, for example:
+- Broker must inherently support Bulk pub/sub
+- The Dapr component must be updated to support the use of bulk APIs provided by the broker
 
 Currently, the following components are updated to support this level of optimization:
-<table width="100%">
-    <tr>
-        <th>Component</th>
-        <th>Bulk Publish</th>
-        <th>Bulk Subscribe</th>
-    </tr>
-    <tr>
-        <td>Kafka</td>
-        <td>Yes</td>
-        <td>Yes</td>
-    </tr>
-    <tr>
-        <td>Azure Servicebus</td>
-        <td>Yes</td>
-        <td>Yes</td>
-    </tr>
-    <tr>
-        <td>Azure Eventhubs</td>
-        <td>Yes</td>
-        <td>Yes</td>
-    </tr>
-</table>
+
+| Component              | Bulk Publish | Bulk Subscribe |
+|:--------------------:|:--------:|--------|
+| Kafka                 | Yes       | Yes |
+| Azure Servicebus      | Yes       | Yes |
+| Azure Eventhubs       | Yes       | Yes |
 
 ## Demos
 

diff --git a/...content/en/developing-applications/building-blocks/pubsub/pubsub-cloudevents.md b/...content/en/developing-applications/building-blocks/pubsub/pubsub-cloudevents.md
@@ -106,7 +106,7 @@ with DaprClient() as client:
     result = client.publish_event(
         pubsub_name='order_pub_sub',
         topic_name='orders',
-        publish_metadata={'cloudevent.id: 'd99b228f-6c73-4e78-8c4d-3f80a043d317', cloudevent.source: 'payment'}
+        publish_metadata={'cloudevent.id': 'd99b228f-6c73-4e78-8c4d-3f80a043d317', 'cloudevent.source': 'payment'}
     )
 ```
 

diff --git a/daprdocs/content/en/getting-started/quickstarts/pubsub-quickstart.md b/daprdocs/content/en/getting-started/quickstarts/pubsub-quickstart.md
@@ -986,7 +986,7 @@ Verify you have the following files included in the service directory:
 Run the `order-processor` subscriber service alongside a Dapr sidecar.
 
 ```bash
-dapr run --app-port 5001 --app-id order-processing --app-protocol http --dapr-http-port 3501 --resources-path ../../../components -- npm run start
+dapr run --app-port 5002 --app-id order-processing --app-protocol http --dapr-http-port 3501 --resources-path ../../../components -- npm run start
 ```
 
 In the `order-processor` subscriber, we're subscribing to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. This enables your app code to talk to the Redis component instance through the Dapr sidecar.
@@ -1140,7 +1140,7 @@ dotnet build
 Run the `order-processor` subscriber service alongside a Dapr sidecar.
 
 ```bash
-dapr run --app-id order-processor --resources-path ../../../components --app-port 7005 -- dotnet run
+dapr run --app-id order-processor --resources-path ../../../components --app-port 7006 -- dotnet run
 ```
 
 In the `order-processor` subscriber, we're subscribing to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. This enables your app code to talk to the Redis component instance through the Dapr sidecar.
@@ -1457,7 +1457,7 @@ go build .
 Run the `order-processor` subscriber service alongside a Dapr sidecar.
 
 ```bash
-dapr run --app-port 6002 --app-id order-processor-sdk --app-protocol http --dapr-http-port 3501 --resources-path ../../../components -- go run .
+dapr run --app-port 6005 --app-id order-processor-sdk --app-protocol http --dapr-http-port 3501 --resources-path ../../../components -- go run .
 ```
 
 In the `order-processor` subscriber, we're subscribing to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. This enables your app code to talk to the Redis component instance through the Dapr sidecar.