apache/apisix

docs: improve docs for APISIX's gRPC support

Open

#8984 aperta il 1 mar 2023

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)Lua (2860 fork)batch import
docgood first issuehelp wanted

Metriche repository

Star
 (16.597 star)
Metriche merge PR
 (Merge medio 6g 8h) (109 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi la gist di @kingluo su https://gist.github.com/kingluo/65a247c302dd2e518fd3408c70241a77 per note dettagliate sul supporto gRPC di APISIX. Esamina la struttura della documentazione esistente di APISIX, probabilmente nella directory `docs/`, per decidere dove aggiungere il contenuto (ad esempio, una nuova pagina o sezione). Controlla i commenti dell'issue per eventuali discussioni sul posizionamento preferito. Quindi, crea una PR integrando le note nella documentazione ufficiale, assicurandoti una formattazione corretta e coerenza con lo stile della documentazione del progetto.
Tech stack
luagrpc
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90