apache/apisix

docs: improve docs for APISIX's gRPC support

Open

#8.984 geöffnet am 1. März 2023

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Lua (2.860 Forks)batch import
docgood first issuehelp wanted

Repository-Metriken

Stars
 (16.597 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 8h) (109 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfe den Gist von @kingluo unter https://gist.github.com/kingluo/65a247c302dd2e518fd3408c70241a77 für detaillierte Notizen zur gRPC Unterstützung von APISIX. Untersuche die vorhandene APISIX Dokumentationsstruktur, wahrscheinlich im `docs/` Verzeichnis, um zu entscheiden, wo der Inhalt hinzugefügt werden soll (z. B. eine neue Seite oder ein neuer Abschnitt). Überprüfe die Issue Kommentare auf Diskussionen zur bevorzugten Platzierung. Erstelle dann einen PR, der die Notizen in die offizielle Dokumentation integriert, und stelle sicher, dass die Formatierung korrekt ist und mit dem Dokumentationsstil des Projekts übereinstimmt.
Tech Stack
luagrpc
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90