apache/apisix

docs: improve docs for APISIX's gRPC support

Open

#8 984 ouverte le 1 mars 2023

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)Lua (2 860 forks)batch import
docgood first issuehelp wanted

Métriques du dépôt

Stars
 (16 597 stars)
Métriques de merge PR
 (Merge moyen 6j 8h) (109 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Consultez le gist de @kingluo à l'adresse https://gist.github.com/kingluo/65a247c302dd2e518fd3408c70241a77 pour des notes détaillées sur la prise en charge de gRPC par APISIX. Examinez la structure de documentation existante d'APISIX, probablement dans le répertoire `docs/`, pour décider où ajouter le contenu (par exemple, une nouvelle page ou section). Vérifiez les commentaires de l'issue pour toute discussion sur l'emplacement préféré. Ensuite, créez une PR intégrant les notes dans la documentation officielle, en veillant à une mise en forme correcte et à la cohérence avec le style de documentation du projet.
Stack technique
luagrpc
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90