envoy website
1.0.0
Este es el repositorio del sitio web de proxy Envoy.
Este sitio web está construido con Jekyll y Sphinx para generar archivos HTML estáticos, que luego se implementan con NetLify.
Si tiene bazel instalado en su sistema de host, puede usarlo para administrar y desarrollar el sitio directamente.
La versión esperada de Bazel se puede ver en .Bazelversion.
Si usa bazel directamente en su host, necesitará algunos requisitos mínimos del sistema. Estos requisitos se pueden ver para un sistema basado en Ubuntu en el DockerFile proporcionado.
También puede ejecutar los comandos de bazel necesarios dentro de un contenedor Docker.
Se ha proporcionado un archivo Docker-Compose para su conveniencia, que utiliza una imagen de Docker que contiene los requisitos del sistema esperados por Bazel.
La composición está diseñada para utilizar el caché de bazel en su sistema host.
Es posible que deba exportar el UID de su usuario para ejecutar el contenedor.
$ export UIDComo se requiere Ruby para construir el sitio web, se incluye una cadena de herramientas Ruby en las reglas de bazel.
Esto buscará cualquier binarios de rubí disponibles en su entorno.
Si encuentra una versión que coincide con la especificada en .ruby-Version, usará esa.
De lo contrario, compilará la versión Ruby requerida, almacenando en caché el binario para su uso posterior.
Si ejecuta comandos de bazel dentro de un contenedor Docker, deberá compilar Ruby a menos que encuentre una versión previamente compilada y almacenada en caché.
$ bazel run //site:liveEl sitio ahora debe estar disponible visitando http: // localhost: 4000.
Por defecto, solo el sitio web y no la documentación es atendida por este entorno.
Puede ver todo el sitio, construido con la última documentación, con lo siguiente:
$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel run --action_env=ENVOY_COMMIT //site:live_docsLos cambios realizados en el contenido en las carpetas Jekyll prefijadas con un subscore activarán una recarga inmediata del servidor.
Puede ejecutar el sitio web dentro de un contenedor Docker con la receta de composición proporcionada.
$ docker-compose up livePor defecto, solo el sitio web y no la documentación es atendida por este entorno.
Puede ver todo el sitio, construido con la última documentación, con lo siguiente:
$ docker-compose up live_docsLos cambios realizados en el contenido en las carpetas Jekyll prefijadas con un subscore activarán una recarga inmediata del servidor.
El objetivo bazel para construir todo el sitio web es:
$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel build --action_env=ENVOY_COMMIT //site:html Hay un script de conveniencia (como se usa en CI) que se convertirá en una carpeta _site en el directorio actual:
$ ./build-website.sh El siguiente comando creará todo el sitio web, incluida toda la documentación, en una carpeta _site en el directorio actual:
$ docker-compose run buildPara caer en un contenedor Docker, con las asignaciones de puerto configuradas en el archivo de composición:
$ docker-compose run -p 4000:4000 live bashDesde allí puede ejecutar comandos de bazel directamente, por ejemplo:
username@73deecbfaf55:/src/workspace/envoy-website $ bazel run //docs:latest_version
...
b200312ddcbc4d237cd197a42cdd8c66cc8c6af0
| Artículo | Camino |
|---|---|
| Contenido de la página de inicio | _data/home.yml |
| Enlaces de navegación en la página principal | _data/nav.yml |
| Documentación (generada automáticamente) | docs |
Para crear una nueva página, todo lo que necesita hacer es crear un nuevo archivo en el directorio raíz. Este archivo puede ser un archivo Markdown o un archivo HTML.
El nuevo archivo debe contener lo que Jekyll llama la materia frontal, que es esencialmente un marcado YAML que le permite establecer opciones como la plantilla, el enlace permanente y el título de la página.
Envoy se complace en reconocer proyectos que usan el software en producción. Estos no están destinados a ser un anuncio, sino una muestra de soporte para el proyecto. Todas las organizaciones de apoyo aparecerán en orden alfabético. Para ser agregado a nuestra lista de adoptantes, debe cumplir con estos criterios:
Para agregar su logotipo, envíe una solicitud de extracción (consulte esto como un ejemplo).
El blog oficial de envío está alojado en medio en https://blog.envoyproxy.io.
