apache/apisix

docs: improve docs for APISIX's gRPC support

Open

#8,984 创建于 2023年3月1日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Lua (16,597 star) (2,860 fork)batch import
docgood first issuehelp wanted

描述

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.

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic knowledge of APISIXFamiliarity with gRPC conceptsUnderstanding of documentation structureContributor license agreement signed
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.