Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improved docs/_docs/season_of_docs.md in v2 branch #1319

Merged
merged 1 commit into from
May 12, 2020
Merged

improved docs/_docs/season_of_docs.md in v2 branch #1319

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs/_docs/season_of_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ We're excited to see what contributions this will bring to our documentation.
## Project details

- Organization name: **gRPC-Gateway**
- Organization description: The gRPC-Gateway brings the power and safety
of designing APIs with Protobuf and gRPC to the JSON/HTTP API world. It has several
- Organization description: The gRPC-Gateway brings the power and safety of designing APIs with Protobuf and gRPC to the JSON/HTTP API world. It has several
common use cases:
- When a user wants to migrate an API to gRPC, but needs to expose a JSON/HTTP API
to old users.
- When a user wants to expose an existing gRPC API to a JSON/HTTP API audience.
- When quickly iterating on an JSON/HTTP API design.
- When quickly iterating on a JSON/HTTP API design.
- Website: https://grpc-ecosystem.github.io/grpc-gateway
- Repo: https://github.com/grpc-ecosystem/grpc-gateway
- Project administrators and mentors:
Expand Down Expand Up @@ -74,7 +73,7 @@ The ones mentioned in the project details are the primary use cases we advertise
- When a user wants to expose an existing gRPC API to a JSON/HTTP API audience.
- When quickly iterating on an JSON/HTTP API design.

It could be a single or several blog posts on our docs site, or another site, like medium.
It could be a single or several blog posts on our docs site, or another site, like Medium.

### Improve the "customize your gateway" section of the docs

Expand All @@ -86,7 +85,7 @@ a bit better. Maybe it could be rewritten as a FAQ that details solutions to com
Material:
- [The customize your gateway page](https://grpc-ecosystem.github.io/grpc-gateway/docs/customizingyourgateway.html)

### Improve the contributors guide
### Improve the contributor's guide

This is currently split between
[CONTRIBUTING.md]
Expand All @@ -107,8 +106,8 @@ This should include:
- A list of all the breaking changes and their consequences for the user.
- For each breaking change, a guide to how their systems may need to be changed.

Currently the scope of the v2 release is not entirely known, as it is still in progress, but we will
endavour not to make too many breaking changes as that will discourage users from upgrading.
Currently, the scope of the v2 release is not entirely known, as it is still in progress, but we will
endeavour not to make too many breaking changes as that will discourage users from upgrading.

Material:
- [v2 Tracking issue](https://github.com/grpc-ecosystem/grpc-gateway/issues/1223)