envoy website
1.0.0
Este é o repositório do site de proxy do enviado.
Este site foi criado usando Jekyll e Sphinx para gerar arquivos HTML estáticos, que são então implantados com o Netlify.
Se você tiver o Bazel instalado no sistema host, pode usá -lo para gerenciar e desenvolver o site diretamente.
A versão esperada do Bazel pode ser vista no .BazelVersion.
Se você usar o Bazel diretamente no seu host, precisará de alguns requisitos mínimos do sistema. Esses requisitos podem ser vistos para um sistema baseado no Ubuntu no Dockerfile fornecido.
Você também pode executar os comandos Bazel necessários dentro de um contêiner do Docker.
Um arquivo do Docker-Comppose foi fornecido para sua conveniência, que usa uma imagem do Docker que contém os requisitos do sistema esperados pelo Bazel.
A composição foi projetada para usar o cache do Bazel no seu sistema host.
Pode ser necessário exportar o UID do seu usuário para executar o contêiner.
$ export UIDComo o Ruby é necessário para construir o site, uma cadeia de ferramentas Ruby está incluída nas regras do Bazel.
Isso procurará quaisquer binários de rubi disponíveis em seu ambiente.
Se encontrar uma versão que corresponda à especificada no .Ruby-Version, ele usará essa.
Caso contrário, ele compilará a versão Ruby necessária, armazenando em cache o binário para uso posterior.
Se você executar comandos Bazel dentro de um contêiner do Docker, ele precisará compilar o Ruby, a menos que encontre uma versão compilada e cache anteriormente.
$ bazel run //site:liveO site agora deve estar disponível visitando http: // localhost: 4000.
Por padrão, apenas o site e não a documentação é servida por esse ambiente.
Você pode visualizar o site inteiro, construído com a documentação mais recente, com o seguinte:
$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel run --action_env=ENVOY_COMMIT //site:live_docsAs alterações feitas no conteúdo nas pastas Jekyll prefixadas sublinham-se acionarão uma recarga imediata do servidor.
Você pode executar o site dentro de um contêiner do Docker com a receita de composição fornecida.
$ docker-compose up livePor padrão, apenas o site e não a documentação é servida por esse ambiente.
Você pode visualizar o site inteiro, construído com a documentação mais recente, com o seguinte:
$ docker-compose up live_docsAs alterações feitas no conteúdo nas pastas Jekyll prefixadas sublinham-se acionarão uma recarga imediata do servidor.
O alvo Bazel para construir o site inteiro é:
$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel build --action_env=ENVOY_COMMIT //site:html Existe um script de conveniência (como usado no IC) que será construído em uma pasta _site no diretório atual:
$ ./build-website.sh O comando a seguir construirá o site inteiro, incluindo toda a documentação, em uma pasta _site no diretório atual:
$ docker-compose run buildPara cair em um contêiner do Docker, com os mapeamentos de porta configurados no arquivo de composição:
$ docker-compose run -p 4000:4000 live bashA partir daí, você pode executar comandos Bazel diretamente, por exemplo:
username@73deecbfaf55:/src/workspace/envoy-website $ bazel run //docs:latest_version
...
b200312ddcbc4d237cd197a42cdd8c66cc8c6af0
| Item | Caminho |
|---|---|
| Conteúdo da página inicial | _data/home.yml |
| Links de navegação na página principal | _data/nav.yml |
| Documentação (gerada automaticamente) | docs |
Para criar uma nova página, tudo o que você precisa fazer é criar um novo arquivo no diretório raiz. Este arquivo pode ser um arquivo de marcação ou um arquivo HTML.
O novo arquivo deve conter o que Jekyll chama de matéria frontal, que é essencialmente a marcação da YAML que permite definir opções como o modelo, o link permaling e o título da página.
Envoy está feliz em reconhecer projetos que usam o software em produção. Isso não pretende ser um anúncio, mas uma demonstração de apoio ao projeto. Todas as organizações de apoio serão listadas em ordem alfabética. Para ser adicionado à nossa lista de adotantes, você deve atender a esses critérios:
Para adicionar seu logotipo, envie uma solicitação de tração (consulte isso como exemplo).
O blog oficial de Envoy está hospedado no Medium em https://blog.envoyproxy.io.
