From 2db803ea274a22726f8c418c7eacf1ea93eb88b1 Mon Sep 17 00:00:00 2001 From: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Date: Tue, 12 Jul 2022 16:12:01 -0500 Subject: [PATCH] update nav bar for v1.4 (#2641) * config toml Signed-off-by: Hannah Hunter * update navbar Signed-off-by: Hannah Hunter * links Signed-off-by: Hannah Hunter * one more link Signed-off-by: Hannah Hunter * links Signed-off-by: Hannah Hunter * link Signed-off-by: Hannah Hunter * link Signed-off-by: Hannah Hunter * jaeger link Signed-off-by: Hannah Hunter * ignore links Signed-off-by: Hannah Hunter * links and ignore links Signed-off-by: Hannah Hunter * ignore link Signed-off-by: Hannah Hunter * linksss Signed-off-by: Hannah Hunter * jetstream Signed-off-by: Hannah Hunter * remove non existent tutorial link Signed-off-by: Hannah Hunter * remove # Signed-off-by: Hannah Hunter Co-authored-by: greenie-msft <56556602+greenie-msft@users.noreply.github.com> --- daprdocs/config.toml | 15 ++++++++++++--- .../building-blocks/bindings/bindings-overview.md | 2 +- .../building-blocks/bindings/howto-bindings.md | 2 +- .../w3c-tracing/w3c-tracing-howto.md | 2 +- .../w3c-tracing/w3c-tracing-overview.md | 2 +- .../pubsub/howto-publish-subscribe.md | 2 +- .../building-blocks/pubsub/pubsub-overview.md | 2 +- .../building-blocks/secrets/howto-secrets.md | 2 +- .../service-invocation-overview.md | 4 ++-- .../state-management/state-management-overview.md | 2 +- .../debugging/bridge-to-kubernetes.md | 2 +- .../debugging/debug-k8s/debug-dapr-services.md | 2 +- .../debugging/debug-k8s/debug-daprd.md | 6 +++--- .../vscode-how-to-debug-multiple-dapr-apps.md | 4 ++-- .../ides/vscode/vscode-remote-dev-containers.md | 3 ++- .../en/developing-applications/middleware.md | 1 - .../operations/components/setup-pubsub/_index.md | 2 +- .../components/setup-pubsub/pubsub-namespaces.md | 4 ++-- .../operations/configuration/invoke-allowlist.md | 4 ++-- .../hosting/kubernetes/kubernetes-overview.md | 4 ++-- .../en/operations/monitoring/metrics/grafana.md | 4 ++-- .../operations/monitoring/metrics/prometheus.md | 5 +++-- .../open-telemetry-collector-appinsights.md | 4 ++-- .../tracing/open-telemetry-collector.md | 4 ++-- .../tracing/supported-tracing-backends/jaeger.md | 5 +++-- .../supported-tracing-backends/newrelic.md | 2 +- daprdocs/content/en/operations/security/oauth.md | 4 ++-- daprdocs/content/en/reference/api/pubsub_api.md | 2 +- .../supported-middleware/middleware-oauth2.md | 1 - .../supported-pubsub/setup-jetstream.md | 2 +- .../supported-pubsub/setup-nats-streaming.md | 2 +- 31 files changed, 56 insertions(+), 46 deletions(-) diff --git a/daprdocs/config.toml b/daprdocs/config.toml index 623603e9c..81236c2db 100644 --- a/daprdocs/config.toml +++ b/daprdocs/config.toml @@ -178,11 +178,20 @@ archived_version = true url_latest_version = "https://docs.dapr.io" [[params.versions]] - version = "v1.6 (preview)" + version = "v1.9 (preview)" + url = "https://v1-9.docs.dapr.io" +[[params.versions]] + version = "v1.8 (latest)" + url = "https://docs.dapr.io" +[[params.versions]] + version = "v1.7" + url = "https://v1-7.docs.dapr.io" +[[params.versions]] + version = "v1.6" url = "https://v1-6.docs.dapr.io" [[params.versions]] - version = "v1.5 (latest)" - url = "https://docs.dapr.io" + version = "v1.5" + url = "https://v1-5.docs.dapr.io" [[params.versions]] version = "v1.4" url = "https://v1-4.docs.dapr.io" diff --git a/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md b/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md index 21e3adfa0..29bdc9ad1 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/bindings/bindings-overview.md @@ -50,5 +50,5 @@ Read the [Use output bindings to interface with external resources]({{< ref howt * Follow these guides on: * [How-To: Trigger a service from different resources with input bindings]({{< ref howto-triggers.md >}}) * [How-To: Use output bindings to interface with external resources]({{< ref howto-bindings.md >}}) -* Try out the [bindings quickstart](https://github.com/dapr/quickstarts/tree/master/bindings/README.md) which shows how to bind to a Kafka queue +* Try out the [bindings tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/bindings) which shows how to bind to a Kafka queue * Read the [bindings API specification]({{< ref bindings_api.md >}}) diff --git a/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md b/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md index ea45ababf..adbf931e8 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md +++ b/daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md @@ -7,7 +7,7 @@ weight: 300 --- Output bindings enable you to invoke external resources without taking dependencies on special SDK or libraries. -For a complete sample showing output bindings, visit this [link](https://github.com/dapr/quickstarts/tree/master/bindings). +For a complete sample showing output bindings, visit this [link](https://github.com/dapr/quickstarts/tree/master/tutorials/bindings). Watch this [video](https://www.youtube.com/watch?v=ysklxm81MTs&feature=youtu.be&t=1960) on how to use bi-directional output bindings. diff --git a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md index 99f26ba18..0678114b7 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md +++ b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md @@ -294,4 +294,4 @@ You can now correlate the calls in your app and across services with Dapr using - [How To set up Application Insights for distributed tracing with OpenTelemetry]({{< ref open-telemetry-collector.md >}}) - [How to set up Zipkin for distributed tracing]({{< ref zipkin.md >}}) - [W3C trace context specification](https://www.w3.org/TR/trace-context/) -- [Observability quickstart](https://github.com/dapr/quickstarts/tree/master/observability) +- [Observability sample](https://github.com/dapr/quickstarts/tree/master/tutorials/observability) diff --git a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md index db89c0cd5..f0c488a50 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md @@ -108,4 +108,4 @@ In the gRPC API calls, trace context is passed through `grpc-trace-bin` header. - [How To set up Application Insights for distributed tracing with OpenTelemetry]({{< ref open-telemetry-collector.md >}}) - [How To set up Zipkin for distributed tracing]({{< ref zipkin.md >}}) - [W3C trace context specification](https://www.w3.org/TR/trace-context/) -- [Observability sample](https://github.com/dapr/quickstarts/tree/master/observability) +- [Observability sample](https://github.com/dapr/quickstarts/tree/master/tutorials/observability) 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 ca2c4289d..27c14498a 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 @@ -515,7 +515,7 @@ Invoke-RestMethod -Method Post -ContentType 'application/cloudevents+json' -Body ## Next steps -- Try the [Pub/Sub quickstart sample](https://github.com/dapr/quickstarts/tree/master/pub-sub) +- Try the [Pub/Sub tutorial sample](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub) - Learn about [PubSub routing]({{< ref howto-route-messages >}}) - Learn about [topic scoping]({{< ref pubsub-scopes.md >}}) - Learn about [message time-to-live]({{< ref pubsub-message-ttl.md >}}) diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-overview.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-overview.md index 3ab2b156a..3c639fb04 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-overview.md @@ -112,7 +112,7 @@ The publish/subscribe API is located in the [API reference]({{< ref pubsub_api.m * Follow these guides on: * [How-To: Publish a message and subscribe to a topic]({{< ref howto-publish-subscribe.md >}}) * [How-To: Configure Pub/Sub components with multiple namespaces]({{< ref pubsub-namespaces.md >}}) -* Try out the [Pub/Sub quickstart sample](https://github.com/dapr/quickstarts/tree/master/pub-sub) +* Try out the [Pub/Sub tutorial sample](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub) * Learn about [topic scoping]({{< ref pubsub-scopes.md >}}) * Learn about [message time-to-live (TTL)]({{< ref pubsub-message-ttl.md >}}) * Learn about [pubsub without CloudEvent]({{< ref pubsub-raw.md >}}) diff --git a/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md b/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md index 4ada756ba..216c24191 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md +++ b/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md @@ -179,4 +179,4 @@ $app->run(function(\Dapr\SecretManager $secretManager, \Psr\Log\LoggerInterface - [Configure a secret store]({{}}) - [Supported secrets]({{}}) - [Using secrets in components]({{}}) -- [Secret stores quickstart](https://github.com/dapr/quickstarts/tree/master/secretstore) +- [Secret stores tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/secretstore) diff --git a/daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md b/daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md index a4f22f543..32e93e2b5 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/service-invocation/service-invocation-overview.md @@ -109,7 +109,7 @@ Dapr allows users to keep their own proto services and work natively with gRPC. ## Example -Following the above call sequence, suppose you have the applications as described in the [hello world quickstart](https://github.com/dapr/quickstarts/blob/master/hello-world/README.md), where a python app invokes a node.js app. In such a scenario, the python app would be "Service A" , and a Node.js app would be "Service B". +Following the above call sequence, suppose you have the applications as described in the [hello world quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-world), where a python app invokes a node.js app. In such a scenario, the python app would be "Service A" , and a Node.js app would be "Service B". The diagram below shows sequence 1-7 again on a local machine showing the API calls: @@ -129,6 +129,6 @@ The diagram below shows sequence 1-7 again on a local machine showing the API ca - [How-to: Invoke services using HTTP]({{< ref howto-invoke-discover-services.md >}}) - [How-To: Configure Dapr to use gRPC]({{< ref grpc >}}) - [How-to: Invoke services using gRPC]({{< ref howto-invoke-services-grpc.md >}}) -- Try out the [hello world quickstart](https://github.com/dapr/quickstarts/blob/master/hello-world/README.md) which shows how to use HTTP service invocation or try the samples in the [Dapr SDKs]({{< ref sdks >}}) +- Try out the [hello world tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-world) which shows how to use HTTP service invocation or try the samples in the [Dapr SDKs]({{< ref sdks >}}) - Read the [service invocation API specification]({{< ref service_invocation_api.md >}}) - Understand the [service invocation performance]({{< ref perf-service-invocation.md >}}) numbers diff --git a/daprdocs/content/en/developing-applications/building-blocks/state-management/state-management-overview.md b/daprdocs/content/en/developing-applications/building-blocks/state-management/state-management-overview.md index 07a9af8b9..338428b8a 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/state-management/state-management-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/state-management/state-management-overview.md @@ -111,7 +111,7 @@ The API for state management can be found in the [state management API reference * [How-To: Build a stateful service]({{< ref howto-stateful-service.md >}}) * [How-To: Share state between applications]({{< ref howto-share-state.md >}}) * [How-To: Encrypt application state]({{< ref howto-encrypt-state.md >}}) -* Try out the [hello world quickstart](https://github.com/dapr/quickstarts/blob/master/hello-world/README.md) which shows how to use state management or try the samples in the [Dapr SDKs]({{< ref sdks >}}) +* Try out the [hello world tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-world) which shows how to use state management or try the samples in the [Dapr SDKs]({{< ref sdks >}}) * List of [state store components]({{< ref supported-state-stores.md >}}) * Read the [state management API reference]({{< ref state_api.md >}}) * Read the [actors API reference]({{< ref actors_api.md >}}) diff --git a/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md b/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md index fcecb016b..4f7bdc0a1 100644 --- a/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md +++ b/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md @@ -12,7 +12,7 @@ Bridge to Kubernetes allows you to run and debug code on your development comput ## Debug Dapr apps -Bridge to Kubernetes supports debugging Dapr apps on your machine, while still having them interact with the services and applications running on your Kubernetes cluster. This example showcases Bridge to Kubernetes enabling a developer to debug the [distributed calculator quickstart](https://github.com/dapr/quickstarts/tree/master/distributed-calculator): +Bridge to Kubernetes supports debugging Dapr apps on your machine, while still having them interact with the services and applications running on your Kubernetes cluster. This example showcases Bridge to Kubernetes enabling a developer to debug the [distributed calculator quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/distributed-calculator):
diff --git a/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md b/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md index 17f71eab5..893376e97 100644 --- a/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md +++ b/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md @@ -111,4 +111,4 @@ All done. Now you can point to port 40000 and start a remote debug session from - [Overview of Dapr on Kubernetes]({{< ref kubernetes-overview >}}) - [Deploy Dapr to a Kubernetes cluster]({{< ref kubernetes-deploy >}}) -- [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes) +- [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) diff --git a/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-daprd.md b/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-daprd.md index ac38d8257..3b13efc5a 100644 --- a/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-daprd.md +++ b/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-daprd.md @@ -42,7 +42,7 @@ Then step into 'dapr' directory from your cloned [dapr/dapr repository](https:// helm install dapr charts/dapr --namespace dapr-system --values values.yml --wait ``` -To enable debug mode for daprd, you need to put an extra annotation `dapr.io/enable-debug` in your application's deployment file. Let's use [quickstarts/hello-kubernetes](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes) as an example. Modify 'deploy/node.yaml' like below: +To enable debug mode for daprd, you need to put an extra annotation `dapr.io/enable-debug` in your application's deployment file. Let's use [quickstarts/hello-kubernetes](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) as an example. Modify 'deploy/node.yaml' like below: ```diff diff --git a/hello-kubernetes/deploy/node.yaml b/hello-kubernetes/deploy/node.yaml @@ -61,7 +61,7 @@ index 23185a6..6cdb0ae 100644 The annotation `dapr.io/enable-debug` will hint Dapr injector to inject Dapr sidecar into the debug mode. You can also specify the debug port with annotation `dapr.io/debug-port`, otherwise the default port will be "40000". -Deploy the application with the following command. For the complete guide refer to the [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes): +Deploy the application with the following command. For the complete guide refer to the [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes): ```bash kubectl apply -f ./deploy/node.yaml @@ -92,4 +92,4 @@ All done. Now you can point to port 40000 and start a remote debug session to da - [Overview of Dapr on Kubernetes]({{< ref kubernetes-overview >}}) - [Deploy Dapr to a Kubernetes cluster]({{< ref kubernetes-deploy >}}) - [Debug Dapr services on Kubernetes]({{< ref debug-dapr-services >}}) -- [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes) \ No newline at end of file +- [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) \ No newline at end of file diff --git a/daprdocs/content/en/developing-applications/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md b/daprdocs/content/en/developing-applications/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md index 92451972b..2972a29dd 100644 --- a/daprdocs/content/en/developing-applications/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md +++ b/daprdocs/content/en/developing-applications/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md @@ -18,12 +18,12 @@ dapr run --app-id nodeapp --app-port 3000 --dapr-http-port 3500 app.js One approach to attaching the debugger to your service is to first run daprd with the correct arguments from the command line and then launch your code and attach the debugger. While this is a perfectly acceptable solution, it does require a few extra steps and some instruction to developers who might want to clone your repo and hit the "play" button to begin debugging. -If your application is a collection of microservices, each with a Dapr sidecar, it will be useful to debug them together in Visual Studio Code. This page will use the [hello world quickstart](https://github.com/dapr/quickstarts/tree/master/hello-world) to showcase how to configure VSCode to debug multiple Dapr application using [VSCode debugging](https://code.visualstudio.com/Docs/editor/debugging). +If your application is a collection of microservices, each with a Dapr sidecar, it will be useful to debug them together in Visual Studio Code. This page will use the [hello world quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-world) to showcase how to configure VSCode to debug multiple Dapr application using [VSCode debugging](https://code.visualstudio.com/Docs/editor/debugging). ## Prerequisites - Install the [Dapr extension]({{< ref vscode-dapr-extension.md >}}). You will be using the [tasks](https://code.visualstudio.com/docs/editor/tasks) it offers later on. -- Optionally clone the [hello world quickstart](https://github.com/dapr/quickstarts/tree/master/hello-world) +- Optionally clone the [hello world quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-world) ## Step 1: Configure launch.json diff --git a/daprdocs/content/en/developing-applications/ides/vscode/vscode-remote-dev-containers.md b/daprdocs/content/en/developing-applications/ides/vscode/vscode-remote-dev-containers.md index aaf6a583c..b29ce6618 100644 --- a/daprdocs/content/en/developing-applications/ides/vscode/vscode-remote-dev-containers.md +++ b/daprdocs/content/en/developing-applications/ides/vscode/vscode-remote-dev-containers.md @@ -13,10 +13,11 @@ Dapr has pre-built Docker remote containers for NodeJS and C#. You can pick the ### Setup a remote dev container #### Prerequisites + - [Docker Desktop](https://www.docker.com/products/docker-desktop) - [Visual Studio Code](https://code.visualstudio.com/) - [VSCode Remote Development extension pack](https://aka.ms/vscode-remote/download/extension) - + #### Create remote Dapr container 1. Open your application workspace in VS Code 2. In the command command palette (`CTRL+SHIFT+P`) type and select `Remote-Containers: Add Development Container Configuration Files...` diff --git a/daprdocs/content/en/developing-applications/middleware.md b/daprdocs/content/en/developing-applications/middleware.md index a48ceac16..7898aaf6f 100644 --- a/daprdocs/content/en/developing-applications/middleware.md +++ b/daprdocs/content/en/developing-applications/middleware.md @@ -74,4 +74,3 @@ After the components-contrib change has been accepted, submit another pull reque * [Component schema]({{< ref component-schema.md >}}) * [Configuration overview]({{< ref configuration-overview.md >}}) -* [Middleware quickstart](https://github.com/dapr/quickstarts/tree/master/middleware) diff --git a/daprdocs/content/en/operations/components/setup-pubsub/_index.md b/daprdocs/content/en/operations/components/setup-pubsub/_index.md index dbb53fd6b..37ff093b1 100644 --- a/daprdocs/content/en/operations/components/setup-pubsub/_index.md +++ b/daprdocs/content/en/operations/components/setup-pubsub/_index.md @@ -47,7 +47,7 @@ Visit [this guide]({{< ref "howto-publish-subscribe.md#step-3-publish-a-topic" > ## Related links - Overview of the Dapr [Pub/Sub building block]({{< ref pubsub-overview.md >}}) -- Try the [Pub/Sub quickstart sample](https://github.com/dapr/quickstarts/tree/master/pub-sub) +- Try the [Pub/Sub tutorial sample](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub) - Read the [guide on publishing and subscribing]({{< ref howto-publish-subscribe.md >}}) - Learn about [topic scoping]({{< ref pubsub-scopes.md >}}) - Learn about [message time-to-live]({{< ref pubsub-message-ttl.md >}}) 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 b70fc73ba..809451b42 100644 --- a/daprdocs/content/en/operations/components/setup-pubsub/pubsub-namespaces.md +++ b/daprdocs/content/en/operations/components/setup-pubsub/pubsub-namespaces.md @@ -12,7 +12,7 @@ In some scenarios, applications can be spread across namespaces and share a queu Namespaces are a Dapr concept used for scoping applications and components. This example uses Kubernetes namespaces, however the Dapr component namespace scoping can be used on any supported platform. Read [How-To: Scope components to one or more applications]({{< ref "component-scopes.md" >}}) for more information on scoping components. {{% /alert %}} -This example uses the [PubSub sample](https://github.com/dapr/quickstarts/tree/master/pub-sub). The Redis installation and the subscribers are in `namespace-a` while the publisher UI is in `namespace-b`. This solution will also work if Redis is installed on another namespace or if you use a managed cloud service like Azure ServiceBus, AWS SNS/SQS or GCP PubSub. +This example uses the [PubSub sample](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub). The Redis installation and the subscribers are in `namespace-a` while the publisher UI is in `namespace-b`. This solution will also work if Redis is installed on another namespace or if you use a managed cloud service like Azure ServiceBus, AWS SNS/SQS or GCP PubSub. This is a diagram of the example using namespaces. @@ -33,7 +33,7 @@ The table below shows which resources are deployed to which namespaces: ## Pre-requisites * [Dapr installed on Kubernetes]({{< ref "kubernetes-deploy.md" >}}) in any namespace since Dapr works at the cluster level. -* Checkout and cd into the directory for [PubSub quickstart](https://github.com/dapr/quickstarts/tree/master/pub-sub). +* Checkout and cd into the directory for [PubSub tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub). ## Setup `namespace-a` diff --git a/daprdocs/content/en/operations/configuration/invoke-allowlist.md b/daprdocs/content/en/operations/configuration/invoke-allowlist.md index 288e3e5fd..c8227a09a 100644 --- a/daprdocs/content/en/operations/configuration/invoke-allowlist.md +++ b/daprdocs/content/en/operations/configuration/invoke-allowlist.md @@ -235,7 +235,7 @@ spec: ``` ### Self-hosted mode -This example uses the [hello world](https://github.com/dapr/quickstarts/tree/master/hello-world/README.md) quickstart. +This example uses the [hello world](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-world) tutorial. The following steps run the Sentry service locally with mTLS enabled, set up necessary environment variables to access certificates, and then launch both the node app and python app each referencing the Sentry service to apply the ACLs. @@ -318,7 +318,7 @@ The following steps run the Sentry service locally with mTLS enabled, set up nec 8. You should see the calls to the node app fail in the python app command prompt based due to the **deny** operation action in the nodeappconfig file. Change this action to **allow** and re-run the apps and you should then see this call succeed. ### Kubernetes mode -This example uses the [hello kubernetes](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes/README.md) quickstart. +This example uses the [hello kubernetes](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) tutorial. You can create and apply the above configuration files `nodeappconfig.yaml` and `pythonappconfig.yaml` as described in the [configuration]({{< ref "configuration-concept.md" >}}) to the Kubernetes deployments. diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md index 9199021a4..d42886f09 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md @@ -43,7 +43,7 @@ For information about pulling your application images from a private registry, r ## Quickstart -You can see some examples [here](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes) in the Kubernetes getting started quickstart. +You can see some examples [here](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) in the Kubernetes getting started tutorial. ## Supported versions Dapr support for Kubernetes is aligned with [Kubernetes Version Skew Policy](https://kubernetes.io/releases/version-skew-policy). @@ -53,5 +53,5 @@ Dapr support for Kubernetes is aligned with [Kubernetes Version Skew Policy](htt - [Deploy Dapr to a Kubernetes cluster]({{< ref kubernetes-deploy >}}) - [Upgrade Dapr on a Kubernetes cluster]({{< ref kubernetes-upgrade >}}) - [Production guidelines for Dapr on Kubernetes]({{< ref kubernetes-production.md >}}) -- [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes) +- [Dapr Kubernetes tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) - [Use Bridge to Kubernetes to debug Dapr apps locally, while connected to your Kubernetes cluster]({{< ref bridge-to-kubernetes >}}) diff --git a/daprdocs/content/en/operations/monitoring/metrics/grafana.md b/daprdocs/content/en/operations/monitoring/metrics/grafana.md index 509adb3b3..1e3550cd0 100644 --- a/daprdocs/content/en/operations/monitoring/metrics/grafana.md +++ b/daprdocs/content/en/operations/monitoring/metrics/grafana.md @@ -165,13 +165,13 @@ First you need to connect Prometheus as a data source to Grafana. {{% /alert %}} ## References - + * [Dapr Observability]({{}}) * [Prometheus Installation](https://github.com/prometheus-community/helm-charts) * [Prometheus on Kubernetes](https://github.com/coreos/kube-prometheus) * [Prometheus Query Language](https://prometheus.io/docs/prometheus/latest/querying/basics/) * [Supported Dapr metrics](https://github.com/dapr/dapr/blob/master/docs/development/dapr-metrics.md) - + ## Example
diff --git a/daprdocs/content/en/operations/monitoring/metrics/prometheus.md b/daprdocs/content/en/operations/monitoring/metrics/prometheus.md index b179b75a0..b519e4906 100644 --- a/daprdocs/content/en/operations/monitoring/metrics/prometheus.md +++ b/daprdocs/content/en/operations/monitoring/metrics/prometheus.md @@ -117,6 +117,7 @@ dapr-prom-prometheus-server-694fd8d7c-q5d59 2/2 Running 0
## References - + * [Prometheus Installation](https://github.com/prometheus-community/helm-charts) -* [Prometheus Query Language](https://prometheus.io/docs/prometheus/latest/querying/basics/) \ No newline at end of file +* [Prometheus Query Language](https://prometheus.io/docs/prometheus/latest/querying/basics/) + diff --git a/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector-appinsights.md b/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector-appinsights.md index 080742e05..f70152572 100644 --- a/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector-appinsights.md +++ b/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector-appinsights.md @@ -55,7 +55,7 @@ spec: dapr.io/config: "appconfig" ``` -Some of the quickstarts such as [distributed calculator](https://github.com/dapr/quickstarts/tree/master/distributed-calculator) already configure these settings, so if you are using those no additional settings are needed. +Some of the tutorials such as [distributed calculator](https://github.com/dapr/quickstarts/tree/master/tutorials/distributed-calculator) already configure these settings, so if you are using those no additional settings are needed. That's it! There's no need include any SDKs or instrument your application code. Dapr automatically handles the distributed tracing for you. @@ -68,5 +68,5 @@ Deploy and run some applications. After a few minutes, you should see tracing lo > **NOTE**: Only operations going through Dapr API exposed by Dapr sidecar (e.g. service invocation or event publishing) are displayed in Application Map topology. ## Related links -* Try out the [observability quickstart](https://github.com/dapr/quickstarts/tree/master/observability/README.md) +* Try out the [observability quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/observability) * How to set [tracing configuration options]({{< ref "configuration-overview.md#tracing" >}}) diff --git a/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector.md b/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector.md index e3bc96f05..8b1736486 100644 --- a/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector.md +++ b/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector.md @@ -57,7 +57,7 @@ spec: dapr.io/config: "appconfig" ``` -Some of the quickstarts such as [distributed calculator](https://github.com/dapr/quickstarts/tree/master/distributed-calculator) already configure these settings, so if you are using those no additional settings are needed. +Some of the tutorials such as [distributed calculator](https://github.com/dapr/quickstarts/tree/master/tutorials/distributed-calculator) already configure these settings, so if you are using those no additional settings are needed. That's it! There's no need include any SDKs or instrument your application code. Dapr automatically handles the distributed tracing for you. @@ -66,6 +66,6 @@ That's it! There's no need include any SDKs or instrument your application code. Deploy and run some applications. Wait for the trace to propagate to your tracing backend and view them there. ## Related links -* Try out the [observability quickstart](https://github.com/dapr/quickstarts/tree/master/observability/README.md) +* Try out the [observability quickstart](https://github.com/dapr/quickstarts/tree/master/tutorials/observability) * How to set [tracing configuration options]({{< ref "configuration-overview.md#tracing" >}}) diff --git a/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/jaeger.md b/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/jaeger.md index 44a453649..02d43f71f 100644 --- a/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/jaeger.md +++ b/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/jaeger.md @@ -83,8 +83,9 @@ spec: #### Production -Jaeger uses Elasticsearch as the backend storage, and you can create a secret in k8s cluster to access Elasticsearch server with access control. See [Configuring and Deploying Jaeger](https://docs.openshift.com/container-platform/4.7/jaeger/jaeger_install/rhbjaeger-deploying.html) - + +Jaeger uses Elasticsearch as the backend storage, and you can create a secret in k8s cluster to access Elasticsearch server with access control. See [Configuring and Deploying Jaeger](https://access.redhat.com/documentation/en-us/openshift_container_platform/4.5/html/jaeger/jaeger-deploy-production_jaeger-deploying#:~:text=Create%20a%20custom%20resource%20file%20named%20jaeger-production.yaml%20that,Jaeger%3A%20%24%20oc%20create%20-n%20jaeger-system%20-f%20jaeger-production.yaml) + ```shell kubectl create secret generic jaeger-secret --from-literal=ES_PASSWORD='xxx' --from-literal=ES_USERNAME='xxx' -n ${NAMESPACE} ``` diff --git a/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md b/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md index 9b98303d1..96922a300 100644 --- a/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md +++ b/daprdocs/content/en/operations/monitoring/tracing/supported-tracing-backends/newrelic.md @@ -12,7 +12,7 @@ description: "Set-up New Relic for distributed tracing" ## Configure Dapr tracing -Dapr natively captures metrics and traces that can be send directly to New Relic. The easiest way to export these is by configuring Dapr to send the traces to [New Relic's Trace API](https://docs.newrelic.com/docs/distributed-tracing/trace-api/report-zipkin-format-traces-trace-api/) using the Zipkin trace format. +Dapr natively captures metrics and traces that can be send directly to New Relic. The easiest way to export these is by configuring Dapr to send the traces to [New Relic's Trace API](https://docs.newrelic.com/docs/distributed-tracing/trace-api/report-zipkin-format-traces-trace-api#existing-zipkin) using the Zipkin trace format. In order for the integration to send data to New Relic [Telemetry Data Platform](https://newrelic.com/platform/telemetry-data-platform), you need a [New Relic Insights Insert API key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#insights-insert-key). diff --git a/daprdocs/content/en/operations/security/oauth.md b/daprdocs/content/en/operations/security/oauth.md index 637fa1eac..852021dc2 100644 --- a/daprdocs/content/en/operations/security/oauth.md +++ b/daprdocs/content/en/operations/security/oauth.md @@ -33,14 +33,14 @@ To figure the Dapr OAuth middleware, you'll need to collect the following inform * Token URL Authorization/Token URLs of some of the popular authorization servers: - + | Server | Authorization URL | Token URL | |---------|-------------------|-----------| |Azure AAD||| |GitHub||| |Google|| | |Twitter||| - + ## Define the middleware component definition ### Define an Authorization Code Grant component diff --git a/daprdocs/content/en/reference/api/pubsub_api.md b/daprdocs/content/en/reference/api/pubsub_api.md index eed507d1a..3ef20486f 100644 --- a/daprdocs/content/en/reference/api/pubsub_api.md +++ b/daprdocs/content/en/reference/api/pubsub_api.md @@ -168,4 +168,4 @@ Dapr Pub/Sub adheres to version 1.0 of CloudEvents. ## Related links * [How to publish to and consume topics]({{< ref howto-publish-subscribe.md >}}) -* [Sample for pub/sub](https://github.com/dapr/quickstarts/tree/master/pub-sub) +* [Sample for pub/sub](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub) diff --git a/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md b/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md index 7097835a1..8baaf888c 100644 --- a/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md +++ b/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md @@ -74,7 +74,6 @@ spec: ## Related links - [Configure API authorization with OAuth]({{< ref oauth >}}) -- [Middleware OAuth quickstart](https://github.com/dapr/quickstarts/tree/master/middleware) - [Middleware]({{< ref middleware.md >}}) - [Configuration concept]({{< ref configuration-concept.md >}}) - [Configuration overview]({{< ref configuration-overview.md >}}) diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-jetstream.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-jetstream.md index 61e4711cb..791a2f02b 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-jetstream.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-jetstream.md @@ -86,7 +86,7 @@ with NATS, find the service with: `kubectl get svc my-nats`. - [Basic schema for a Dapr component]({{< ref component-schema >}}) - Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components - [Pub/Sub building block]({{< ref pubsub >}}) -- [JetStream Documentation](https://docs.nats.io/jetstream/jetstream) +- [JetStream Documentation](https://docs.nats.io/nats-concepts/jetstream) - [NATS CLI](https://github.com/nats-io/natscli) diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md index 38c281b4f..22a6ef373 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md @@ -92,7 +92,7 @@ You can then interact with the server using the client port: `localhost:4222`. {{% /codetab %}} {{% codetab %}} -Install NATS on Kubernetes by using the [kubectl](https://docs.nats.io/nats-on-kubernetes/minimal-setup): +Install NATS on Kubernetes by using the [kubectl](https://docs.nats.io/running-a-nats-service/nats-kubernetes): ```bash # Single server NATS