Working on Envoy Gateway Docs
We migrated from Sphinx to Hugo for Envoy Gateway Documents.
Read blog: Welcome to new website!
The documentation for the Envoy Gateway lives in the
site/content/en directory. Any
individual document can be written using Markdown.
We supported the versioned Docs now, the directory name under docs represents
the version of docs. The root of the latest site is in
This is probably where to start if you’re trying to understand how things fit together.
Note that the new contents should be added to
site/content/en/latest and will be cut off at
the next release. The contents under
site/content/en/v0.5.0 are auto-generated,
and usually do not need to make changes to them, unless if you find the current release pages have
some incorrect contents. If so, you should send a PR to update contents both of
You can access the website which represents the current release in default, and you can access the website which contains the latest version changes in Here or at the footer of the pages.
To work with the docs, just edit Markdown files in
This will create
site/public with the built HTML pages. You can preview it
If you want to generate a new release version of the docs, like
v0.6.0, then run
make docs-release TAG=v0.6.0
This will update the VERSION file at the project root, which records current release version,
and it will be used in the pages version context and binary version output. Also, this will generate
site/content/en/v0.6.0, which contains docs at v0.6.0 and updates artifact links to
in all files under
http-routing.md and etc.
Whenever docs are pushed to
main, CI will publish the built docs to GitHub
Pages. For more details, see
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.