envoyproxy/envoy

[RFC] Move developer docs to main docs (or at least to an .rst tree)

Open

#13.431 aberto em 7 de out. de 2020

Ver no GitHub
 (17 comments) (0 reactions) (0 assignees)C++ (5.373 forks)batch import
area/docshelp 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

At the moment there are a lot of useful dev docs/info spread through files in the repo.

I believe there are several advantages to centralizing the developer docs and bringing them into the main documentation

  • we have various ci/checks etc that are only applied to the doc/rst tree
  • centralizing docs would decrease the learning time/curve for new developers to find relevant documentation/adopt related standards etc
  • one set of documents to maintain (altho i think there is an argument for maintaining the dev docs in a separate tree - but then 2)

we could still leave stubs/links in README files or similar

perhaps this pertains differently to code documentation in the actual source etc than to eg ci/tooling/sandbox docs - but even then there maybe a similar argument to collate the developer docs.

Guia do colaborador

Direção de pesquisa
Revise a documentação do desenvolvedor existente espalhada pelo repositório e proponha uma estrutura para integrá la na árvore de documentação principal.
Pilha de tecnologia
cpp
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.
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75