apache/apisix

docs: improve docs for APISIX's gRPC support

Open

#8984 opened on Mar 1, 2023

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

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

Tech stack
None
Domain
documentation
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
Basic knowledge of APISIXFamiliarity with gRPC conceptsUnderstanding of documentation structureContributor license agreement signed
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the gist by @kingluo at https://gist.github.com/kingluo/65a247c302dd2e518fd3408c70241a77 for detailed notes on APISIX's gRPC support. Examine the existing APISIX documentation structure, likely in the `docs/` directory, to decide where to add the content (e.g., a new page or section). Check the issue comments for any discussion on preferred placement. Then, create a PR integrating the notes into the official documentation, ensuring proper formatting and consistency with the project's doc style.