envoyproxy/gateway

Better support & reference docs for Gateway API

Open

#1 903 ouverte le 20 sept. 2023

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Go (802 forks)auto 404
documentationhelp wanted

Métriques du dépôt

Stars
 (2 871 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Étudiez les spécifications en amont de l'API Gateway et la documentation EG pour identifier les lacunes. Créez ensuite un document complet qui mappe les champs de l'API Gateway aux notes de support EG.
Stack technique
gokubernetes
Domaine
apidocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
KubernetesGateway APIGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75