diff --git a/DEVELOPER.md b/DEVELOPER.md index 465644c0e02c..b9bb204e66fe 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -10,7 +10,7 @@ If you plan to contribute to Envoy, you may find it useful to install the Envoy Below is a list of additional documentation to aid the development process: -- [General build and installation documentation](https://www.envoyproxy.io/docs/envoy/latest/install/install) +- [General build and installation documentation](https://www.envoyproxy.io/docs/envoy/latest/start/start) - [Building and testing Envoy with Bazel](https://github.com/envoyproxy/envoy/blob/master/bazel/README.md) @@ -35,4 +35,3 @@ And some documents on components of Envoy architecture: - [Envoy flow control](https://github.com/envoyproxy/envoy/blob/master/source/docs/flow_control.md) - [Envoy's subset load balancer](https://github.com/envoyproxy/envoy/blob/master/source/docs/subset_load_balancer.md) - diff --git a/bazel/README.md b/bazel/README.md index 36e8f7ebc324..b8bb300a2a77 100644 --- a/bazel/README.md +++ b/bazel/README.md @@ -29,10 +29,10 @@ to find the right version of Bazel and set the version to `USE_BAZEL_VERSION` en ## Production environments To build Envoy with Bazel in a production environment, where the [Envoy -dependencies](https://www.envoyproxy.io/docs/envoy/latest/install/building.html#requirements) are typically +dependencies](https://www.envoyproxy.io/docs/envoy/latest/start/building#requirements) are typically independently sourced, the following steps should be followed: -1. Configure, build and/or install the [Envoy dependencies](https://www.envoyproxy.io/docs/envoy/latest/install/building.html#requirements). +1. Configure, build and/or install the [Envoy dependencies](https://www.envoyproxy.io/docs/envoy/latest/start/building#requirements). 1. `bazel build -c opt //source/exe:envoy-static` from the repository root. ## Quick start Bazel build for developers @@ -127,9 +127,9 @@ for how to update or override dependencies. startup --output_base=C:/_eb ``` - Bazel also creates file symlinks when building Envoy. It's strongly recommended to enable file symlink support + Bazel also creates file symlinks when building Envoy. It's strongly recommended to enable file symlink support using [Bazel's instructions](https://docs.bazel.build/versions/master/windows.html#enable-symlink-support). - For other common issues, see the + For other common issues, see the [Using Bazel on Windows](https://docs.bazel.build/versions/master/windows.html) page. [python3](https://www.python.org/downloads/): Specifically, the Windows-native flavor distributed @@ -166,10 +166,10 @@ for how to update or override dependencies. set PATH=%PATH%;%USERPROFILE%\VSBT2019\Common7\IDE\CommonExtensions\Microsoft\CMake\Ninja ``` - [MSYS2 shell](https://msys2.github.io/): Install to a path with no spaces, e.g. C:\msys32. - - Set the `BAZEL_SH` environment variable to the path of the installed MSYS2 `bash.exe` - executable. Additionally, setting the `MSYS2_ARG_CONV_EXCL` environment variable to a value + [MSYS2 shell](https://msys2.github.io/): Install to a path with no spaces, e.g. C:\msys32. + + Set the `BAZEL_SH` environment variable to the path of the installed MSYS2 `bash.exe` + executable. Additionally, setting the `MSYS2_ARG_CONV_EXCL` environment variable to a value of `*` is often advisable to ensure argument parsing in the MSYS2 shell behaves as expected. ``` set PATH=%PATH%;%USERPROFILE%\msys64\usr\bin diff --git a/docs/redirects.txt b/docs/redirects.txt index 33630893381f..87047ab3f3b5 100644 --- a/docs/redirects.txt +++ b/docs/redirects.txt @@ -1,2 +1,11 @@ intro/arch_overview/http/websocket.rst intro/arch_overview/http/upgrades.rst configuration/observability/access_log.rst intro/arch_overview/observability/access_logging.rst + +install/building.rst start/building.rst +install/ref_configs.rst start/install/ref_configs.rst +install/sandboxes/local_docker_build.rst start/install/sandboxes/local_docker_build.rst +install/tools/config_load_check_tool.rst start/install/tools/config_load_check_tool.rst +install/tools/route_table_check_tool.rst start/install/tools/route_table_check_tool.rst +install/tools/schema_validator_check_tool.rst start/install/tools/schema_validator_check_tool.rst +install/tools/tools.rst start/install/tools/tools.rst +install/install.rst start/start.rst diff --git a/docs/root/index.rst b/docs/root/index.rst index 7fa584595e6f..9711a6306a36 100644 --- a/docs/root/index.rst +++ b/docs/root/index.rst @@ -14,7 +14,6 @@ Envoy documentation about_docs intro/intro start/start - install/install configuration/configuration operations/operations extending/extending diff --git a/docs/root/install/install.rst b/docs/root/install/install.rst deleted file mode 100644 index c53acab15dc6..000000000000 --- a/docs/root/install/install.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _install: - -Building and installation -========================= - -.. toctree:: - :maxdepth: 2 - - building - ref_configs - tools/tools diff --git a/docs/root/install/building.rst b/docs/root/start/building.rst similarity index 99% rename from docs/root/install/building.rst rename to docs/root/start/building.rst index 71b2f8787901..39f5e23273d3 100644 --- a/docs/root/install/building.rst +++ b/docs/root/start/building.rst @@ -101,4 +101,4 @@ Envoy binary, and putting the binary in an Ubuntu container. .. toctree:: :maxdepth: 2 - sandboxes/local_docker_build + install/sandboxes/local_docker_build diff --git a/docs/root/install/ref_configs.rst b/docs/root/start/install/ref_configs.rst similarity index 100% rename from docs/root/install/ref_configs.rst rename to docs/root/start/install/ref_configs.rst diff --git a/docs/root/install/sandboxes/local_docker_build.rst b/docs/root/start/install/sandboxes/local_docker_build.rst similarity index 100% rename from docs/root/install/sandboxes/local_docker_build.rst rename to docs/root/start/install/sandboxes/local_docker_build.rst diff --git a/docs/root/install/tools/config_load_check_tool.rst b/docs/root/start/install/tools/config_load_check_tool.rst similarity index 100% rename from docs/root/install/tools/config_load_check_tool.rst rename to docs/root/start/install/tools/config_load_check_tool.rst diff --git a/docs/root/install/tools/route_table_check_tool.rst b/docs/root/start/install/tools/route_table_check_tool.rst similarity index 100% rename from docs/root/install/tools/route_table_check_tool.rst rename to docs/root/start/install/tools/route_table_check_tool.rst diff --git a/docs/root/install/tools/schema_validator_check_tool.rst b/docs/root/start/install/tools/schema_validator_check_tool.rst similarity index 100% rename from docs/root/install/tools/schema_validator_check_tool.rst rename to docs/root/start/install/tools/schema_validator_check_tool.rst diff --git a/docs/root/install/tools/tools.rst b/docs/root/start/install/tools/tools.rst similarity index 100% rename from docs/root/install/tools/tools.rst rename to docs/root/start/install/tools/tools.rst diff --git a/docs/root/start/start.rst b/docs/root/start/start.rst index 2fccbb4e71c0..4d4529e2f260 100644 --- a/docs/root/start/start.rst +++ b/docs/root/start/start.rst @@ -12,6 +12,18 @@ These examples use the :ref:`v3 Envoy API `, but use only t feature of the API, which is most useful for simple requirements. For more complex requirements :ref:`Dynamic Configuration ` is supported. +.. _install: + +Building and installation +------------------------- + +.. toctree:: + :maxdepth: 2 + + building + install/ref_configs + install/tools/tools + Quick Start to Run Simple Example ---------------------------------