From 8bea2f1946b7d1a2c30066c4bb0755f1c7b53a60 Mon Sep 17 00:00:00 2001 From: Matt Klein Date: Thu, 18 Aug 2016 13:13:37 -0700 Subject: [PATCH] docs: README and getting help (#23) --- README.md | 6 ++++++ docs/intro/getting_help.rst | 23 +++++++++++++++++++---- 2 files changed, 25 insertions(+), 4 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000000..903d3e142f80 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +Envoy +========= + +C++ L7 proxy and communication bus + +https://lyft.github.io/envoy diff --git a/docs/intro/getting_help.rst b/docs/intro/getting_help.rst index 973d31d83319..a167349e395b 100644 --- a/docs/intro/getting_help.rst +++ b/docs/intro/getting_help.rst @@ -5,10 +5,25 @@ We are very interested in building a community around Envoy. Please reach out to interested in using it and need help or want to contribute. Google Groups - FIXFIX +------------- + +* `envoy-announce `_: Low frequency mailing + list where we will email announcements only. +* `envoy-users `_: General user discussion. IRC - FIXFIX +--- + +* `#envoy `_ +* `lyft/envoy on Gitter `_ + +Feel free to drop into either Gitter or the IRC channel for any reason, even +if just to chat. It doesn't matter which one you join, the messages are sync'd +between the two. + +Reporting security vulnerabilities +---------------------------------- -Gitter - FIXFIX +If you've found a vulnerability or a potential vulnerability in Envoy please let us know at +security@lyft.com. We'll send a confirmation email to acknowledge your report, and we'll send an +additional email when we've identified the issue positively or negatively.