Working on Envoy Gateway Docs
The documentation for the Envoy Gateway lives in the
docs/ directory. Any
individual document can be written using either reStructuredText or Markdown,
you can choose the format that you’re most comfortable with when working on the
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
docs/latest and will be cut off at
the next release. The contents under
docs/v0.2.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
It’s important to note that a given document must have a reference in some
.. toctree:: section for the document to be reachable. Not everything needs
to be in
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 reStructuredText or Markdown files in
This will create
docs/html with the built HTML pages. You can view the docs
either simply by pointing a web browser at the
file:// path to your
docs/html, or by firing up a static webserver from that directory, e.g.
If you want to generate a new release version of the docs, like
v0.3.0, then run
make docs-release TAG=v0.3.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
docs/v0.3.0, which contains docs at v0.3.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.