diff --git a/docs/root/dev/build/index.rst b/docs/root/dev/build/index.rst new file mode 100644 index 000000000000..fd0fd1320597 --- /dev/null +++ b/docs/root/dev/build/index.rst @@ -0,0 +1,18 @@ + +Envoy build documentation +========================= + +native building +--------------- + +using build container (amd64/arm64) +----------------------------------- + +build operations +---------------- + +bazel survival guide +-------------------- + +dependency policies +------------------- diff --git a/docs/root/dev/community/index.rst b/docs/root/dev/community/index.rst new file mode 100644 index 000000000000..4703bba154c6 --- /dev/null +++ b/docs/root/dev/community/index.rst @@ -0,0 +1,17 @@ +Envoy developer community +========================= + +contrib guidelines +------------------ + +repokitteh +---------- + +devstats +-------- + +slack channels +-------------- + +github +------ diff --git a/docs/root/dev/core/index.rst b/docs/root/dev/core/index.rst new file mode 100644 index 000000000000..1c4cc7c44f8e --- /dev/null +++ b/docs/root/dev/core/index.rst @@ -0,0 +1,11 @@ +Envoy core documentation +======================== + +Core or extension? +------------------ + +API policies +------------ + +testing policies - unit/integration/coverage +-------------------------------------------- diff --git a/docs/root/dev/docs/index.rst b/docs/root/dev/docs/index.rst new file mode 100644 index 000000000000..5fd7ee9554c0 --- /dev/null +++ b/docs/root/dev/docs/index.rst @@ -0,0 +1,11 @@ +Writing docs +============ + +API documentation +----------------- + +Configuration documentation +--------------------------- + +Creating a sandbox +------------------ diff --git a/docs/root/dev/extensions/index.rst b/docs/root/dev/extensions/index.rst new file mode 100644 index 000000000000..1b8d4900d320 --- /dev/null +++ b/docs/root/dev/extensions/index.rst @@ -0,0 +1,17 @@ +Envoy extensions documentation +============================== + +types of extension +------------------ + +writing extensions +------------------ + +deploying extensions +-------------------- + +publishing extensions +--------------------- + +existing extensions +------------------- diff --git a/docs/root/dev/index.rst b/docs/root/dev/index.rst new file mode 100644 index 000000000000..36c42227be80 --- /dev/null +++ b/docs/root/dev/index.rst @@ -0,0 +1,13 @@ +Developer documentation +----------------------- + +.. toctree:: + :maxdepth: 2 + + community/index + build/index + testing/index + core/index + extensions/index + docs/index + standards/index diff --git a/docs/root/dev/standards/index.rst b/docs/root/dev/standards/index.rst new file mode 100644 index 000000000000..8838982990ab --- /dev/null +++ b/docs/root/dev/standards/index.rst @@ -0,0 +1,21 @@ + +Code standards, linting, and style guides +========================================= + +c++ +--- + +python +------ + +starlark +-------- + +bazel +----- + +bash +---- + +docs/rst +-------- diff --git a/docs/root/dev/testing/index.rst b/docs/root/dev/testing/index.rst new file mode 100644 index 000000000000..c0a636e561a7 --- /dev/null +++ b/docs/root/dev/testing/index.rst @@ -0,0 +1,16 @@ + +Envoy testing documentation +=========================== + + +running tests +------------- + +writing tests +------------- + +coverage +-------- + +config_validation +----------------- diff --git a/docs/root/index.rst b/docs/root/index.rst index 9711a6306a36..c05b1da99c5e 100644 --- a/docs/root/index.rst +++ b/docs/root/index.rst @@ -8,6 +8,9 @@ Envoy documentation This is pre-release documentation. There is risk of it not being consistent with what is currently implemented in Envoy, though we try to make things consistent as quickly as possible. +User documentation +------------------ + .. toctree:: :maxdepth: 2 @@ -20,3 +23,11 @@ Envoy documentation api/api faq/overview version_history/version_history + +Developer documentation +----------------------- + +.. toctree:: + :maxdepth: 2 + + dev/index