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: link to GetEnvoy.io for pre-built binaries #7814

Merged
merged 4 commits into from
Aug 5, 2019
Merged
Show file tree
Hide file tree
Changes from 2 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: 3 additions & 0 deletions docs/root/install/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ tests.
organizations track and deploy master in production. We encourage you to do the same so that
issues can be reported as early as possible in the development process.

There are packaged Envoy pre-built binaries in rpm, deb, and Homebrew packages are available via
lizan marked this conversation as resolved.
Show resolved Hide resolved
`GetEnvoy.io <https://www.getenvoy.io/>`_.

We will consider producing additional binary types depending on community interest in helping with
CI, packaging, etc. Please open an `issue <https://github.com/envoyproxy/envoy/issues>`_ in GitHub
Copy link
Member

Choose a reason for hiding this comment

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

Maybe add a GH link to getenvoy here and tell people to open issue against that repo for prebuilt binaries for different platforms? WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

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

SGTM, done

if desired.
Expand Down
6 changes: 3 additions & 3 deletions docs/root/start/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Getting Started

This section gets you started with a very simple configuration and provides some example configurations.

Envoy does not currently provide separate pre-built binaries, but does provide Docker images. This is
the fastest way to get started using Envoy. Should you wish to use Envoy outside of a
Docker container, you will need to :ref:`build it <building>`.
Envoy provides official :ref:`pre-built Docker images <install_binaries>` and other pre-built binaries
Copy link
Member

Choose a reason for hiding this comment

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

I would not link directly to GetEnvoy here, but instead just rephrase and link to the other page where everything is described. Then we only have to keep one place up to date.

Copy link
Member Author

Choose a reason for hiding this comment

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

done.

are available via `GetEnvoy.io <https://www.getenvoy.io/>`_. This is the fastest way to get started using Envoy.
You can also :ref:`build it <building>` from source.

These examples use the :ref:`v2 Envoy API <envoy_api_reference>`, but use only the static configuration
feature of the API, which is most useful for simple requirements. For more complex requirements
Expand Down