From 51108827bbf894d7f0b1153274523b322b93471b Mon Sep 17 00:00:00 2001 From: xavier geerinck Date: Tue, 23 Feb 2021 15:55:53 +0100 Subject: [PATCH 01/23] Fixing Blob Storage Documentation some mistakes where made when adding codetabs, fixed those closing tags. Also fixed title tags for examples --- .../supported-bindings/blobstorage.md | 104 +++++++++--------- 1 file changed, 54 insertions(+), 50 deletions(-) diff --git a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md index 7721dfb7e..e6c34d75b 100644 --- a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md +++ b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md @@ -68,47 +68,48 @@ To perform a create blob operation, invoke the Azure Blob Storage binding with a #### Examples + +##### Saving to a random generated UUID file + {{< tabs Windows Linux >}} + {{% codetab %}} + On Windows, utilize cmd prompt (PowerShell has different escaping mechanism) + ```bash + curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\" }" http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} -**Saving to a random generated UUID file** -{{% codetab %}} -On Windows, utilize cmd prompt (PowerShell has different escaping mechanism) -```bash -curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\" }" http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} - -{{% codetab %}} -```bash -curl -d '{ "operation": "create", "data": "Hello World" }' \ - http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} + {{% codetab %}} + ```bash + curl -d '{ "operation": "create", "data": "Hello World" }' \ + http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} {{< /tabs >}} -**Saving to a specific file** +##### Saving to a specific file {{< tabs Windows Linux >}} -{{% codetab %}} -```bash -curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"blobName\": \"my-test-file.txt\" } }" \ - http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} + {{% codetab %}} + ```bash + curl -d "{ \"operation\": \"create\", \"data\": \"Hello World\", \"metadata\": { \"blobName\": \"my-test-file.txt\" } }" \ + http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} -{{% codetab %}} -```bash -curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "blobName": "my-test-file.txt" } }' \ - http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} + {{% codetab %}} + ```bash + curl -d '{ "operation": "create", "data": "Hello World", "metadata": { "blobName": "my-test-file.txt" } }' \ + http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} {{< /tabs >}} -**Saving a file** +##### Saving a file To upload a file, encode it as Base64 and let the Binding know to deserialize it: @@ -136,18 +137,18 @@ Then you can upload it as you would normally: {{< tabs Windows Linux >}} -{{% codetab %}} -```bash -curl -d "{ \"operation\": \"create\", \"data\": \"YOUR_BASE_64_CONTENT\", \"metadata\": { \"blobName\": \"my-test-file.jpg\" } }" http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} + {{% codetab %}} + ```bash + curl -d "{ \"operation\": \"create\", \"data\": \"YOUR_BASE_64_CONTENT\", \"metadata\": { \"blobName\": \"my-test-file.jpg\" } }" http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} -{{% codetab %}} -```bash -curl -d '{ "operation": "create", "data": "YOUR_BASE_64_CONTENT", "metadata": { "blobName": "my-test-file.jpg" } }' \ - http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} + {{% codetab %}} + ```bash + curl -d '{ "operation": "create", "data": "YOUR_BASE_64_CONTENT", "metadata": { "blobName": "my-test-file.jpg" } }' \ + http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} {{< /tabs >}} @@ -179,18 +180,20 @@ To perform a get blob operation, invoke the Azure Blob Storage binding with a `P {{< tabs Windows Linux >}} -{{% codetab %}} -```bash -curl -d '{ \"operation\": \"get\", \"metadata\": { \"blobName\": \"myblob\" }}' http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} + {{% codetab %}} + ```bash + curl -d '{ \"operation\": \"get\", \"metadata\": { \"blobName\": \"myblob\" }}' http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} -{{% codetab %}} -```bash -curl -d '{ "operation": "get", "metadata": { "blobName": "myblob" }}' \ - http://localhost:/v1.0/bindings/ -``` -{{% /codetab %}} + {{% codetab %}} + ```bash + curl -d '{ "operation": "get", "metadata": { "blobName": "myblob" }}' \ + http://localhost:/v1.0/bindings/ + ``` + {{% /codetab %}} + +{{< /tabs >}} #### Response @@ -201,6 +204,7 @@ The response body contains the value stored in the blob object. By default the Azure Blob Storage output binding auto generates a UUID as the blob filename and is not assigned any system or custom metadata to it. It is configurable in the metadata property of the message (all optional). Applications publishing to an Azure Blob Storage output binding should send a message with the following format: + ```json { "data": "file content", From 0aaed44c5b2c23ac9097195e262fc43d3b86cd8b Mon Sep 17 00:00:00 2001 From: Joni Collinge Date: Sun, 28 Feb 2021 08:16:45 +0000 Subject: [PATCH 02/23] Update setup-azure-servicebus.md --- .../setup-pubsub/supported-pubsub/setup-azure-servicebus.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-azure-servicebus.md b/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-azure-servicebus.md index 98200e691..c43196cc9 100644 --- a/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-azure-servicebus.md +++ b/daprdocs/content/en/operations/components/setup-pubsub/supported-pubsub/setup-azure-servicebus.md @@ -44,6 +44,10 @@ spec: value: 10 - name: autoDeleteOnIdleInSec # Optional value: 10 + - name: maxReconnectionAttempts # Optional + value: 30 + - name: connectionRecoveryInSec # Optional + value: 2 ``` > __NOTE:__ The above settings are shared across all topics that use this component. @@ -69,6 +73,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr | prefetchCount | N |Defines the number of prefetched messages (use for high throughput / low latency scenarios)| `5` | defaultMessageTimeToLiveInSec | N |Default message time to live. | `10` | autoDeleteOnIdleInSec | N |Time in seconds to wait before auto deleting messages. | `10` +| maxReconnectionAttempts | N |Defines the maximum number of reconnect attempts. Default: `30` | `30` +| connectionRecoveryInSec | N |Time in seconds to wait between connection recovery attempts. Defaults: `2` | `2` ## Create an Azure Service Bus From ff0f90dd5a2ae8830058569d9086aebc075fcca9 Mon Sep 17 00:00:00 2001 From: Fabian Date: Wed, 3 Mar 2021 22:32:15 +0100 Subject: [PATCH 03/23] Fix link --- daprdocs/content/en/contributing/contributing-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/contributing/contributing-docs.md b/daprdocs/content/en/contributing/contributing-docs.md index fd671fd02..ae8c6dfd7 100644 --- a/daprdocs/content/en/contributing/contributing-docs.md +++ b/daprdocs/content/en/contributing/contributing-docs.md @@ -22,7 +22,7 @@ Follow the instructions in the repository [README.md](https://github.com/dapr/do 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. +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](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) From bfec9dc2512e973193fc3f8841c6630f5bc333d0 Mon Sep 17 00:00:00 2001 From: newbe36524 Date: Thu, 4 Mar 2021 13:58:52 +0800 Subject: [PATCH 04/23] Add content that translated into zh_Hans --- .gitmodules | 4 ++++ daprdocs/config.toml | 40 ++++++++++++++++++++++++++++++++++++++++ l18n/docs-zh | 1 + 3 files changed, 45 insertions(+) create mode 160000 l18n/docs-zh diff --git a/.gitmodules b/.gitmodules index be99ad3b7..53189ae90 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,3 +10,7 @@ [submodule "sdkdocs/dotnet"] path = sdkdocs/dotnet url = https://github.com/dapr/dotnet-sdk.git +[submodule "l18n/docs-zh"] + path = l18n/docs-zh + url = https://github.com/dapr/docs-zh.git + branch = v1.0_content diff --git a/daprdocs/config.toml b/daprdocs/config.toml index 3dccca2e7..7957dd23c 100644 --- a/daprdocs/config.toml +++ b/daprdocs/config.toml @@ -10,6 +10,18 @@ enableGitInfo = true # Language Configuration languageCode = "en-us" +[languages] + [languages.en] + title = "English" + weight = 1 + contentDir = "content/en" + languageName = "English" + [languages.zh-hans] + title = "简体中文" + weight = 2 + contentDir = "content/zh-hans" + languageName = "简体中文" + # Disable categories & tags disableKinds = ["taxonomy", "term"] @@ -22,6 +34,7 @@ id = "UA-149338238-3" [[module.mounts]] source = "content/en" target = "content" + lang = "en" [[module.mounts]] source = "static" target = "static" @@ -37,21 +50,48 @@ id = "UA-149338238-3" [[module.mounts]] source = "archetypes" target = "archetypes" + [[module.mounts]] source = "../sdkdocs/python/daprdocs/content/en/python-sdk-docs" target = "content/developing-applications/sdks/python" + lang = "en" [[module.mounts]] source = "../sdkdocs/python/daprdocs/content/en/python-sdk-contributing" target = "content/contributing/" + lang = "en" [[module.mounts]] source = "../sdkdocs/php/daprdocs/content/en/php-sdk-docs" target = "content/developing-applications/sdks/php" + lang = "en" [[module.mounts]] source = "../sdkdocs/dotnet/daprdocs/content/en/dotnet-sdk-docs" target = "content/developing-applications/sdks/dotnet" + lang = "en" [[module.mounts]] source = "../sdkdocs/dotnet/daprdocs/content/en/dotnet-sdk-contributing" target = "content/contributing/" + lang = "en" + + [[module.mounts]] + source = "../l18n/docs-zh/content/zh-hans" + target = "content" + lang = "zh-hans" + [[module.mounts]] + source = "../l18n/docs-zh/content/contributing" + target = "content/contributing/" + lang = "zh-hans" + [[module.mounts]] + source = "../l18n/docs-zh/content/sdks_python" + target = "content/developing-applications/sdks/python" + lang = "zh-hans" + [[module.mounts]] + source = "../l18n/docs-zh/content/sdks_php" + target = "content/developing-applications/sdks/php" + lang = "zh-hans" + [[module.mounts]] + source = "../l18n/docs-zh/content/sdks_dotnet" + target = "content/developing-applications/sdks/dotnet" + lang = "zh-hans" # Markdown Engine - Allow inline html [markup] diff --git a/l18n/docs-zh b/l18n/docs-zh new file mode 160000 index 000000000..e26148b86 --- /dev/null +++ b/l18n/docs-zh @@ -0,0 +1 @@ +Subproject commit e26148b866552f94a148c5ad6fe81e066775b804 From f1c48c1fd9586916262f10cce9f463cfc22f10d7 Mon Sep 17 00:00:00 2001 From: xavier geerinck Date: Thu, 4 Mar 2021 22:11:36 +0100 Subject: [PATCH 05/23] Update daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md Co-authored-by: Aaron Crawfis --- .../components/setup-bindings/supported-bindings/blobstorage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md index e6c34d75b..cacf8769c 100644 --- a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md +++ b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md @@ -69,7 +69,7 @@ To perform a create blob operation, invoke the Azure Blob Storage binding with a #### Examples -##### Saving to a random generated UUID file +##### Save text to a random generated UUID blob {{< tabs Windows Linux >}} {{% codetab %}} From 088cf1f922ec32bf75d44d086e27d0678927c672 Mon Sep 17 00:00:00 2001 From: xavier geerinck Date: Thu, 4 Mar 2021 22:11:40 +0100 Subject: [PATCH 06/23] Update daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md Co-authored-by: Aaron Crawfis --- .../components/setup-bindings/supported-bindings/blobstorage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md index cacf8769c..aa678a058 100644 --- a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md +++ b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md @@ -88,7 +88,7 @@ To perform a create blob operation, invoke the Azure Blob Storage binding with a {{< /tabs >}} -##### Saving to a specific file +##### Save text to a specific blob {{< tabs Windows Linux >}} From 5303bfdccc5b43bcbff6b118bcea62986307c129 Mon Sep 17 00:00:00 2001 From: xavier geerinck Date: Thu, 4 Mar 2021 22:11:43 +0100 Subject: [PATCH 07/23] Update daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md Co-authored-by: Aaron Crawfis --- .../components/setup-bindings/supported-bindings/blobstorage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md index aa678a058..409f8efe0 100644 --- a/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md +++ b/daprdocs/content/en/operations/components/setup-bindings/supported-bindings/blobstorage.md @@ -109,7 +109,7 @@ To perform a create blob operation, invoke the Azure Blob Storage binding with a {{< /tabs >}} -##### Saving a file +##### Save a file to a blob To upload a file, encode it as Base64 and let the Binding know to deserialize it: From 06e05fd7da6dd66549bb49f30e2f945d47dffb8b Mon Sep 17 00:00:00 2001 From: Ori Zohar Date: Thu, 4 Mar 2021 14:29:33 -0800 Subject: [PATCH 08/23] Fixing typo --- daprdocs/content/en/concepts/security-concept.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/concepts/security-concept.md b/daprdocs/content/en/concepts/security-concept.md index c130d0fe4..dd097337e 100644 --- a/daprdocs/content/en/concepts/security-concept.md +++ b/daprdocs/content/en/concepts/security-concept.md @@ -11,7 +11,7 @@ This article addresses multiple security considerations when using Dapr in a dis Several of the areas above are addressed through encryption of data in transit. One of the security mechanisms that Dapr employs for encrypting data in transit is [mutual authentication TLS](https://en.wikipedia.org/wiki/Mutual_authentication) or mTLS. mTLS offers a few key features for network traffic inside your application: -- Two way authentication - the client proving its identify to the server, and vice-versa +- Two way authentication - the client proving its identity to the server, and vice-versa - An encrypted channel for all in-flight communication, after two-way authentication is established Mutual TLS is useful in almost all scenarios, but especially so for systems subject to regulations such as [HIPAA](https://en.wikipedia.org/wiki/Health_Insurance_Portability_and_Accountability_Act) and [PCI](https://en.wikipedia.org/wiki/Payment_Card_Industry_Data_Security_Standard). From 5472fe260464f96e71d99a72377d8a43bc1add64 Mon Sep 17 00:00:00 2001 From: Charlie Stanley Date: Tue, 23 Feb 2021 15:32:14 -0800 Subject: [PATCH 09/23] Adding automatic link validation --- .github/workflows/link_validation.yaml | 29 +++++++++++++++++++ daprdocs/content/en/concepts/faq.md | 2 +- .../en/contributing/contributing-overview.md | 2 +- .../setup-pubsub/pubsub-namespaces.md | 4 +-- .../azure-keyvault-managed-identity.md | 2 +- .../supported-state-stores/setup-redis.md | 2 +- .../self-hosted/self-hosted-no-docker.md | 4 +-- 7 files changed, 37 insertions(+), 8 deletions(-) create mode 100644 .github/workflows/link_validation.yaml diff --git a/.github/workflows/link_validation.yaml b/.github/workflows/link_validation.yaml new file mode 100644 index 000000000..e0bcbfae7 --- /dev/null +++ b/.github/workflows/link_validation.yaml @@ -0,0 +1,29 @@ +name: validate-links + +on: + push: + branches: + - v* + tags: + - v* + pull_request: + branches: + - v* +jobs: + validate: + runs-on: ubuntu-latest + env: + PYTHON_VER: 3.7 + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ env.PYTHON_VER }} + uses: actions/setup-python@v2 + with: + python-version: ${{ env.PYTHON_VER }} + - name: Install dependencies + run: | + python3 -m pip install --upgrade pip + pip3 install setuptools wheel twine tox mechanical-markdown + - name: Check Markdown Files + run: | + for name in `find . -name "*.md"`; do echo -e "------\n$name" ; mm.py -l $name || exit 1 ;done diff --git a/daprdocs/content/en/concepts/faq.md b/daprdocs/content/en/concepts/faq.md index aaad28c0b..8106ef646 100644 --- a/daprdocs/content/en/concepts/faq.md +++ b/daprdocs/content/en/concepts/faq.md @@ -36,7 +36,7 @@ The Dapr project is focused on performance due to the inherent discussion of Dap ### What is the relationship between Dapr, Orleans and Service Fabric Reliable Actors? The actors in Dapr are based on the same virtual actor concept that [Orleans](https://www.microsoft.com/research/project/orleans-virtual-actors/) started, meaning that they are activated when called and deactivated after a period of time. If you are familiar with Orleans, Dapr C# actors will be familiar. Dapr C# actors are based on [Service Fabric Reliable Actors](https://docs.microsoft.com/azure/service-fabric/service-fabric-reliable-actors-introduction) (which also came from Orleans) and enable you to take Reliable Actors in Service Fabric and migrate them to other hosting platforms such as Kubernetes or other on-premise environments. -Also Dapr is about more than just actors. It provides you with a set of best practice building blocks to build into any microservices application. See [Dapr overview](https://github.com/dapr/docs/blob/master/overview/README.md). +Also Dapr is about more than just actors. It provides you with a set of best practice building blocks to build into any microservices application. See [Dapr overview]({{< ref overview.md >}}). ### Differences between Dapr from an actor framework diff --git a/daprdocs/content/en/contributing/contributing-overview.md b/daprdocs/content/en/contributing/contributing-overview.md index cc9c81cd2..c8b72c60b 100644 --- a/daprdocs/content/en/contributing/contributing-overview.md +++ b/daprdocs/content/en/contributing/contributing-overview.md @@ -38,7 +38,7 @@ Before you submit an issue, make sure you've checked the following: - 👎 down-vote 1. For bugs - Check it's not an environment issue. For example, if running on Kubernetes, make sure prerequisites are in place. (state stores, bindings, etc.) - - You have as much data as possible. This usually comes in the form of logs and/or stacktrace. If running on Kubernetes or other environment, look at the logs of the Dapr services (runtime, operator, placement service). More details on how to get logs can be found [here](https://github.com/dapr/docs/tree/master/best-practices/troubleshooting/logs.md). + - You have as much data as possible. This usually comes in the form of logs and/or stacktrace. If running on Kubernetes or other environment, look at the logs of the Dapr services (runtime, operator, placement service). More details on how to get logs can be found [here]({{< ref "logs-troubleshooting.md" >}}). 1. For proposals - Many changes to the Dapr runtime may require changes to the API. In that case, the best place to discuss the potential feature is the main [Dapr repo](https://github.com/dapr/dapr). - Other examples could include bindings, state stores or entirely new components. diff --git a/daprdocs/content/en/operations/components/setup-pubsub/pubsub-namespaces.md b/daprdocs/content/en/operations/components/setup-pubsub/pubsub-namespaces.md index fa186b403..a845e545b 100644 --- a/daprdocs/content/en/operations/components/setup-pubsub/pubsub-namespaces.md +++ b/daprdocs/content/en/operations/components/setup-pubsub/pubsub-namespaces.md @@ -43,7 +43,7 @@ kubectl create namespace namespace-a kubectl config set-context --current --namespace=namespace-a ``` -Install Redis (master and slave) on `namespace-a`, following [these instructions](https://github.com/dapr/docs/blob/master/howto/setup-pub-sub-message-broker/setup-redis.md). +Install Redis (master and slave) on `namespace-a`, following [these instructions]({{< ref "configure-state-pubsub.md" >}}). Now, configure `deploy/redis.yaml`, paying attention to the hostname containing `namespace-a`. @@ -125,4 +125,4 @@ kubectl delete namespace namespace-b - [Scope components to one or more applications]({{< ref "component-scopes.md" >}}) - [Use secret scoping]({{< ref "secrets-scopes.md" >}}) -- [Limit the secrets that can be read from secret stores]({{< ref "secret-scope.md" >}}) \ No newline at end of file +- [Limit the secrets that can be read from secret stores]({{< ref "secret-scope.md" >}}) 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 a95890410..fa1e015fe 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 @@ -78,7 +78,7 @@ The above example uses secrets as plain strings. It is recommended to use a loca ```bash az aks show -g -n ``` - For more detail about the roles to assign to integrate AKS with Azure Services [Role Assignment](https://github.com/Azure/aad-pod-identity/blob/master/docs/readmes/README.role-assignment.md). + For more detail about the roles to assign to integrate AKS with Azure Services [Role Assignment](https://azure.github.io/aad-pod-identity/docs/getting-started/role-assignment/). 4. Retrieve Managed Identity ID diff --git a/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-redis.md b/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-redis.md index 79810ee1f..bfdd6f94a 100644 --- a/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-redis.md +++ b/daprdocs/content/en/operations/components/setup-state-store/supported-state-stores/setup-redis.md @@ -112,7 +112,7 @@ We can use [Helm](https://helm.sh/) to quickly create a Redis instance in our Ku 4. Once your instance is created, you'll need to grab the Host name (FQDN) and your access key. - for the Host name navigate to the resources "Overview" and copy "Host name" - for your access key navigate to "Access Keys" under "Settings" and copy your key. -5. Finally, we need to add our key and our host to a `redis.yaml` file that Dapr can apply to our cluster. If you're running a sample, you'll add the host and key to the provided `redis.yaml`. If you're creating a project from the ground up, you'll create a `redis.yaml` file as specified in [Configuration](#configuration). Set the `redisHost` key to `[HOST NAME FROM PREVIOUS STEP]:6379` and the `redisPassword` key to the key you copied in step 4. **Note:** In a production-grade application, follow [secret management](https://github.com/dapr/docs/blob/master/concepts/components/secrets.md) instructions to securely manage your secrets. +5. Finally, we need to add our key and our host to a `redis.yaml` file that Dapr can apply to our cluster. If you're running a sample, you'll add the host and key to the provided `redis.yaml`. If you're creating a project from the ground up, you'll create a `redis.yaml` file as specified in [Configuration](#configuration). Set the `redisHost` key to `[HOST NAME FROM PREVIOUS STEP]:6379` and the `redisPassword` key to the key you copied in step 4. **Note:** In a production-grade application, follow [secret management]({{< ref component-secrets.md >}}) instructions to securely manage your secrets. > **NOTE:** Dapr pub/sub uses [Redis Streams](https://redis.io/topics/streams-intro) that was introduced by Redis 5.0, which isn't currently available on Azure Managed Redis Cache. Consequently, you can use Azure Managed Redis Cache only for state persistence. {{% /codetab %}} diff --git a/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-no-docker.md b/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-no-docker.md index 4c550ad06..355452b3a 100644 --- a/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-no-docker.md +++ b/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-no-docker.md @@ -51,9 +51,9 @@ INFO[0001] leader is established. instance=Nicoletaz-L10. ``` -From here on you can follow the sample example created for the [java-sdk](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/actors/http), [python-sdk](https://github.com/dapr/python-sdk/tree/master/examples/demo_actor) or [dotnet-sdk](https://github.com/dapr/dotnet-sdk/tree/master/samples/Actor) for running an application with Actors enabled. +From here on you can follow the sample example created for the [java-sdk](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/actors), [python-sdk](https://github.com/dapr/python-sdk/tree/master/examples/demo_actor) or [dotnet-sdk]({{< ref "dotnet-actor-howto.md" >}}) for running an application with Actors enabled. -Update the state store configuration files to have the Redis host and password match the setup that you have. Additionally to enable it as a actor state store have the metadata piece added similar to the [sample Java Redis component](https://github.com/dapr/java-sdk/blob/master/examples/components/redis.yaml) definition. +Update the state store configuration files to have the Redis host and password match the setup that you have. Additionally to enable it as a actor state store have the metadata piece added similar to the [sample Java Redis component](https://github.com/dapr/java-sdk/blob/master/examples/components/state/redis.yaml) definition. ```yaml - name: actorStateStore From a7d34dc1cfee501f4a814a5405a8044c192e9b6c Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Thu, 4 Mar 2021 17:13:05 -0800 Subject: [PATCH 10/23] Add info on translations --- .../en/contributing/contributing-docs.md | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/daprdocs/content/en/contributing/contributing-docs.md b/daprdocs/content/en/contributing/contributing-docs.md index ae8c6dfd7..3fa66cbe5 100644 --- a/daprdocs/content/en/contributing/contributing-docs.md +++ b/daprdocs/content/en/contributing/contributing-docs.md @@ -232,3 +232,32 @@ The shortcode would be: ### References - [Docsy authoring guide](https://www.docsy.dev/docs/adding-content/) + +## Translations + +The Dapr Docs supports adding language translations into the docs using git submodules and Hugo's built in language support. + +You can find an example PR of adding Chinese language support in [PR 1286](https://github.com/dapr/docs/pull/1286). + +Steps to add a language: +- Open an issue in the Docs repo requesting to create a new language-specific docs repo +- Once created, create a git submodule within the docs repo: + ```sh + git submodule add translations/ + ``` +- Add a language entry within `daprdocs/config.toml`: + ```toml + [languages.] + title = "Dapr Docs" + weight = 3 + contentDir = "content/" + languageName = "" + ``` +- Create a mount within `daprdocs/config.toml`: + ```toml + [[module.mounts]] + source = "../translations/docs-/content/" + target = "content" + lang = "" + ``` +- Repeat above step as necessary for all other translation directories \ No newline at end of file From 5ef3bf0d28b6a388f5fc4ede7120b80ccf8aa8e2 Mon Sep 17 00:00:00 2001 From: newbe36524 Date: Fri, 5 Mar 2021 12:09:35 +0800 Subject: [PATCH 11/23] Change name of submodule --- .gitmodules | 4 ++-- daprdocs/config.toml | 14 +++++++------- {l18n => translations}/docs-zh | 0 3 files changed, 9 insertions(+), 9 deletions(-) rename {l18n => translations}/docs-zh (100%) diff --git a/.gitmodules b/.gitmodules index 53189ae90..3d8a47fd8 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,7 +10,7 @@ [submodule "sdkdocs/dotnet"] path = sdkdocs/dotnet url = https://github.com/dapr/dotnet-sdk.git -[submodule "l18n/docs-zh"] - path = l18n/docs-zh +[submodule "translations/docs-zh"] + path = translations/docs-zh url = https://github.com/dapr/docs-zh.git branch = v1.0_content diff --git a/daprdocs/config.toml b/daprdocs/config.toml index 7957dd23c..8348915d3 100644 --- a/daprdocs/config.toml +++ b/daprdocs/config.toml @@ -12,12 +12,12 @@ languageCode = "en-us" [languages] [languages.en] - title = "English" + title = "Dapr Docs" weight = 1 contentDir = "content/en" languageName = "English" [languages.zh-hans] - title = "简体中文" + title = "Dapr 文档库" weight = 2 contentDir = "content/zh-hans" languageName = "简体中文" @@ -73,23 +73,23 @@ id = "UA-149338238-3" lang = "en" [[module.mounts]] - source = "../l18n/docs-zh/content/zh-hans" + source = "../translations/docs-zh/content/zh-hans" target = "content" lang = "zh-hans" [[module.mounts]] - source = "../l18n/docs-zh/content/contributing" + source = "../translations/docs-zh/content/contributing" target = "content/contributing/" lang = "zh-hans" [[module.mounts]] - source = "../l18n/docs-zh/content/sdks_python" + source = "../translations/docs-zh/content/sdks_python" target = "content/developing-applications/sdks/python" lang = "zh-hans" [[module.mounts]] - source = "../l18n/docs-zh/content/sdks_php" + source = "../translations/docs-zh/content/sdks_php" target = "content/developing-applications/sdks/php" lang = "zh-hans" [[module.mounts]] - source = "../l18n/docs-zh/content/sdks_dotnet" + source = "../translations/docs-zh/content/sdks_dotnet" target = "content/developing-applications/sdks/dotnet" lang = "zh-hans" diff --git a/l18n/docs-zh b/translations/docs-zh similarity index 100% rename from l18n/docs-zh rename to translations/docs-zh From 06ef57fece05da808d62b0760f3138ea0f67494f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laurent=20Kemp=C3=A9?= Date: Fri, 5 Mar 2021 09:48:36 +0100 Subject: [PATCH 12/23] Update intellij.md Add missing " --- daprdocs/content/en/developing-applications/ides/intellij.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/developing-applications/ides/intellij.md b/daprdocs/content/en/developing-applications/ides/intellij.md index e7facc35f..4bba54732 100644 --- a/daprdocs/content/en/developing-applications/ides/intellij.md +++ b/daprdocs/content/en/developing-applications/ides/intellij.md @@ -71,7 +71,7 @@ Add a new `` entry: