Nicholas Johns
8e72d6cbec
|
7 years ago | |
|---|---|---|
| .. | ||
| root | 7 years ago | |
| BUILD | 7 years ago | |
| README.md | 7 years ago | |
| build.sh | 7 years ago | |
| conf.py | 7 years ago | |
| publish.sh | 7 years ago | |
| requirements.txt | 7 years ago | |
README.md
Developer-local docs build
./docs/build.sh
The output can be found in generated/docs.
How the Envoy website and docs are updated
The Envoy website, and docs are automatically built, and pushed on every commit
to master. This process is handled by Travis CI with the
publish.sh script.
In order to have this automatic process there is an encrypted ssh key at the root
of the envoy repo (.publishdocskey.enc). This key was encrypted with Travis CLI
and can only be decrypted by commits initiated in the Envoy repo, not PRs that are
submitted from forks. This is the case because only PRs initiated in the Envoy
repo have access to the secure environment variables (encrypted_b1a4cc52fa4a_iv,
encrypted_b1a4cc52fa4a_key) used to decrypt the key.
The key only has write access to the Envoy repo. If the key, or the variables
used to decrypt it are ever compromised, delete the key immediately from the
Envoy repo in Settings > Deploy keys.