Skip to content

Commit

Permalink
fixed typos (dapr#172)
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitsh authored Jun 18, 2021
1 parent ff2b836 commit 116732e
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 23 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contribution Guidelines

Thank you for your interest in Dapr go SDK!
Thank you for your interest in Dapr Go SDK!

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.

Expand All @@ -12,7 +12,7 @@ This project has adopted the Microsoft Open Source Code of Conduct. For more inf

Contributions come in many forms: submitting issues, writing code, participating in discussions and community calls.

This document provides the guidelines for how to contribute to the Dapr go SDK project.
This document provides the guidelines for how to contribute to the Dapr Go SDK project.

## Issues

Expand All @@ -23,7 +23,7 @@ This section describes the guidelines for submitting issues
There are 4 types of issues:

- Issue/Bug: You've found a bug with the code, and want to report it, or create an issue to track the bug.
- Issue/Discussion: You have something on your mind, which requires input form others in a discussion, before it eventually manifests as a proposal.
- Issue/Discussion: You have something on your mind, which requires input from others in a discussion, before it eventually manifests as a proposal.
- Issue/Proposal: Used for items that propose a new idea or functionality. This allows feedback from others before code is written.
- Issue/Question: Use this issue type, if you need help or have a question.

Expand All @@ -37,12 +37,12 @@ Before you file an issue, make sure you've checked the following:
- 👍 up-vote
- 👎 down-vote
1. For proposals
- Some changes to the Dapr go SDK 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).
- Some changes to the Dapr Go SDK 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.

## Contributing to Dapr go SDK
## Contributing to Dapr Go SDK

This section describes the guidelines for contributing code/docs to Dapr go SDK.
This section describes the guidelines for contributing code/docs to Dapr Go SDK.

### Pull Requests

Expand All @@ -68,7 +68,7 @@ A good way to communicate before investing too much time is to create a "Work-in
### Use of Third-party code

- All third-party code must be placed in the `vendor/` folder.
- `vendor/` folder is managed by go modules which stores the source code of third-party go dependencies. - The `vendor/` folder should not be modified manually.
- `vendor/` folder is managed by Go modules which stores the source code of third-party Go dependencies. - The `vendor/` folder should not be modified manually.
- Third-party code must include licenses.

