envoyproxy/gateway

docs: High Priority Concepts that Need Documentation

Open

#5,694 opened on Apr 8, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (802 forks)auto 404
documentationgood first issuestale

Repository metrics

Stars
 (2,871 stars)
PR merge metrics
 (PR metrics pending)

Description

Description: The following are concepts that should be added to Envoy Gateways conceptual documentation.

  • Traffic Basics
  • API Security
  • Authentication
  • Authorization
  • Observability
  • Circuit Breaking
  • Extensibility Options
  • Session

Contributor guide

Research direction
Review the existing documentation structure in the repository, especially the concepts directory, and add new documentation files for each of the listed concepts: Traffic Basics, API Security, Authentication, Authorization, Observability, Circuit Breaking, Extensibility Options, Session. Follow the style of existing docs and ensure consistency.
Tech stack
go
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Mostly clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75