mirror of https://github.com/dapr/dotnet-sdk.git
Update markdown files for Hugo upgrade
Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
This commit is contained in:
Marc Duiker
parent
e3efbad010
commit
4bd5fffddd
|
|
@ -65,7 +65,7 @@ Dapr .NET SDK packages and extensions. When writing new and updated samples keep
|
|||
|
||||
- All examples should be runnable on Windows, Linux, and MacOS. While .NET Core code is consistent among operating
|
||||
systems, any pre/post example commands should provide options through
|
||||
[codetabs]({{< ref "contributing-docs.md#tabbed-content" >}})
|
||||
[tabpane]({{% ref "contributing-docs.md#tabbed-content" %}})
|
||||
- Contain steps to download/install any required pre-requisites. Someone coming in with a fresh OS install should be
|
||||
able to start on the example and complete it without an error. Links to external download pages are fine.
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ The `daprdocs` directory contains the markdown files that are rendered into the
|
|||
documentation website is built this repo is cloned and configured so that its contents are rendered with the docs
|
||||
content. When writing docs keep in mind:
|
||||
|
||||
- All rules in the [docs guide]({{< ref contributing-docs.md >}}) should be followed in addition to these.
|
||||
- All rules in the [docs guide]({{% ref contributing-docs.md %}}) should be followed in addition to these.
|
||||
- All files and directories should be prefixed with `dotnet-` to ensure all file/directory names are globally
|
||||
- unique across all Dapr documentation.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ Dapr offers a variety of packages to help with the development of .NET applicati
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed
|
||||
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}})
|
||||
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed
|
||||
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}})
|
||||
- [.NET 6](https://dotnet.microsoft.com/download), [.NET 8](https://dotnet.microsoft.com/download) or [.NET 9](https://dotnet.microsoft.com/download) installed
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
|
|
@ -42,7 +42,7 @@ Put the Dapr .NET SDK to the test. Walk through the .NET quickstarts and tutoria
|
|||
|
||||
| SDK samples | Description |
|
||||
| ----------- | ----------- |
|
||||
| [Quickstarts]({{< ref quickstarts >}}) | Experience Dapr's API building blocks in just a few minutes using the .NET SDK. |
|
||||
| [Quickstarts]({{% ref quickstarts %}}) | Experience Dapr's API building blocks in just a few minutes using the .NET SDK. |
|
||||
| [SDK samples](https://github.com/dapr/dotnet-sdk/tree/master/examples) | Clone the SDK repo to try out some examples and get started. |
|
||||
| [Pub/sub tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub) | See how Dapr .NET SDK works alongside other Dapr SDKs to enable pub/sub applications. |
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ Put the Dapr .NET SDK to the test. Walk through the .NET quickstarts and tutoria
|
|||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Client</b></h5>
|
||||
<p class="card-text">Create .NET clients that interact with a Dapr sidecar and other Dapr applications.</p>
|
||||
<a href="{{< ref dotnet-client >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref dotnet-client %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
|
|
@ -67,28 +67,28 @@ Put the Dapr .NET SDK to the test. Walk through the .NET quickstarts and tutoria
|
|||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Actors</b></h5>
|
||||
<p class="card-text">Create virtual actors with state, reminders/timers, and methods in .NET.</p>
|
||||
<a href="{{< ref dotnet-actors >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref dotnet-actors %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Workflow</b></h5>
|
||||
<p class="card-text">Create and manage workflows that work with other Dapr APIs in .NET.</p>
|
||||
<a href="{{< ref dotnet-workflow >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref dotnet-workflow %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Jobs</b></h5>
|
||||
<p class="card-text">Create and manage the scheduling and orchestration of jobs in .NET.</p>
|
||||
<a href="{{< ref dotnet-jobs >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref dotnet-jobs %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title"><b>AI</b></h5>
|
||||
<p class="card-text">Create and manage AI operations in .NET</p>
|
||||
<a href="{{< ref dotnet-ai >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref dotnet-ai %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -102,7 +102,7 @@ Learn more about local development options, or browse NuGet packages to add to y
|
|||
<div class="card-body">
|
||||
<h5 class="card-title"><b>Development</b></h5>
|
||||
<p class="card-text">Learn about local development options for .NET Dapr applications</p>
|
||||
<a href="{{< ref dotnet-development >}}" class="stretched-link"></a>
|
||||
<a href="{{% ref dotnet-development %}}" class="stretched-link"></a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@ description: Get up and running with the Dapr actors .NET SDK
|
|||
|
||||
With the Dapr actor package, you can interact with Dapr virtual actors from a .NET application.
|
||||
|
||||
To get started, walk through the [Dapr actors]({{< ref dotnet-actors-howto.md >}}) how-to guide.
|
||||
To get started, walk through the [Dapr actors]({{% ref dotnet-actors-howto.md %}}) how-to guide.
|
||||
|
|
@ -111,4 +111,4 @@ Dapr.Actors.ActorMethodInvocationException: Remote Actor Method Exception, DETAI
|
|||
|
||||
## Next steps
|
||||
|
||||
[Learn how to author and run actors with `ActorHost`]({{< ref dotnet-actors-usage.md >}}).
|
||||
[Learn how to author and run actors with `ActorHost`]({{% ref dotnet-actors-usage.md %}}).
|
||||
|
|
@ -43,8 +43,8 @@ This project contains the implementation of the actor client which calls MyActor
|
|||
|
||||
## Prerequisites
|
||||
|
||||
- [Dapr CLI]({{< ref install-dapr-cli.md >}}) installed.
|
||||
- Initialized [Dapr environment]({{< ref install-dapr-selfhost.md >}}).
|
||||
- [Dapr CLI]({{% ref install-dapr-cli.md %}}) installed.
|
||||
- Initialized [Dapr environment]({{% ref install-dapr-selfhost.md %}}).
|
||||
- [.NET 6](https://dotnet.microsoft.com/download), [.NET 8](https://dotnet.microsoft.com/download) or [.NET 9](https://dotnet.microsoft.com/download) installed
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
|
|
@ -472,5 +472,5 @@ Now you have successfully created an actor service and client. See the related l
|
|||
|
||||
## Related links
|
||||
|
||||
- [.NET Dapr Actors client guide]({{< ref dotnet-actors-client.md >}})
|
||||
- [.NET Dapr Actors usage guide]({{< ref dotnet-actors-usage.md >}})
|
||||
- [.NET Dapr Actors client guide]({{% ref dotnet-actors-client.md %}})
|
||||
- [.NET Dapr Actors usage guide]({{% ref dotnet-actors-usage.md %}})
|
||||
|
|
|
|||
|
|
@ -241,4 +241,4 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
|
|||
|
||||
## Next steps
|
||||
|
||||
Try the [Running and using virtual actors example]({{< ref dotnet-actors-howto.md >}}).
|
||||
Try the [Running and using virtual actors example]({{% ref dotnet-actors-howto.md %}}).
|
||||
|
|
@ -9,4 +9,4 @@ description: Get up and running with the Dapr AI .NET SDK
|
|||
With the Dapr AI package, you can interact with the Dapr AI workloads from a .NET application.
|
||||
|
||||
Today, Dapr provides the Conversational API to engage with large language models. To get started with this workload,
|
||||
walk through the [Dapr Conversational AI]({{< ref dotnet-ai-conversation-howto.md >}}) how-to guide.
|
||||
walk through the [Dapr Conversational AI]({{% ref dotnet-ai-conversation-howto.md %}}) how-to guide.
|
||||
|
|
@ -71,7 +71,7 @@ var daprConversationClient = new DaprConversationClientBuilder()
|
|||
.Build();
|
||||
```
|
||||
|
||||
See the .NET [documentation here]({{< ref dotnet-client >}}) for more information about the options available when configuring the Dapr client via the builder.
|
||||
See the .NET [documentation here]({{% ref dotnet-client %}}) for more information about the options available when configuring the Dapr client via the builder.
|
||||
|
||||
## Try it out
|
||||
Put the Dapr AI .NET SDK to the test. Walk through the samples to see Dapr in action:
|
||||
|
|
|
|||
|
|
@ -10,14 +10,14 @@ no_list: true
|
|||
The Dapr client package allows you to interact with other Dapr applications from a .NET application.
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
If you haven't already, [try out one of the quickstarts]({{< ref quickstarts >}}) for a quick walk-through on how to use the Dapr .NET SDK with an API building block.
|
||||
If you haven't already, [try out one of the quickstarts]({{% ref quickstarts %}}) for a quick walk-through on how to use the Dapr .NET SDK with an API building block.
|
||||
|
||||
{{% /alert %}}
|
||||
|
||||
|
||||
## Building blocks
|
||||
|
||||
The .NET SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}).
|
||||
The .NET SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}).
|
||||
|
||||
### Invoke a service
|
||||
|
||||
|
|
@ -25,14 +25,14 @@ The .NET SDK allows you to interface with all of the [Dapr building blocks]({{<
|
|||
You can either use the `DaprClient` or `System.Net.Http.HttpClient` to invoke your services.
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
You can also [invoke a non-Dapr endpoint using either a named `HTTPEndpoint` or an FQDN URL to the non-Dapr environment]({{< ref "howto-invoke-non-dapr-endpoints.md#using-an-httpendpoint-resource-or-fqdn-url-for-non-dapr-endpoints" >}}).
|
||||
You can also [invoke a non-Dapr endpoint using either a named `HTTPEndpoint` or an FQDN URL to the non-Dapr environment]({{% ref "howto-invoke-non-dapr-endpoints.md#using-an-httpendpoint-resource-or-fqdn-url-for-non-dapr-endpoints" %}}).
|
||||
|
||||
{{% /alert %}}
|
||||
|
||||
|
||||
{{< tabs SDK HTTP>}}
|
||||
{{< tabpane text=true >}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="SDK" %}}
|
||||
```csharp
|
||||
using var client = new DaprClientBuilder().
|
||||
UseTimeout(TimeSpan.FromSeconds(2)). // Optionally, set a timeout
|
||||
|
|
@ -43,9 +43,9 @@ var data = new { id = "17", amount = 99m };
|
|||
var account = await client.InvokeMethodAsync<object, Account>("routing", "deposit", data, cancellationToken);
|
||||
Console.WriteLine("Returned: id:{0} | Balance:{1}", account.Id, account.Balance);
|
||||
```
|
||||
{{% /codetab %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="HTTP" %}}
|
||||
```csharp
|
||||
var client = DaprClient.CreateInvokeHttpClient(appId: "routing");
|
||||
|
||||
|
|
@ -57,8 +57,8 @@ var response = await client.PostAsJsonAsync("/deposit", deposit, cancellationTok
|
|||
var account = await response.Content.ReadFromJsonAsync<Account>(cancellationToken: cancellationToken);
|
||||
Console.WriteLine("Returned: id:{0} | Balance:{1}", account.Id, account.Balance);
|
||||
```
|
||||
{{% /codetab %}}
|
||||
{{< /tabs >}}
|
||||
{{% /tab %}}
|
||||
{{< /tabpane >}}
|
||||
|
||||
#### gRPC
|
||||
You can use the `DaprClient` to invoke your services over gRPC.
|
||||
|
|
@ -74,7 +74,7 @@ await client.MyMethodAsync(new Empty(), options);
|
|||
Assert.Equal(StatusCode.DeadlineExceeded, ex.StatusCode);
|
||||
```
|
||||
|
||||
- For a full guide on service invocation visit [How-To: Invoke a service]({{< ref howto-invoke-discover-services.md >}}).
|
||||
- For a full guide on service invocation visit [How-To: Invoke a service]({{% ref howto-invoke-discover-services.md %}}).
|
||||
|
||||
### Save & get application state
|
||||
|
||||
|
|
@ -117,7 +117,7 @@ foreach (var account in queryResponse.Results)
|
|||
}
|
||||
```
|
||||
|
||||
- For a full list of state operations visit [How-To: Get & save state]({{< ref howto-get-save-state.md >}}).
|
||||
- For a full list of state operations visit [How-To: Get & save state]({{% ref howto-get-save-state.md %}}).
|
||||
|
||||
### Publish messages
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ await client.PublishEventAsync(pubsubName, "deposit", eventData, cancellationTok
|
|||
Console.WriteLine("Published deposit event!");
|
||||
```
|
||||
|
||||
- For a full list of state operations visit [How-To: Publish & subscribe]({{< ref howto-publish-subscribe.md >}}).
|
||||
- For a full list of state operations visit [How-To: Publish & subscribe]({{% ref howto-publish-subscribe.md %}}).
|
||||
- Visit [.NET SDK examples](https://github.com/dapr/dotnet-sdk/tree/master/examples/Client/PublishSubscribe) for code samples and instructions to try out pub/sub
|
||||
|
||||
### Interact with output bindings
|
||||
|
|
@ -150,13 +150,13 @@ var email = new
|
|||
await client.InvokeBindingAsync("send-email", "create", email);
|
||||
```
|
||||
|
||||
- For a full guide on output bindings visit [How-To: Use bindings]({{< ref howto-bindings.md >}}).
|
||||
- For a full guide on output bindings visit [How-To: Use bindings]({{% ref howto-bindings.md %}}).
|
||||
|
||||
### Retrieve secrets
|
||||
|
||||
{{< tabs Multi-value-secret Single-value-secret >}}
|
||||
{{< tabpane text=true >}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="Multi-value-secret" %}}
|
||||
|
||||
```csharp
|
||||
var client = new DaprClientBuilder().Build();
|
||||
|
|
@ -166,9 +166,9 @@ var secrets = await client.GetSecretAsync("mysecretstore", "key-value-pair-secre
|
|||
Console.WriteLine($"Got secret keys: {string.Join(", ", secrets.Keys)}");
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="Single-value-secret" %}}
|
||||
|
||||
```csharp
|
||||
var client = new DaprClientBuilder().Build();
|
||||
|
|
@ -184,11 +184,11 @@ var value = data["single-value-secret"]
|
|||
Console.WriteLine("Got a secret value, I'm not going to be print it, it's a secret!");
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
{{< /tabpane >}}
|
||||
|
||||
- For a full guide on secrets visit [How-To: Retrieve secrets]({{< ref howto-secrets.md >}}).
|
||||
- For a full guide on secrets visit [How-To: Retrieve secrets]({{% ref howto-secrets.md %}}).
|
||||
|
||||
### Get Configuration Keys
|
||||
```csharp
|
||||
|
|
|
|||
|
|
@ -8,14 +8,14 @@ description: Learn about local development with the Dapr CLI
|
|||
|
||||
## Dapr CLI
|
||||
|
||||
*Consider this to be a .NET companion to the [Dapr Self-Hosted with Docker Guide]({{< ref self-hosted-with-docker.md >}})*.
|
||||
*Consider this to be a .NET companion to the [Dapr Self-Hosted with Docker Guide]({{% ref self-hosted-with-docker.md %}})*.
|
||||
|
||||
The Dapr CLI provides you with a good base to work from by initializing a local redis container, zipkin container, the placement service, and component manifests for redis. This will enable you to work with the following building blocks on a fresh install with no additional setup:
|
||||
|
||||
- [Service invocation]({{< ref service-invocation >}})
|
||||
- [State Store]({{< ref state-management >}})
|
||||
- [Pub/Sub]({{< ref pubsub >}})
|
||||
- [Actors]({{< ref actors >}})
|
||||
- [Service invocation]({{% ref service-invocation %}})
|
||||
- [State Store]({{% ref state-management %}})
|
||||
- [Pub/Sub]({{% ref pubsub %}})
|
||||
- [Actors]({{% ref actors %}})
|
||||
|
||||
You can run .NET services with `dapr run` as your strategy for developing locally. Plan on running one of these commands per-service in order to launch your application.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ description: Learn about local development with Docker-Compose
|
|||
|
||||
## Docker-Compose
|
||||
|
||||
*Consider this to be a .NET companion to the [Dapr Self-Hosted with Docker Guide]({{< ref self-hosted-with-docker.md >}})*.
|
||||
*Consider this to be a .NET companion to the [Dapr Self-Hosted with Docker Guide]({{% ref self-hosted-with-docker.md %}})*.
|
||||
|
||||
`docker-compose` is a CLI tool included with Docker Desktop that you can use to run multiple containers at a time. It is a way to automate the lifecycle of multiple containers together, and offers a development experience similar to a production environment for applications targeting Kubernetes.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,5 +9,5 @@ description: Get up and running with Dapr Jobs and the Dapr .NET SDK
|
|||
With the Dapr Job package, you can interact with the Dapr Job APIs from a .NET application to trigger future operations
|
||||
to run according to a predefined schedule with an optional payload.
|
||||
|
||||
To get started, walk through the [Dapr Jobs]({{< ref dotnet-jobs-howto.md >}}) how-to guide and refer to
|
||||
[best practices documentation]({{< ref dotnet-jobsclient-usage.md >}}) for additional guidance.
|
||||
To get started, walk through the [Dapr Jobs]({{% ref dotnet-jobs-howto.md %}}) how-to guide and refer to
|
||||
[best practices documentation]({{% ref dotnet-jobsclient-usage.md %}}) for additional guidance.
|
||||
|
|
|
|||
|
|
@ -13,5 +13,5 @@ v1.15 release, this package only contains the functionality corresponding to the
|
|||
Future Dapr .NET SDK releases will migrate existing messaging capabilities out from Dapr.Client to this
|
||||
Dapr.Messaging package. This will be documented in the release notes, documentation and obsolete attributes in advance.
|
||||
|
||||
To get started, walk through the [Dapr Messaging]({{< ref dotnet-messaging-pubsub-howto.md >}}) how-to guide and
|
||||
refer to [best practices documentation]({{< ref dotnet-messaging-pubsub-usage.md >}}) for additional guidance.
|
||||
To get started, walk through the [Dapr Messaging]({{% ref dotnet-messaging-pubsub-howto.md %}}) how-to guide and
|
||||
refer to [best practices documentation]({{% ref dotnet-messaging-pubsub-usage.md %}}) for additional guidance.
|
||||
|
|
@ -83,9 +83,9 @@ This guide focuses on the workflow API option.
|
|||
|
||||
Run the following command to start a workflow.
|
||||
|
||||
{{< tabs "Linux/MacOS" "Windows">}}
|
||||
{{< tabpane text=true >}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="Linux/MacOS" %}}
|
||||
|
||||
```bash
|
||||
curl -i -X POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 \
|
||||
|
|
@ -93,9 +93,9 @@ curl -i -X POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflo
|
|||
-d '{"Name": "Paperclips", "TotalCost": 99.95, "Quantity": 1}'
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
{{% tab header="Windows" %}}
|
||||
|
||||
```powershell
|
||||
curl -i -X POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflow/start?instanceID=12345678 `
|
||||
|
|
@ -103,9 +103,9 @@ curl -i -X POST http://localhost:3500/v1.0/workflows/dapr/OrderProcessingWorkflo
|
|||
-d '{"Name": "Paperclips", "TotalCost": 99.95, "Quantity": 1}'
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
{{% /tab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
{{< /tabpane >}}
|
||||
|
||||
If successful, you should see a response like the following:
|
||||
|
||||
|
|
@ -175,5 +175,5 @@ Watch this video [demonstrating .NET Workflow](https://youtu.be/BxiKpEmchgQ?t=25
|
|||
|
||||
## Next steps
|
||||
|
||||
- [Try the Dapr Workflow quickstart]({{< ref workflow-quickstart.md >}})
|
||||
- [Learn more about Dapr Workflow]({{< ref workflow-overview.md >}})
|
||||
- [Try the Dapr Workflow quickstart]({{% ref workflow-quickstart.md %}})
|
||||
- [Learn more about Dapr Workflow]({{% ref workflow-overview.md %}})
|
||||
|
|
|
|||
Loading…
Reference in New Issue