envoyproxy/envoy

Cache filters need some reference documentation

Open

#16.246 aberto em 30 de abr. de 2021

Ver no GitHub
 (4 comments) (2 reactions) (0 assignees)C++ (5.373 forks)batch import
area/cachearea/docsarea/protobufenhancementhelp wanted

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

Description

description

There is currently a sandbox and some minimal api documentation for the cache filters/extensions

The api docs are currently wrong (they are showing the wrong relationship between these and envoy.filters.http)

What is desperately needed is some reference documentation that explains how these fit together and potentially could be extended

Guia do colaborador

Direção de pesquisa
Revise a sandbox existente e a documentação da API para os filtros de cache e, em seguida, elabore a documentação de referência explicando como os filtros de cache se encaixam na cadeia de filtros do Envoy, sua relação com envoy.filters.http e como estendê los. Concentre se em corrigir a documentação da API e fornecer uma visão geral clara.
Pilha de tecnologia
cpp
Domain
backendapidocumentation
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-3 horas
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
Basic understanding of Envoy's filter architecture
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70