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 (2.860 forks)batch import
docgood first issuehelp wanted

Métricas do repositório

Stars
 (16.597 stars)
Métricas de merge de PR
 (Mesclagem média 6d 8h) (109 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Revise o gist de @kingluo em https://gist.github.com/kingluo/65a247c302dd2e518fd3408c70241a77 para obter notas detalhadas sobre o suporte a gRPC do APISIX. Examine a estrutura de documentação existente do APISIX, provavelmente no diretório `docs/`, para decidir onde adicionar o conteúdo (por exemplo, uma nova página ou seção). Verifique os comentários da issue para qualquer discussão sobre o local preferido. Em seguida, crie um PR integrando as notas na documentação oficial, garantindo formatação adequada e consistência com o estilo de documentação do projeto.
Pilha de tecnologia
luagrpc
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90