A non-exclusive list of code that must be places in `vendor/`:
Expand Down
6 changes: 3 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Client library to help you build Dapr application in Go. This client supports al
## Usage
> Assuming you already have [installed](https://golang.org/doc/install) Go
Dapr Go client includes two packages: `client` (for invoking public Dapr APIs), and `service` (to create services that will be invoked by Dapr, this is sometimes refereed to as "callback").
Dapr Go client includes two packages: `client` (for invoking public Dapr APIs), and `service` (to create services that will be invoked by Dapr, this is sometimes referred to as "callback").

### Creating client

Expand Down Expand Up @@ -217,7 +217,7 @@ secret, err := client.GetSecret(ctx, "store-name", "secret-name", opt)

#### Authentication

By default, Dapr relies on the network boundary to limit access to its API. If however the target Dapr API is configured with token-based authentication, users can configure the go Dapr client with that token in two ways:
By default, Dapr relies on the network boundary to limit access to its API. If however the target Dapr API is configured with token-based authentication, users can configure the Go Dapr client with that token in two ways:

##### Environment Variable

Expand All @@ -242,7 +242,7 @@ func main() {

In addition to the client capabilities that allow you to call into the Dapr API, the Go SDK also provides `service` package to help you bootstrap Dapr callback services in either gRPC or HTTP. Instructions on how to use it are located [here](./service/Readme.md)

## Contributing to Dapr go client
## Contributing to Dapr Go client

See the [Contribution Guide](./CONTRIBUTING.md) to get started with building and developing.

Expand Down
4 changes: 2 additions & 2 deletions example/Readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Dapr go client example
# Dapr Go client example

The `example` folder contains a Dapr enabled `serving` app and a `client` app that uses this SDK to invoke Dapr API for state and events, The `serving` app is available as HTTP or gRPC. The `client` app can target either one of these for service to service and binding invocations.

To run this example, start by first launching the service in ether HTTP or gRPC:
To run this example, start by first launching the service in either HTTP or gRPC:

### HTTP

Expand Down
6 changes: 3 additions & 3 deletions example/pubsub/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Dapr PubSub Example with go-sdk

This folder contains two go file that use the Go SDK to invoke the Dapr Pub/Sub API.
This folder contains two Go files that use the Go SDK to invoke the Dapr Pub/Sub API.

## Diagram

Expand Down Expand Up @@ -38,5 +38,5 @@ dapr run --app-id pub \
## Result

```shell
== APP == 2020/08/23 13:21:58 event - PubsubName: messages, Topic: demo, ID: 11acaa82-23c4-4244-8969-7360dae52e5d, Data: ping
```
== APP == 2020/08/23 13:21:58 event - PubsubName: messages, Topic: neworder, ID: 11acaa82-23c4-4244-8969-7360dae52e5d, Data: ping
```
4 changes: 2 additions & 2 deletions service/Readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Dapr Service (Callback) SDK for Go

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:
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](./http/Readme.md)
* [gRPC Service](./grpc/Readme.md)

## Templates

To accelerate your Dapr app development in go even further, we've craated a few GitHub templates which build on the above Dapr callback packages:
To accelerate your Dapr app development in Go even further, we've created a few GitHub templates which build on the above Dapr callback packages:

* [Dapr gRPC Service in Go](https://github.com/dapr-templates/dapr-grpc-service-template) - Template project to jump start your Dapr event subscriber service with gRPC development
* [Dapr HTTP Event Subscriber in Go](https://github.com/dapr-templates/dapr-http-event-subscriber-template) - Template project to jump start your Dapr event subscriber service with HTTP development
Expand Down
6 changes: 3 additions & 3 deletions service/grpc/Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Dapr gRPC Service SDK for Go

Start by importing Dapr go `service/grpc` package:
Start by importing Dapr Go `service/grpc` package:

```go
daprd "github.com/dapr/go-sdk/service/grpc"
Expand Down Expand Up @@ -107,12 +107,12 @@ func runHandler(ctx context.Context, in *common.BindingEvent) (out []byte, err e

## Templates

To accelerate your gRPC Dapr app development in go even further you can use one of the GitHub templates integrating the gRPC Dapr callback package:
To accelerate your gRPC Dapr app development in Go even further you can use one of the GitHub templates integrating the gRPC Dapr callback package:

* [Dapr gRPC Service in Go](https://github.com/mchmarny/dapr-grpc-service-template) - Template project to jump start your Dapr event subscriber service with gRPC development
* [Dapr gRPC Event Subscriber in Go](https://github.com/mchmarny/dapr-grpc-event-subscriber-template) - Template project to jump start your Dapr event subscriber service with gRPC development


## Contributing to Dapr go client
## Contributing to Dapr Go client

See the [Contribution Guide](../../CONTRIBUTING.md) to get started with building and developing.
6 changes: 3 additions & 3 deletions service/http/Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Dapr HTTP Service SDK for Go

Start by importing Dapr go `service/http` package:
Start by importing Dapr Go `service/http` package:

```go
daprd "github.com/dapr/go-sdk/service/http"
Expand Down Expand Up @@ -103,12 +103,12 @@ func runHandler(ctx context.Context, in *common.BindingEvent) (out []byte, err e

## Templates

To accelerate your HTTP Dapr app development in go even further you can use one of the GitHub templates integrating the HTTP Dapr callback package:
To accelerate your HTTP Dapr app development in Go even further you can use one of the GitHub templates integrating the HTTP Dapr callback package:

* [Dapr HTTP Event Subscriber in Go](https://github.com/mchmarny/dapr-http-event-subscriber-template) - Template project to jump start your Dapr event subscriber service with HTTP development
* [Dapr HTTP cron Handler in Go](https://github.com/mchmarny/dapr-http-cron-handler-template) - Template project to jump start your Dapr service development for scheduled workloads


## Contributing to Dapr go client
## Contributing to Dapr Go client

See the [Contribution Guide](../../CONTRIBUTING.md) to get started with building and developing.

0 comments on commit 116732e

Please sign in to comment.