apache/apisix

docs: improve docs for APISIX's gRPC support

Open

#8.984 aberto em 1 de mar. de 2023

Ver no 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.

Guia do colaborador

Pilha de tecnologia
None
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic knowledge of APISIXFamiliarity with gRPC conceptsUnderstanding of documentation structureContributor license agreement signed
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80
Direção de pesquisa
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.