apache / apache/apisix

docs: improve docs for APISIX's gRPC support

Open
#8,984 5 comments 0 reactions 0 assignees View on GitHub
doc good first issue help wanted
Dominant language
Lua
Stars
17.1k
Forks
2.9k
Avg merge
3d 16h
Merged PRs (30d)
63

Description

### Current State

The current docs does not have a lot of documentation of APISIX's gRPC support leading to users having to ask questions. @kingluo has documented some notes in a gist: https://gist.github.com/kingluo/65a247c302dd2e518fd3408c70241a77

### Desired State

The notes in this gist should be added to the APISIX documentation. It needs to be decided where and how these should be added.

Contributor guide

Open the contributing guide

Research direction

Read the linked gist for the gRPC notes, then review the APISIX documentation to decide where they belong; the issue does not name a target page. Done means the relevant notes are incorporated into the documentation in an appropriate place.

Written by the indexing model from the issue text.

Assessment

Tech stack
grpc, lua
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.