envoyproxy/gateway

Better support & reference docs for Gateway API

Open

#1.903 geöffnet am 20. Sept. 2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Go (802 Forks)auto 404
documentationhelp wanted

Repository-Metriken

Stars
 (2.871 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Studieren Sie die Upstream Gateway API Spezifikation und die EG Dokumentation, um Lücken zu identifizieren. Erstellen Sie dann ein umfassendes Dokument, das Gateway API Felder auf EG Supportnotizen abbildet.
Tech Stack
gokubernetes
Domain
apidocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
KubernetesGateway APIGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75