This is the repo for the Envoy Proxy website. This website uses Jekyll to generate static html files, and then deploys the files on Github pages.
To run the website locally, first make sure you have Ruby 2.1.0 or higher installed.
- Install the
bundlergem if it's not already installed:
gem install bundler- Install Jekyll and other dependencies defined in the Gemfile:
bundle install --path vendor/bundle- Run your Jekyll site locally:
bundle exec jekyll serve --livereload- Preview the site in your web browser at http://localhost:4000.
To run the website locally using Docker, run the command:
docker run -it -v $(pwd):/srv/jekyll -p 4000:4000 jekyll/jekyll jekyll serve --watch --incrementalAlternatively, use Docker Compose with:
docker-compose upPreview the site in your web browser at http://localhost:4000.
To deploy your changes all you have to do is push to master and Github pages will automatically run jekyll build and
deploy the generated files.
| Item | Path |
|---|---|
| Home page content | _data/home.yml |
| Nav links on the main page | _data/nav.yml |
| Documentation (auto-generated) | docs |
To create a new page, all you need to do is create a new file in the root directory. This file can be either a Markdown file or an HTML file.
The new file should contain what Jekyll calls front matter, which is essentially YAML markup that lets you set options like the template, the permalink, and the title of the page.
Envoy is happy to recognize projects that use the software in production. These are not intended to be an advertisement, but a show of support for the project. All supporting organizations will be listed in alphabetical order. To be added to our adopter list, you must meet these criteria:
- Be a participant and active contributor in the community, this can be contributing code, issues or sponsoring EnvoyCon
- Publicly disclose your usage of Envoy via a talk, blog CNCF case study or social media
- Submit a high quality grayscale vector SVG logo, we scale the height to 52px (see example)
- Have an existing Envoy maintainer vouch for and approve your pull request
To add your logo, please send a pull request (see this as an example).
The official Envoy blog is hosted on Medium at https://blog.envoyproxy.io.