mirror of https://github.com/dapr/go-sdk.git
Upgrade markdown files in daprdocs for Hugo upgrade (#741)
Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com>
This commit is contained in:
Marc Duiker
GitHub
parent
0c36331ee5
commit
f4ba09fae5
|
|
@ -12,12 +12,12 @@ When contributing to the [Go SDK](https://github.com/dapr/go-sdk) the following
|
|||
|
||||
The `examples` directory contains code samples for users to run to try out specific functionality of the various Go SDK packages and extensions. When writing new and updated samples keep in mind:
|
||||
|
||||
- All examples should be runnable on Windows, Linux, and MacOS. While Go code is consistent among operating systems, any pre/post example commands should provide options through [codetabs]({{< ref "contributing-docs.md#tabbed-content" >}})
|
||||
- All examples should be runnable on Windows, Linux, and MacOS. While Go code is consistent among operating systems, any pre/post example commands should provide options through [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.
|
||||
|
||||
## Docs
|
||||
|
||||
The `daprdocs` directory contains the markdown files that are rendered into the [Dapr Docs](https://docs.dapr.io) website. When 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 `go-` to ensure all file/directory names are globally unique across all Dapr documentation.
|
||||
|
|
|
|||
|
|
@ -18,11 +18,11 @@ A client library to help build Dapr applications in Go. This client supports all
|
|||
{{< card title="**Client**">}}
|
||||
Use the Go Client SDK for invoking public Dapr APIs
|
||||
|
||||
[**Learn more about the Go Client SDK**]({{< ref go-client >}})
|
||||
[**Learn more about the Go Client SDK**]({{% ref go-client %}})
|
||||
{{< /card >}}
|
||||
{{< card title="**Service**">}}
|
||||
Use the Dapr Service (Callback) SDK for Go to create services that will be invoked by Dapr.
|
||||
|
||||
[**Learn more about the Go Service (Callback) SDK**]({{< ref go-service >}})
|
||||
[**Learn more about the Go Service (Callback) SDK**]({{% ref go-service %}})
|
||||
{{< /card >}}
|
||||
{{< /cardpane >}}
|
||||
|
|
@ -11,8 +11,8 @@ The Dapr client package allows you to interact with other Dapr applications from
|
|||
|
||||
## 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 %}})
|
||||
- [Go installed](https://golang.org/doc/install)
|
||||
|
||||
|
||||
|
|
@ -65,7 +65,7 @@ if err != nil {
|
|||
|
||||
## Building blocks
|
||||
|
||||
The Go SDK allows you to interface with all of the [Dapr building blocks]({{< ref building-blocks >}}).
|
||||
The Go SDK allows you to interface with all of the [Dapr building blocks]({{% ref building-blocks %}}).
|
||||
|
||||
### Service Invocation
|
||||
|
||||
|
|
@ -86,7 +86,7 @@ content := &dapr.DataContent{
|
|||
resp, err = client.InvokeMethodWithContent(ctx, "app-id", "method-name", "post", content)
|
||||
```
|
||||
|
||||
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 %}}).
|
||||
|
||||
### Workflows
|
||||
|
||||
|
|
@ -167,8 +167,8 @@ func main() {
|
|||
```
|
||||
|
||||
- For a more comprehensive guide on workflows visit these How-To guides:
|
||||
- [How-To: Author a workflow]({{< ref howto-author-workflow.md >}}).
|
||||
- [How-To: Manage a workflow]({{< ref howto-manage-workflow.md >}}).
|
||||
- [How-To: Author a workflow]({{% ref howto-author-workflow.md %}}).
|
||||
- [How-To: Manage a workflow]({{% ref howto-manage-workflow.md %}}).
|
||||
- Visit the Go SDK Examples to jump into complete examples:
|
||||
- [Workflow Example](https://github.com/dapr/go-sdk/tree/main/examples/workflow)
|
||||
- [Workflow - Parallelised](https://github.com/dapr/go-sdk/tree/main/examples/workflow-parallel)
|
||||
|
|
@ -306,7 +306,7 @@ for _, account := range queryResponse {
|
|||
|
||||
> **Note:** Query state API is currently in alpha
|
||||
|
||||
For a full guide on state management, visit [How-To: Save & get state]({{< ref howto-get-save-state.md >}}).
|
||||
For a full guide on state management, visit [How-To: Save & get state]({{% ref howto-get-save-state.md %}}).
|
||||
|
||||
### Publish Messages
|
||||
To publish data onto a topic, the Dapr Go client provides a simple method:
|
||||
|
|
@ -328,11 +328,11 @@ if res.Error != nil {
|
|||
}
|
||||
```
|
||||
|
||||
For a full guide on pub/sub, visit [How-To: Publish & subscribe]({{< ref howto-publish-subscribe.md >}}).
|
||||
For a full guide on pub/sub, visit [How-To: Publish & subscribe]({{% ref howto-publish-subscribe.md %}}).
|
||||
|
||||
### Workflow
|
||||
|
||||
You can create [workflows]({{< ref workflow-overview.md >}}) using the Go SDK. For example, start with a simple workflow activity:
|
||||
You can create [workflows]({{% ref workflow-overview.md %}}) using the Go SDK. For example, start with a simple workflow activity:
|
||||
|
||||
```go
|
||||
func TestActivity(ctx workflow.ActivityContext) (any, error) {
|
||||
|
|
@ -369,7 +369,7 @@ func TestWorkflow(ctx *workflow.WorkflowContext) (any, error) {
|
|||
}
|
||||
```
|
||||
|
||||
Then compose your application that will use the workflow you've created. [Refer to the How-To: Author workflows guide]({{< ref howto-author-workflow.md >}}) for a full walk-through.
|
||||
Then compose your application that will use the workflow you've created. [Refer to the How-To: Author workflows guide]({{% ref howto-author-workflow.md %}}) for a full walk-through.
|
||||
|
||||
Try out the [Go SDK workflow example.](https://github.com/dapr/go-sdk/blob/main/examples/workflow)
|
||||
|
||||
|
|
@ -501,7 +501,7 @@ in := &dapr.InvokeBindingRequest{
|
|||
out, err := client.InvokeBinding(ctx, in)
|
||||
```
|
||||
|
||||
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 %}}).
|
||||
|
||||
### Actors
|
||||
|
||||
|
|
@ -563,7 +563,7 @@ func main() {
|
|||
}
|
||||
```
|
||||
|
||||
For a full guide on actors, visit [the Actors building block documentation]({{< ref actors >}}).
|
||||
For a full guide on actors, visit [the Actors building block documentation]({{% ref actors %}}).
|
||||
|
||||
### Secret Management
|
||||
|
||||
|
|
@ -601,7 +601,7 @@ func main() {
|
|||
```
|
||||
|
||||
|
||||
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 %}}).
|
||||
|
||||
### Distributed Lock
|
||||
|
||||
|
|
@ -636,7 +636,7 @@ func main() {
|
|||
}
|
||||
```
|
||||
|
||||
For a full guide on distributed lock, visit [How-To: Use a lock]({{< ref howto-use-distributed-lock.md >}}).
|
||||
For a full guide on distributed lock, visit [How-To: Use a lock]({{% ref howto-use-distributed-lock.md %}}).
|
||||
|
||||
### Configuration
|
||||
|
||||
|
|
@ -667,7 +667,7 @@ go func() {
|
|||
}()
|
||||
```
|
||||
|
||||
For a full guide on configuration, visit [How-To: Manage configuration from a store]({{< ref howto-manage-configuration.md >}}).
|
||||
For a full guide on configuration, visit [How-To: Manage configuration from a store]({{% ref howto-manage-configuration.md %}}).
|
||||
|
||||
### Cryptography
|
||||
|
||||
|
|
@ -698,7 +698,7 @@ out, err := client.Decrypt(context.Background(), rf, dapr.EncryptOptions{
|
|||
})
|
||||
```
|
||||
|
||||
For a full guide on cryptography, visit [How-To: Use the cryptography APIs]({{< ref howto-cryptography.md >}}).
|
||||
For a full guide on cryptography, visit [How-To: Use the cryptography APIs]({{% ref howto-cryptography.md %}}).
|
||||
|
||||
## Related links
|
||||
[Go SDK Examples](https://github.com/dapr/go-sdk/tree/main/examples)
|
||||
|
|
|
|||
|
|
@ -7,5 +7,5 @@ description: How to get up and running with the Dapr Service (Callback) SDK for
|
|||
no_list: true
|
||||
---
|
||||
In addition to this Dapr API client, Dapr Go SDK also provides service package to bootstrap your Dapr callback services. These services can be developed in either gRPC or HTTP:
|
||||
- [HTTP Service]({{< ref http-service.md >}})
|
||||
- [gRPC Service]({{< ref grpc-service.md >}})
|
||||
- [HTTP Service]({{% ref http-service.md %}})
|
||||
- [gRPC Service]({{% ref grpc-service.md %}})
|
||||
Loading…
Reference in New Issue