envoy website
1.0.0
Ceci est le dépôt du site Web de l'envoyé.
Ce site Web est construit à l'aide de Jekyll et de Sphinx pour générer des fichiers HTML statiques, qui sont ensuite déployés avec Netlify.
Si Bazel est installé sur votre système hôte, vous pouvez l'utiliser pour gérer et développer directement le site.
La version attendue de Bazel peut être vue dans .bazelversion.
Si vous utilisez Bazel directement sur votre hôte, vous aurez besoin de quelques exigences minimales du système. Ces exigences peuvent être vues pour un système basé sur Ubuntu dans le dockerfile fourni.
Vous pouvez également exécuter les commandes Bazel nécessaires dans un conteneur Docker.
Un fichier Docker-Compose a été fourni pour votre commodité, qui utilise une image Docker contenant les exigences du système attendues par Bazel.
La composition est conçue pour utiliser le cache bazel sur votre système hôte.
Vous devrez peut-être exporter l' UID de votre utilisateur pour exécuter le conteneur.
$ export UIDComme Ruby est nécessaire pour construire le site Web, une chaîne d'outils Ruby est incluse dans les règles du bazel.
Cela recherchera tous les binaires rubis disponibles dans son environnement.
S'il trouve une version correspondant à celle spécifiée dans .Ruby-Version, elle l'utilisera.
Sinon, il compilera la version Ruby requise, en cachant le binaire pour une utilisation ultérieure.
Si vous exécutez des commandes Bazel dans un conteneur Docker, il devra compiler Ruby à moins qu'il ne trouve une version précédemment compilée et mise en cache.
$ bazel run //site:liveLe site doit désormais être disponible en visitant http: // localhost: 4000.
Par défaut, seul le site Web et non la documentation sont desservis par cet environnement.
Vous pouvez consulter l'intégralité du site, construit avec la dernière documentation, avec les suivantes:
$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel run --action_env=ENVOY_COMMIT //site:live_docsLes modifications apportées au contenu dans les dossiers Jekyll préfixées sous-préfixées déclencheront un rechargement de serveur immédiat.
Vous pouvez exécuter le site Web dans un conteneur Docker avec la recette de composition fournie.
$ docker-compose up livePar défaut, seul le site Web et non la documentation sont desservis par cet environnement.
Vous pouvez consulter l'intégralité du site, construit avec la dernière documentation, avec les suivantes:
$ docker-compose up live_docsLes modifications apportées au contenu dans les dossiers Jekyll préfixées sous-préfixées déclencheront un rechargement de serveur immédiat.
L'objectif bazel pour construire l'intégralité du site Web est:
$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel build --action_env=ENVOY_COMMIT //site:html Il y a un script de commodité (tel qu'il est utilisé dans CI) qui se transformera dans un dossier _site dans le répertoire actuel:
$ ./build-website.sh La commande suivante créera l'intégralité du site Web, y compris toutes les documents, dans un dossier _site dans le répertoire actuel:
$ docker-compose run buildPour tomber dans un conteneur Docker, avec les mappages de port configurés dans le fichier de composition:
$ docker-compose run -p 4000:4000 live bashDe là, vous pouvez exécuter directement les commandes Bazel, par exemple:
username@73deecbfaf55:/src/workspace/envoy-website $ bazel run //docs:latest_version
...
b200312ddcbc4d237cd197a42cdd8c66cc8c6af0
| Article | Chemin |
|---|---|
| Contenu de la page d'accueil | _data/home.yml |
| Liens de navigation sur la page principale | _data/nav.yml |
| Documentation (générée automatique) | docs |
Pour créer une nouvelle page, il vous suffit de créer un nouveau fichier dans le répertoire racine. Ce fichier peut être soit un fichier de marque ou un fichier html.
Le nouveau fichier doit contenir ce que Jekyll appelle Front Matter, qui est essentiellement le balisage YAML qui vous permet de définir des options comme le modèle, le permalien et le titre de la page.
Envoy est heureux de reconnaître les projets qui utilisent le logiciel en production. Ceux-ci ne sont pas destinés à être une publicité, mais une démonstration de soutien au projet. Toutes les organisations de soutien seront répertoriées par ordre alphabétique. Pour être ajouté à notre liste d'adoption, vous devez répondre à ces critères:
Pour ajouter votre logo, veuillez envoyer une demande de traction (voir cela comme un exemple).
Le blog d'envoyage officiel est hébergé sur Medium sur https://blog.envoyproxy.io.
