apache/apisix

docs: improve docs for APISIX's gRPC support

Open

Aperta il 1 mar 2023

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

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

Tech stack
Nessuno
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic knowledge of APISIXFamiliarity with gRPC conceptsUnderstanding of documentation structureContributor license agreement signed
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
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.