You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This page covers how the documentation is structured for the Dapr Go SDK
4
+
5
+
## Dapr Docs
6
+
7
+
All Dapr documentation is hosted at [docs.dapr.io](https://docs.dapr.io), including the docs for the [Go SDK](https://docs.dapr.io/developing-applications/sdks/go/). Head over there if you want to read the docs.
8
+
9
+
### Go SDK docs source
10
+
11
+
Although the docs site code and content is in the [docs repo](https://github.com/dapr/docs), the Go SDK content and images are within the `content` and `static` directories, respectively.
12
+
13
+
This allows separation of roles and expertise between maintainers, and makes it easy to find the docs files you are looking for.
14
+
15
+
## Writing Go SDK docs
16
+
17
+
To get up and running to write Go SDK docs, visit the [docs repo](https://github.com/dapr/docs) to initialize your environment. It will clone both the docs repo and this repo, so you can make changes and see it rendered within the site instantly, as well as commit and PR into this repo.
18
+
19
+
Make sure to read the [docs contributing guide](https://docs.dapr.io/contributing/contributing-docs/) for information on style/semantics/etc.
20
+
21
+
## Docs architecture
22
+
23
+
The docs site is built on [Hugo](https://gohugo.io), which lives in the docs repo. This repo is setup as a git submodule so that when the repo is cloned and initialized, the dotnet-sdk repo, along with the docs, are cloned as well.
24
+
25
+
Then, in the Hugo configuration file, the `daprdocs/content` and `daprdocs/static` directories are redirected to the `daprdocs/developing-applications/sdks/go` and `static/go` directories, respectively. Thus, all the content within this repo is folded into the main docs site.
description: Guidelines for contributing to the Dapr Go SDK
7
+
---
8
+
9
+
When contributing to the [Go SDK](https://github.com/dapr/go-sdk) the following rules and best-practices should be followed.
10
+
11
+
## Examples
12
+
13
+
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:
14
+
15
+
- 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" %}})
16
+
- 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.
17
+
18
+
## Docs
19
+
20
+
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:
21
+
22
+
- All rules in the [docs guide]({{% ref contributing-docs.md %}}) should be followed in addition to these.
23
+
- All files and directories should be prefixed with `go-` to ensure all file/directory names are globally unique across all Dapr documentation.
A client library to help build Dapr applications in Go. This client supports all public Dapr APIs while focusing on idiomatic Go experiences and developer productivity.
16
+
17
+
{{% cardpane %}}
18
+
{{% card title="**Client**"%}}
19
+
Use the Go Client SDK for invoking public Dapr APIs
20
+
21
+
[Learn more about the Go Client SDK]({{% ref go-client %}})
22
+
{{% /card %}}
23
+
{{% card title="**Service**"%}}
24
+
Use the Dapr Service (Callback) SDK for Go to create services that will be invoked by Dapr.
25
+
26
+
[Learn more about the Go Service (Callback) SDK]({{% ref go-service %}})
0 commit comments