envoyproxy/envoy

Better documentation for programming Envoy extensions

Open

#5.263 geöffnet am 11. Dez. 2018

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C++ (5.373 Forks)batch import
area/docshelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

As it stands, the documentation for extending Envoy is pretty thin. The envoy-filter-example project does provide a nice example but it'd be good to have a more step-by-step, narrative-style tutorial surrounding this.

I will be taking on this work. If anyone has recommendations for resources, possible directions, sub-topcs, etc., please feel free to weigh in here.

Contributor Guide

Research-Richtung
Untersuchen Sie das bestehende envoy filter example Projekt und die Dokumentationsstruktur von Envoy, um zu ermitteln, welche Schritte und Themen für ein Schritt für Schritt Tutorial zum Schreiben von Erweiterungen fehlen.
Tech Stack
Keine
Domain
backendinfrastructure
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
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
C++Envoy
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30