envoyproxy/envoy

Use tabs for API info on docs pages

Open

#16.329 aberto em 5 de mai. de 2021

Ver no GitHub
 (4 comments) (0 reactions) (1 assignee)C++ (5.373 forks)batch import
api/v3area/docsarea/protobufhelp 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

atm there are various appendages to API info - security status, canonical name, config, extension info

we are also going to add canonical uri, examples, formerly known as info, lifecycle status, and richer extension info

atm it uses .. notes, and .. tips and in some places warnings in others - this is making for a bit of an angry fruit salad

i think we need to shift this info into tabs for API files and fields and figure out how best to prioritize

this will also allow extension examples which adds significantly to the complexity here

Guia do colaborador

Direção de pesquisa
Investigue a estrutura atual da documentação da API na pasta docs, identifique o uso de notas, dicas e avisos, e proponha um layout baseado em abas para as seções de informações da API.
Pilha de tecnologia
None
Domain
documentation
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.
3
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.
Principalmente claro
Prerequisites
GitDocumentation
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65