envoyproxy/gateway

Better support & reference docs for Gateway API

Open

#1,903 opened on Sep 20, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Go (802 forks)auto 404
documentationhelp wanted

Repository metrics

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

Description

Description: We currently have this doc https://gateway.envoyproxy.io/v0.5.0/user/gatewayapi-support.html which outlines the fields within Gateway API that EG supports, doesnt support, and/or can be customized in a EG specific way.

The end user currently needs to reference the upstream Gateway API reference https://gateway-api.sigs.k8s.io/references/spec/ and then peek into the above EG Gateway API support doc to figure out if the API field will actually work or not.

Raising this issue to consider adding upstream Gateway API Spec docs + specific EG comments, instructions to it within this project, to simplify user experience

Contributor guide

Research direction
Study the upstream Gateway API spec and the EG documentation to identify gaps. Then create a comprehensive document that maps Gateway API fields to EG support notes.
Tech stack
gokubernetes
Domain
apidocumentation
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-2 days
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
KubernetesGateway APIGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75