envoyproxy/envoy

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

Open

#13,431 建立於 2020年10月7日

在 GitHub 查看
 (17 留言) (0 反應) (0 負責人)C++ (5,373 fork)batch import
area/docshelp wanted

倉庫指標

Star
 (27,997 star)
PR 合併指標
 (平均合併 8天) (30 天內合併 378 個 PR)

描述

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.

貢獻者指南