Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Latest commit

 

History

History
 
 

docs

Developer-local docs build

./docs/build.sh

The output can be found in generated/docs. By default configuration examples are going to be validated during build. To disable validation, set SPHINX_SKIP_CONFIG_VALIDATION environment variable to true:

SPHINX_SKIP_CONFIG_VALIDATION=true docs/build.sh

How the Envoy website and docs are updated

  1. The docs are published to docs/envoy/latest on every commit to master. This process is handled by CircleCI with the publish.sh script.

  2. The docs are published to docs/envoy in a directory named after every tagged commit in this repo. Thus, on every tagged release there are snapped docs.