envoyproxy / envoyproxy/gateway

Redesign Developer Guide for Better Clarity and Onboarding

Open
#6,096 3 comments 0 reactions 0 assignees View on GitHub
stale triage
Dominant language
Go
Stars
3k
Forks
864
Avg merge
2d 2h
Merged PRs (30d)
140

Description

https://gateway.envoyproxy.io/contributions/develop/#prerequisites

Problem Statement
The current [Developer Guide](https://link-to-current-docs/) provides essential information but could be restructured for:

Better scannability (clear sections, bullet points, and visual hierarchy).

Reduced redundancy (e.g., repeated make commands).

New-user focus (prerequisites upfront, step-by-step workflows).

Proposed Redesign
Developer Guide
A streamlined guide to build, test, and deploy Envoy Gateway.
(Estimated: 5 min read)

1. Prerequisites
Must have:

Go (v1.24+) | [Install](https://go.dev/doc/install)

Make (v4.0+) | [Install](https://www.gnu.org/software/make)

Python 3 (with venv module)

Note: Debian/Ubuntu users may need python3-venv.

Optional:

Docker (v20.10.16+) | [Install](https://docs.docker.com/engine/install) (needed for image builds)

2. Quick Start
make help # List all available targets

3. Core Workflows
Building
make build # Build all binaries
make build BINS="envoy-gateway" # Build specific binary
Output: bin/// (e.g., bin/linux/amd64/).

Testing
make test # Run unit tests
make e2e # End-to-end tests
make testdata # Generate golden YAML files

Linting
make lint # Verify code style

4. Docker/Kubernetes Workflows
Image Management
IMAGE=docker.io/you/gateway-dev make image # Build image
IMAGE=docker.io/you/gateway-dev make push-multiarch # Push multi-arch image

Local Dev (Kind)
make create-cluster # Create Kind cluster
TAG=latest make kube-deploy # Deploy with latest image
IMAGE_PULL_POLICY=IfNotPresent make kube-deploy # Use custom image

Conformance Tests
TAG=latest make conformance # Run on Linux
# Mac workarounds: Use Docker Desktop or `make kube-deploy run-conformance`

5. Demo & Benchmarking
Demo Setup
make kube-demo # Deploy demo (Gateway + HTTPRoute)
make kube-demo-undeploy # Clean up

Benchmarking
make benchmark # Run performance tests (Nighthawk)
Reports: See benchmark_report.zip in release artifacts.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.