apache/apisix

docs: improve docs for APISIX's gRPC support

Open

#8,984 opened on Mar 1, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Lua (2,860 forks)batch import
docgood first issuehelp wanted

Repository metrics

Stars
 (16,597 stars)
PR merge metrics
 (Avg merge 7d 18h) (97 merged PRs in 30d)

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

Research direction
Read the gist linked in the issue, understand the gRPC support details, and determine where to integrate this content into the APISIX documentation, considering the existing doc structure.
Tech stack
luagrpc
Domain
backend
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.
1-3 hours
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90