From 5c60639ae1933f4d66d7116c061b03bbabc861e4 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 3 Dec 2020 14:57:08 -0800 Subject: [PATCH 01/14] Removed min-width to fix resizing issue --- daprdocs/assets/scss/_sidebar-tree.scss | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/daprdocs/assets/scss/_sidebar-tree.scss b/daprdocs/assets/scss/_sidebar-tree.scss index a080eee13..025114590 100644 --- a/daprdocs/assets/scss/_sidebar-tree.scss +++ b/daprdocs/assets/scss/_sidebar-tree.scss @@ -93,9 +93,9 @@ @include media-breakpoint-up(md) { padding-top: 4rem; background-color: $td-sidebar-bg-color; - padding-right: 1rem; + padding-right: .5rem; + padding-left: .5rem; border-right: 1px solid $td-sidebar-border-color; - min-width: 18rem; } From 0bb42a7195b025652a76b2d69f2658fe8e8ed32f Mon Sep 17 00:00:00 2001 From: Donovan Brown Date: Sun, 6 Dec 2020 17:55:14 -0600 Subject: [PATCH 02/14] Added missing word I changed "such querying states" to "such as querying states" by adding the word 'as'. --- .../state-management/query-state-store/query-redis-store.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/state-management/query-state-store/query-redis-store.md b/daprdocs/content/en/developing-applications/building-blocks/state-management/query-state-store/query-redis-store.md index ab7632e09..42e4eee16 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/state-management/query-state-store/query-redis-store.md +++ b/daprdocs/content/en/developing-applications/building-blocks/state-management/query-state-store/query-redis-store.md @@ -6,7 +6,7 @@ weight: 2000 description: "Use Redis as a backend state store" --- -Dapr doesn't transform state values while saving and retrieving states. Dapr requires all state store implementations to abide by a certain key format scheme (see [Dapr state management spec]({{}}). You can directly interact with the underlying store to manipulate the state data, such querying states, creating aggregated views and making backups. +Dapr doesn't transform state values while saving and retrieving states. Dapr requires all state store implementations to abide by a certain key format scheme (see [Dapr state management spec]({{}}). You can directly interact with the underlying store to manipulate the state data, such as querying states, creating aggregated views and making backups. >**NOTE:** The following examples uses Redis CLI against a Redis store using the default Dapr state store implementation. From c28e70b3dd69027b401973716678ab9ab12d76e2 Mon Sep 17 00:00:00 2001 From: Donovan Brown Date: Sun, 6 Dec 2020 19:07:17 -0600 Subject: [PATCH 03/14] Fixed a few typos. Updated some punctuation and a missing word. --- .../building-blocks/actors/actors-background.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md b/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md index 23efc59d1..2dd081a99 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md +++ b/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md @@ -54,7 +54,7 @@ To provide scalability and reliability, actors instances are distributed through Actors are distributed across the instances of the actor service, and those instance are distributed across the nodes in a cluster. Each service instance contains a set of actors for a given actor type. ### Actor placement service -The Dapr actor runtime manages distribution scheme and key range settings for you. This is done by the actor `Placement` service. When a new instance of a service is created, the corresponding Dapr runtime register the actor types it can create and the `Placement` service calculates the partitioning across all the instances for a given actor type. This table of partition information for each actor type is updated and stored in each Dapr instance running in the environment and can change dynamically as new instance of actor services are created and destroyed. This is shown in the diagram below. +The Dapr actor runtime manages distribution scheme and key range settings for you. This is done by the actor `Placement` service. When a new instance of a service is created, the corresponding Dapr runtime registers the actor types it can create and the `Placement` service calculates the partitioning across all the instances for a given actor type. This table of partition information for each actor type is updated and stored in each Dapr instance running in the environment and can change dynamically as new instance of actor services are created and destroyed. This is shown in the diagram below. @@ -67,11 +67,11 @@ When a client calls an actor with a particular id (for example, actor id 123), t * By default, actors are randomly placed into pods resulting in uniform distribution. * Because actors are randomly placed, it should be expected that actor operations always require network communication, including serialization and deserialization of method call data, incurring latency and overhead. -Note: The Dapr actor Placement service is only used for actor placement and therefore is not needed if your services are not using Dapr actors. The Placement service can run in all hosting environments for example, self hosted, Kubernetes +Note: The Dapr actor Placement service is only used for actor placement and therefore is not needed if your services are not using Dapr actors. The Placement service can run in all hosting environments for example, self hosted or Kubernetes. ## Actor communication -You can interact with Dapr to invoke the actor method by calling HTTP/gRPC endpoint +You can interact with Dapr to invoke the actor method by calling HTTP/gRPC endpoint. ```bash POST/GET/PUT/DELETE http://localhost:3500/v1.0/actors/// From a803f107c91fd4beecb2782ecdbb1d649d1c56c1 Mon Sep 17 00:00:00 2001 From: Carlos Mendible Date: Mon, 7 Dec 2020 18:24:14 +0100 Subject: [PATCH 04/14] Fix cause AAD Pod Identity fields are now case sensitive Fixes: https://github.com/dapr/docs/issues/988 --- .../azure-keyvault-managed-identity.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/daprdocs/content/en/operations/components/setup-secret-store/supported-secret-stores/azure-keyvault-managed-identity.md b/daprdocs/content/en/operations/components/setup-secret-store/supported-secret-stores/azure-keyvault-managed-identity.md index 06ae8a853..5613eba2c 100644 --- a/daprdocs/content/en/operations/components/setup-secret-store/supported-secret-stores/azure-keyvault-managed-identity.md +++ b/daprdocs/content/en/operations/components/setup-secret-store/supported-secret-stores/azure-keyvault-managed-identity.md @@ -102,16 +102,16 @@ description: How to configure Azure Key Vault and Kubernetes to use Azure Manage name: [you managed identity name] spec: type: 0 - ResourceID: [you managed identity id] - ClientID: [you managed identity Client ID] + resourceID: [you managed identity id] + clientID: [you managed identity Client ID] --- apiVersion: "aadpodidentity.k8s.io/v1" kind: AzureIdentityBinding metadata: name: [you managed identity name]-identity-binding spec: - AzureIdentity: [you managed identity name] - Selector: [you managed identity selector] + azureIdentity: [you managed identity name] + selector: [you managed identity selector] ``` 10. Deploy the azure-identity-config.yaml: From b368231969d59555d87cdbabcf6f893bb0ed4d62 Mon Sep 17 00:00:00 2001 From: Mark Chmarny Date: Tue, 8 Dec 2020 16:33:40 -0800 Subject: [PATCH 05/14] Updates binding concepts link --- .../building-blocks/bindings/howto-triggers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 2adfc10b4..b77259697 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 @@ -97,5 +97,5 @@ Event delivery guarantees are controlled by the binding implementation. Dependin ## References * Binding [API](https://github.com/dapr/docs/blob/master/reference/api/bindings_api.md) -* Binding [Components](https://github.com/dapr/docs/tree/master/concepts/bindings) +* Binding [Components](https://docs.dapr.io/concepts/building-blocks-concept/) * Binding [Detailed specifications](https://github.com/dapr/docs/tree/master/reference/specs/bindings) From 5436651203863f6003d2333b655cd29c28f11ebb Mon Sep 17 00:00:00 2001 From: Mark Chmarny Date: Wed, 9 Dec 2020 14:52:13 -0800 Subject: [PATCH 06/14] Clarifies declarative vs. programmatic pub/sub approach Addresses #994 --- .../building-blocks/pubsub/howto-publish-subscribe.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md index 9221627bf..e3e8ddd93 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md +++ b/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md @@ -66,9 +66,12 @@ spec: ## Step 2: Subscribe to topics Dapr allows two methods by which you can subscribe to topics: + - **Declaratively**, where subscriptions are are defined in an external file. - **Programatically**, where subscriptions are defined in user code +> Note, both, declarative and programatic approaches support the same features. The decelrative approach removes the Dapr dependancy from the user code and allows for the use of an existing application to subscribe to topic. The programmatic approach implements the subscription in user code. + ### Declarative subscriptions You can subscribe to a topic using the following Custom Resources Definition (CRD). Create a file named `subscription.yaml` and paste the following: From 0389dc4213285c02d0e9e14c6e560c8342c8ee1c Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 10 Dec 2020 10:45:03 -0800 Subject: [PATCH 07/14] Add link to hosting environments --- .../building-blocks/actors/actors-background.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md b/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md index 2dd081a99..b2c5f3a3f 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md +++ b/daprdocs/content/en/developing-applications/building-blocks/actors/actors-background.md @@ -67,7 +67,7 @@ When a client calls an actor with a particular id (for example, actor id 123), t * By default, actors are randomly placed into pods resulting in uniform distribution. * Because actors are randomly placed, it should be expected that actor operations always require network communication, including serialization and deserialization of method call data, incurring latency and overhead. -Note: The Dapr actor Placement service is only used for actor placement and therefore is not needed if your services are not using Dapr actors. The Placement service can run in all hosting environments for example, self hosted or Kubernetes. +Note: The Dapr actor Placement service is only used for actor placement and therefore is not needed if your services are not using Dapr actors. The Placement service can run in all [hosting environments]({{< ref hosting >}}), including self-hosted and Kubernetes. ## Actor communication From 4f0701780f4cc7eaee1a0f56b90de9b68ec3467f Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 10 Dec 2020 10:53:44 -0800 Subject: [PATCH 08/14] Update links to new format --- .../building-blocks/bindings/howto-triggers.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) 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 b77259697..f70e052b4 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 @@ -96,6 +96,7 @@ Event delivery guarantees are controlled by the binding implementation. Dependin ## References -* Binding [API](https://github.com/dapr/docs/blob/master/reference/api/bindings_api.md) -* Binding [Components](https://docs.dapr.io/concepts/building-blocks-concept/) -* Binding [Detailed specifications](https://github.com/dapr/docs/tree/master/reference/specs/bindings) +* [Bindings building block]({{< ref bindings >}}) +* [Bindings API]({{< ref bindings_api.md >}}) +* [Components concept]({{< ref components-concept.md >}}) +* [Supported bindings]({{< ref supported-bindings >}}) From 1006936695da2db53011e93289f2c8c5ea7bdb9d Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 10 Dec 2020 11:03:32 -0800 Subject: [PATCH 09/14] Change to shortcode note and fix spelling --- .../building-blocks/pubsub/howto-publish-subscribe.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md index e3e8ddd93..6546e0c34 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md +++ b/daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md @@ -68,9 +68,11 @@ spec: Dapr allows two methods by which you can subscribe to topics: - **Declaratively**, where subscriptions are are defined in an external file. -- **Programatically**, where subscriptions are defined in user code +- **Programmatically**, where subscriptions are defined in user code -> Note, both, declarative and programatic approaches support the same features. The decelrative approach removes the Dapr dependancy from the user code and allows for the use of an existing application to subscribe to topic. The programmatic approach implements the subscription in user code. +{{% alert title="Note" color="primary" %}} +Both declarative and programmatic approaches support the same features. The declarative approach removes the Dapr dependancy from the user code and allows for the use of an existing application to subscribe to topics. The programmatic approach implements the subscription in user code. +{{% /alert %}} ### Declarative subscriptions From b7927256a0f25c942d26b89a1b2f932e7eebc395 Mon Sep 17 00:00:00 2001 From: Donovan Brown Date: Fri, 11 Dec 2020 10:53:37 -0600 Subject: [PATCH 10/14] Fixed typo in setup-sqlserver (#1004) Fixed typo. Changed "schema do use" to "schema to use" --- .../setup-state-store/supported-state-stores/setup-sqlserver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-sqlserver.md b/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-sqlserver.md index 7808fbf5c..3d6411592 100644 --- a/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-sqlserver.md +++ b/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-sqlserver.md @@ -14,7 +14,7 @@ description: Detailed information on the SQL Server state store component In order to setup SQL Server as a state store, you will need the following properties: - **Connection String**: the SQL Server connection string. For example: server=localhost;user id=sa;password=your-password;port=1433;database=mydatabase; -- **Schema**: The database schema do use (default=dbo). Will be created if not exists +- **Schema**: The database schema to use (default=dbo). Will be created if not exists - **Table Name**: The database table name. Will be created if not exists - **Indexed Properties**: Optional properties from json data which will be indexed and persisted as individual column From 22e9a087f56313bab52e2341cbed2628ce8767d2 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 11 Dec 2020 13:32:44 -0800 Subject: [PATCH 11/14] Update azure-static-web-apps-green-hill-0d7377310.yml --- .../workflows/azure-static-web-apps-green-hill-0d7377310.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/azure-static-web-apps-green-hill-0d7377310.yml b/.github/workflows/azure-static-web-apps-green-hill-0d7377310.yml index 3c3ae167a..cea12057b 100644 --- a/.github/workflows/azure-static-web-apps-green-hill-0d7377310.yml +++ b/.github/workflows/azure-static-web-apps-green-hill-0d7377310.yml @@ -3,11 +3,11 @@ name: Azure Static Web Apps CI/CD on: push: branches: - - website + - v0.11 pull_request: types: [opened, synchronize, reopened, closed] branches: - - website + - v0.11 jobs: build_and_deploy_job: From c6df5e0e2c72c1e7c55e2468d75a98ebc6943618 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 11 Dec 2020 13:35:58 -0800 Subject: [PATCH 12/14] Update config.toml --- daprdocs/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/config.toml b/daprdocs/config.toml index af8ebc3ae..8342c5b9b 100644 --- a/daprdocs/config.toml +++ b/daprdocs/config.toml @@ -58,7 +58,7 @@ offlineSearch = false github_repo = "https://github.com/dapr/docs" github_project_repo = "https://github.com/dapr/dapr" github_subdir = "daprdocs" -github_branch = "website" +github_branch = "v0.11" # Versioning version_menu = "v0.11 (latest)" From 00d097f371246ea8da4f160f3b89e710973ab5f9 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 11 Dec 2020 13:37:50 -0800 Subject: [PATCH 13/14] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf537e213..e3c429ec4 100644 --- a/README.md +++ b/README.md @@ -54,9 +54,10 @@ hugo server --disableFastRender 3. Navigate to `http://localhost:1313/docs` ## Update docs +1. Fork repo into your account 1. Create new branch -1. Commit and push changes to content -1. Submit pull request to `master` +1. Commit and push changes to forked branch +1. Submit pull request from downstream branch to the upstream branch for the correct version you are targeting 1. Staging site will automatically get created and linked to PR to review and test ## Code of Conduct From dc8137cd7711cdaf8df7c68245aec0da2ed3a758 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Mon, 14 Dec 2020 14:21:34 -0800 Subject: [PATCH 14/14] Add information on linking to specific sections --- .../content/en/contributing/contributing-docs.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/daprdocs/content/en/contributing/contributing-docs.md b/daprdocs/content/en/contributing/contributing-docs.md index 0e5210bf0..ca08f9739 100644 --- a/daprdocs/content/en/contributing/contributing-docs.md +++ b/daprdocs/content/en/contributing/contributing-docs.md @@ -104,8 +104,19 @@ This shortcode will link to a specific page: ```md {{}} ``` +> Note that all pages and folders need to have globally unique names in order for the ref shortcode to work properly. If there are duplicate names the build will break and an error will be thrown. -> Note that all pages and folders need to have globally unique names in order for the ref shortcode to work properly. +#### Referencing sections in other pages + +To reference a specific section in another page, add `#section-short-name` to the end of your reference. + +As a general rule, the section short name is the text of the section title, all lowercase, with spaces changed to "-". You can check the section short name by visiting the website page, clicking the link icon (🔗) next to the section, and see how the URL renders in the nav bar. The content after the "#" is your section shortname. + +As an example, for this specific section the complete reference to the page and section would be: + +```md +{{}} +``` ### Images The markdown spec used by Docsy and Hugo does not give an option to resize images using markdown notation. Instead, raw HMTL is used.