diff --git a/README.md b/README.md index 3845f7cfd..056a4a9c8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,20 @@ If you are looking to explore the Dapr documentation, please go to the documenta This repo contains the markdown files which generate the above website. See below for guidance on running with a local environment to contribute to the docs. +## Branch guidance + +The Dapr docs handles branching differently than most code repositories. Instead of having a `master` or `main` branch, every branch is labeled to match the major and minor version of a runtime release. + +The following branches are currently maintained: + +| Branch | Website | Description | +|--------|---------|-------------| +| [v0.11](https://github.com/dapr/docs) (primary) | https://docs.dapr.io | Latest Dapr release documentation. Typo fixes, clarifications, and most documentation goes here. +| [v1.0-rc2](https://github.com/dapr/docs/tree/v1.0-rc2) | https://v1-rc2.docs.dapr.io/ | Latest Dapr release candidate release documentation. Doc updates that are only applicable to v1.0-rc2+ go here. +| [v1.0-rc3](https://github.com/dapr/docs/tree/v1.0-rc3) (pre-release) | https://v1-rc3.docs.dapr.io/ | Pre-release release candidate documentation. Doc updates that are only applicable to v1.0-rc3+ go here. + +For more information visit the [Dapr branch structure](https://docs.dapr.io/contributing/contributing-docs/#branch-guidance) document. + ## Contribution guidelines Before making your first contribution, make sure to review the [contributing section](http://docs.dapr.io/contributing/) in the docs. diff --git a/daprdocs/content/en/contributing/contributing-docs.md b/daprdocs/content/en/contributing/contributing-docs.md index 179934fe6..39d6afc3e 100644 --- a/daprdocs/content/en/contributing/contributing-docs.md +++ b/daprdocs/content/en/contributing/contributing-docs.md @@ -18,6 +18,14 @@ Fork the [docs repository](https://github.com/dapr/docs) to work on any changes Follow the instructions in the repository [README.md](https://github.com/dapr/docs/blob/master/README.md#environment-setup) to install Hugo locally and build the docs website. +## Branch guidance + +The Dapr docs handles branching differently than most code repositories. Instead of having a `master` or `main` branch, every branch is labeled to match the major and minor version of a runtime release. For the full list visit the [Docs repo](https://github.com/dapr/docs#branch-guidance) + +Overall, all updates should go into the docs branch for the latest release of Dapr. You can find this directly at https://github.com/dapr/docs, as the latest release will be the default branch. For any docs changes that are applicable to a release candidate or a pre-release version of the docs, make your changes into that particular branch. + +For example, if you are fixing a typo, adding notes, or clarifying a point, make your changes into the default Dapr branch. If you are documenting an upcoming change to a component or the runtime, make your changes to the pre-release branch. Branches can be found in the [Docs repo](https://github.com/dapr/docs#branch-guidance) + ## Style and tone These conventions should be followed throughout all Dapr documentation to ensure a consistent experience across all docs. diff --git a/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-get-save-state.md b/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-get-save-state.md index c7dcb577b..2a740cad4 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-get-save-state.md +++ b/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-get-save-state.md @@ -42,7 +42,7 @@ The following example shows how to save two key/value pairs in a single call usi {{% codetab %}} Begin by ensuring a Dapr sidecar is running: ```bash -dapr --app-id myapp --port 3500 run +dapr run --app-id myapp --dapr-http-port 3500 ``` {{% alert title="Note" color="info" %}} It is important to set an app-id, as the state keys are prefixed with this value. If you don't set it one is generated for you at runtime, and the next time you run the command a new one will be generated and you will no longer be able to access previously saved state. diff --git a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/_index.md b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/_index.md index cc339776e..72b0817bf 100644 --- a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/_index.md +++ b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/_index.md @@ -49,9 +49,9 @@ Every binding has its own unique set of properties. Click the name link to see t | Name | Input
Binding | Output
Binding | Status | |------|:----------------:|:-----------------:|--------| | [Azure Blob Storage]({{< ref blobstorage.md >}}) | | ✅ | Experimental | -| [Azure EventHubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Experimental | | [Azure CosmosDB]({{< ref cosmosdb.md >}}) | | ✅ | Experimental | +| [Azure Event Grid]({{< ref eventgrid.md >}}) | ✅ | ✅ | Experimental | +| [Azure Event Hubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Experimental | | [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) | ✅ | ✅ | Experimental | | [Azure SignalR]({{< ref signalr.md >}}) | | ✅ | Experimental | | [Azure Storage Queues]({{< ref storagequeues.md >}}) | ✅ | ✅ | Experimental | -| [Azure Event Grid]({{< ref eventgrid.md >}}) | ✅ | ✅ | Experimental | diff --git a/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-nats-streaming.md b/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-nats-streaming.md index fa1ef5dae..0cb33ebea 100644 --- a/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-nats-streaming.md +++ b/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-nats-streaming.md @@ -63,6 +63,8 @@ spec: # blow are subscription configuration. - name: subscriptionType value: # Required. Allowed values: topic, queue. + - name: deliverNew + value: true # - name: ackWaitTime # value: "" # Optional. See: https://docs.nats.io/developing-with-nats-streaming/acks#acknowledgements # - name: maxInFlight @@ -74,9 +76,7 @@ spec: # value: 1 # - name: startWithLastReceived # value: false - - name: deliverAll - value: true - # - name: deliverNew + # - name: deliverAll # value: false # - name: startAtTimeDelta # value: ""