grpc-ecosystem/grpc-gateway

docs: make it clear that you can run the gateway inside the same process

Open

#674 opened on Jun 19, 2018

View on GitHub
 (2 comments) (3 reactions) (0 assignees)Go (2,250 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (Avg merge 8d 23h) (147 merged PRs in 30d)

Description

There seems to be some community confusion around possible deployment paths. We should have better docs that show how you can embed the gateway into your grpc server.

Contributor guide

Research direction
Examine the existing documentation to identify where embedding the gateway in process is mentioned. Propose a section or note clarifying the in process deployment option with a simple example.
Tech stack
go
Domain
backendapidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGogRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85