Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Move install section into getting started #13439

Merged
merged 7 commits into from
Oct 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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)

16 changes: 8 additions & 8 deletions bazel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions docs/redirects.txt
Original file line number Diff line number Diff line change
@@ -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
1 change: 0 additions & 1 deletion docs/root/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Envoy documentation
about_docs
intro/intro
start/start
install/install
configuration/configuration
operations/operations
extending/extending
Expand Down
11 changes: 0 additions & 11 deletions docs/root/install/install.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 12 additions & 0 deletions docs/root/start/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ These examples use the :ref:`v3 Envoy API <envoy_api_reference>`, but use only t
feature of the API, which is most useful for simple requirements. For more complex requirements
:ref:`Dynamic Configuration <arch_overview_dynamic_config>` is supported.

.. _install:

Building and installation
-------------------------

.. toctree::
:maxdepth: 2

building
install/ref_configs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO the ref_configs are somewhat unrelated to building and going through the initial examples. Can you move them somewhere else?

Also, I think start.rst should be a raw TOC page without any text, as it's going to be the entry point to a lot of content. WDYT about moving all of the text in here into smaller independent pages that we can more easily sequence for the right flow?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ref_configs are somewhat unrelated to building

yep, most of the stuff in the install folder probs needs to be moved

I think start.rst should be a raw TOC page without any text

i think probably yes, but atm it is giving the section structure

could we make these changes after landing this?

the redirects, can be chained, so its ok to move and move again, and im quite up for changing this incrementally

overall tho, defo we want to be able to create a flow through the docs, and the ability to hone in on specific solutions (and SEO to get there etc), so im for moving this around more

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ill look and see what i can do with ref_configs in the meantime

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah sure I'm fine to do this incrementally as long as we agree on the overall direction. LMK if you want to play with this more or merge.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets merge it for now, and ill make some changes when i add the install page

install/tools/tools

Quick Start to Run Simple Example
---------------------------------

Expand Down