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 (16,971 stars) (2,250 forks)batch import
documentationhelp wanted

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

Tech stack
gogrpcrest api
Domain
documentationbackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GogRPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing documentation at https://grpc ecosystem.github.io/grpc gateway/ and the repository's docs/ folder to identify where the deployment options are currently explained. Specifically, examine any 'getting started' or 'usage' pages to see if embedding the gateway is mentioned. Consider adding a new section or example showing how to run the gateway in process with a gRPC server, referencing the relevant code in the examples/ directory. Also check the existing comments on this issue for any suggested approaches.