envoyproxy/envoy

Better documentation for programming Envoy extensions

Open

#5,263 opened on Dec 11, 2018

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
area/docshelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Examine the existing envoy filter example project and Envoy's documentation structure to determine what steps and topics are missing for a step by step tutorial on writing extensions.
Tech stack
None
Domain
backendinfrastructure
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Envoy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30