envoyproxy/envoy

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

Open

#13.431 aperta il 7 ott 2020

Vedi su GitHub
 (17 commenti) (0 reazioni) (0 assegnatari)C++ (5373 fork)batch import
area/docshelp wanted

Metriche repository

Star
 (27.997 star)
Metriche merge PR
 (Merge medio 8g) (378 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la documentazione per sviluppatori esistente sparsa nel repository e proponi una struttura per integrarla nell'albero della documentazione principale.
Tech stack
cpp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75