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.
The official Envoy blog is hosted on Medium at https://blog.envoyproxy.io.
The company TurbineLabs created an educational series about Envoy called Learn Envoy. Upon the team's acquihire by Slack they generously donated the Learn Envoy documentation to the Envoy project. You can now find Learn Envoy at https://envoyproxy.io/learn. The underlying Markdown assets are in the learn folder in this repository.