envoy website

Gesandte Proxy -Website

Dies ist das Repo für die Gesandte Proxy -Website.

Diese Website wurde mit Jekyll und Sphinx erstellt, um statische HTML -Dateien zu generieren, die dann mit Netlify bereitgestellt werden.

Verwenden Sie Bazel auf Ihrem Host -Entwicklungssystem

Wenn Sie Bazel auf Ihrem Host -System installiert haben, können Sie diese direkt verwalten und entwickeln.

Die erwartete Version von Bazel ist in .bazelversion zu sehen.

Wenn Sie Basel direkt auf Ihrem Host verwenden, benötigen Sie einige minimale Systemanforderungen. Diese Anforderungen sind für ein Ubuntu-basiertes System in der bereitgestellten Dockerfile zu erkennen.

Verwenden von Basel in einem Docker -Container

Sie können auch die notwendigen Bazel -Befehle in einem Docker -Container ausführen.

Für Ihre Bequemlichkeit wurde eine Docker-Compose-Datei bereitgestellt, die ein Docker-Image verwendet, das die von Bazel erwarteten Systemanforderungen enthält.

Die Komposition ist so konzipiert, dass sie den Bazel -Cache auf Ihrem Host -System verwenden.

Möglicherweise müssen Sie die UID Ihres Benutzers exportieren, um den Container auszuführen.

$ export UID

Der Basel Ruby Toolchain

Da Ruby die Website erstellen muss, ist eine Ruby -Toolchain in den Bazel -Regeln enthalten.

Dies wird nach verfügbaren Ruby -Binärdateien in seiner Umgebung suchen.

Wenn es eine Version findet, die dem in .Ruby-Version angegeben angegeben ist, wird diese verwendet.

Andernfalls wird die erforderliche Ruby -Version zusammengestellt, die die Binärdatei zur weiteren Verwendung zwischengespeichert.

Wenn Sie Bazel -Befehle in einem Docker -Container ausführen, muss Ruby kompiliert werden, es sei denn, er findet eine zuvor kompilierte und zwischengespeicherte Version.

Live -Site lokal ausführen (Bazel)

$ bazel run //site:live

Die Website sollte jetzt verfügbar sein, indem Sie http: // localhost: 4000 besuchen.

Standardmäßig wird nur die Website und nicht die Dokumentation durch diese Umgebung bedient.

Sie können die gesamte Site mit der neuesten Dokumentation mit Folgendem anzeigen:

$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel run --action_env=ENVOY_COMMIT //site:live_docs

Änderungen an den Inhalten in den unterstrichenen Jekyll-Ordnern, die ein sofortiges Server-Reload ausladern.

Ausführen der Website lokal (Docker)

Sie können die Website in einem Docker -Container mit dem zur Verfügung gestellten Kompose -Rezept ausführen.

$ docker-compose up live

Standardmäßig wird nur die Website und nicht die Dokumentation durch diese Umgebung bedient.

Sie können die gesamte Site mit der neuesten Dokumentation mit Folgendem anzeigen:

$ docker-compose up live_docs

Änderungen an den Inhalten in den unterstrichenen Jekyll-Ordnern, die ein sofortiges Server-Reload ausladern.

Bauen des Standorts lokal (Basel)

Das Bazel -Ziel, die gesamte Website zu erstellen, lautet:

$ export ENVOY_COMMIT= " $( bazel run //docs:latest_version ) "
$ bazel build --action_env=ENVOY_COMMIT //site:html

Es gibt ein Convenience -Skript (wie in CI verwendet), das im aktuellen Verzeichnis in einen _site -Ordner aufgebaut wird:

$ ./build-website.sh

Aufbau des Standorts lokal (Docker)

Der folgende Befehl erstellt im aktuellen Verzeichnis die gesamte Website, einschließlich aller Dokumentation, in einen _site -Ordner:

$ docker-compose run build

Bazel -Befehle in einem Container ausführen.

Um in einen Docker -Container zu fallen, wobei die Portzuordnungen in der Kompositionsdatei konfiguriert sind:

$ docker-compose run -p 4000:4000 live bash

Von dort aus können Sie Bazel -Befehle direkt ausführen, zum Beispiel:

 username@73deecbfaf55:/src/workspace/envoy-website $ bazel run //docs:latest_version
...
b200312ddcbc4d237cd197a42cdd8c66cc8c6af0

Site -Inhalt

Artikel	Weg
Homepage -Inhalt	_data/home.yml
NAV -Links auf der Hauptseite	_data/nav.yml
Dokumentation (automatisch generiert)	docs

Neue Seiten erstellen

Um eine neue Seite zu erstellen, müssen Sie lediglich eine neue Datei im Stammverzeichnis erstellen. Diese Datei kann entweder eine Markdown -Datei oder eine HTML -Datei sein.

Die neue Datei sollte enthalten, was Jekyll Front Materie nennt. Dies ist im Wesentlichen YAML -Markup, mit dem Sie Optionen wie die Vorlage, den Permalink und den Titel der Seite festlegen können.

Fügen Sie das Logo von Envoy Adoptter hinzu

Der Gesandte erkennt gerne Projekte, die die Software in der Produktion verwenden. Diese sollen keine Werbung sein, sondern eine Unterstützung für das Projekt. Alle unterstützenden Organisationen werden in alphabetischer Reihenfolge aufgeführt. Um zu unserer Adoptivliste hinzugefügt zu werden, müssen Sie diese Kriterien erfüllen:

• Seien Sie Teilnehmer und aktiver Mitarbeiter in der Community. Dies kann dazu beitragen
• Geben Sie öffentlich Ihre Nutzung des Gesandtens über einen Vortrag, einen Blog CNCF -Fallstudium oder soziale Medien an
• Senden Sie ein hochwertiges Graustufen -Vektor -SVG -Logo ein. Wir skalieren die Höhe auf 52px (siehe Beispiel).
• Haben Sie einen bestehenden Gesandterbetreuungsbetrag für und genehmigen Sie Ihre Pull -Anfrage

Um Ihr Logo hinzuzufügen, senden Sie bitte eine Pull -Anfrage (siehe dies als Beispiel).

Der Envoy -Blog

Der offizielle Envoy -Blog wird auf Medium unter https://blog.envoyproxy.io gehostet.