envoyproxy/gateway

Better support & reference docs for Gateway API

Open

#1.903 aberto em 20 de set. de 2023

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Go (802 forks)auto 404
documentationhelp wanted

Métricas do repositório

Stars
 (2.871 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Estude a especificação upstream do Gateway API e a documentação do EG para identificar lacunas. Em seguida, crie um documento abrangente que mapeie os campos do Gateway API para as notas de suporte do EG.
Pilha de tecnologia
gokubernetes
Domain
apidocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
KubernetesGateway APIGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75