envoyproxy/gateway

Better support & reference docs for Gateway API

Open

#1903 aperta il 20 set 2023

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Go (802 fork)auto 404
documentationhelp wanted

Metriche repository

Star
 (2871 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Studia le specifiche upstream di Gateway API e la documentazione di EG per identificare le lacune. Quindi crea un documento completo che mappa i campi di Gateway API con le note di supporto di EG.
Tech stack
gokubernetes
Dominio
apidocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
KubernetesGateway APIGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75