openfaas.github.io
1.0.0
Dieses Repository enthält die OpenFaAs -Webseite und die Blog - https://www.openfaas.com, die mit Jekyll erstellt und eine modifizierte Gabel der CloudCannon Frisco -Vorlage und gebaut/gehostet mit GitHub -Seiten erstellt/gehostet wurde.
Die folgenden Abschnitte bieten eine grundlegende Anleitung für einige häufige Änderungen, die an der Website vorgenommen werden, wobei Beiträge, Autoren usw. hinzugefügt werden.
Alle Blog -Beiträge müssen einen Titel und eine Beschreibung haben, dies hilft bei SEO. Der Name des Autors könnte in der Beschreibung erwähnt werden.
Format:
Kurze Intro/Übersicht (150 Wörter)
Reihe logischer Schritte oder Punkte / Themen
Betten Sie das konzeptionelle Diagramm, Video oder ein Bild ein, um den Fall zu machen.
Zeigen Sie auf Docs/Github oder etwas anderes.
Wenn nötig Anerkennungen für andere, die zusammengearbeitet oder Feedback gegeben haben, werden Sie anerkannt. Wenn Sie an GitHub arbeiten, ist dies in der öffentlichen Geschichte verfügbar, verwenden Sie sparsam.
Wenn Sie Schritte verwenden, verwenden Sie die aktive/imperative Stimme für Überschriften.
Gut:
Schlecht:
Englisch wird weit verbreitet, ist aber nicht die erste Sprache aller Leser. Diese Veröffentlichung deckt auch viele technische Themen ab, Sie sind vielleicht ein Experte, aber Ihre Leser sind wahrscheinlich nicht. Betrachten Sie also beide, wenn Sie Ihren Artikel schreiben.
Schreiben Sie jederzeit in einfachem Englisch, wenn ein einfacheres Wort verwendet wird, wenn möglich Wörter, die nach Möglichkeit von Latein abgeleitet sind, Gerunds vermeiden, bei denen ein aktives Verb es ersetzen kann.
Wenn Sie einen Artikel schreiben, sollte Ihre Stimme und Ihre Erfahrung auftreten. Aus diesem Grund schreiben Sie den Beitrag - versuchen Sie, passive Zeitform oder Aussagen zu vermeiden, bei denen Sie einen Satz verwenden können, der mit I beginnt.
Vor:
Nach:
Verwenden Sie kurze Sätze:
Vor:
Nach:
Für einige weitere Empfehlungen siehe:
Dieser Beitrag von Raphael A. Finkel, Universität von Kentucky.
Und [vor & nach] http://www.plainenglish.co.uk/campaigning/examples/befor-and-after.html] von plainenglish.co.uk
Wenn Sie unterhaltsame Begriffe wie "Boom!", "Fun and Profit" und Witze im Text verwenden, können Sie in einem persönlichen Blog gut funktionieren. Das OpenFAAS -Blog und die Dokumentation sollten eine minimale Verwendung dieser Art von "lustigen" oder "niedlichen" Begriffen haben.
Meinungen sollten als Ihre eigene Sichtweise dargestellt werden. Wenn Sie Daten haben, um Ihre Position zu sichern, wird dies dazu beitragen, dass Ihr Standpunkt glaubwürdig wird. Wenn Sie keine Daten haben, stellen Sie sicher, dass der Leser dies versteht, indem Sie sich auf sich selbst in Verbindung setzen I believe that .. I found it easier to ..
Wenn Sie eine Tatsache / objektive Daten angeben, sollten Sie dies auch mit Anführungszeichen, Links usw. sichern.
Hüten Sie sich vor Urheberrechtsgesetzen. Wenn Sie ein Diagramm verwenden oder ein Zitat von irgendwoher einbetten, stellen Sie sicher, dass Sie es ordnungsgemäß zuzugeben.
Platzieren Sie alle Bilder in einen Unterordner ./images/<post-name>
In jedem Beitrag sollte ein Hintergrundfoto aus der kostenlosen Stockfotografie oder mit einer Creative Commons -Lizenz ausgewählt werden. Ziehen Sie keine Bilder von Google an, ohne zu überprüfen, ob die Verwendung / Lizenz zuerst gültig ist. Erstellen Sie den Hintergrund zu einer Breite von 1600 Pixel. Verwenden Sie JPEG und zielen Sie beim Exportieren von 200 KB-280 KB an (Erhöhen Sie die Komprimierung).
Sie können die Größe weiter verringern, indem Sie die "Qualität" des JPEG von 100% auf etwas niedrigeres wie 70-75% einschränken.
Pexels
Unplash
Postbilder und Screenshots
Jeder Blog -Beitrag sollte mindestens ein konzeptionelles Diagramm haben. Dies sollte den logischen Fluss oder die abstrakte Ansicht der Funktionen, Nachrichten oder des Designs zeigen. Ein eingebetteter Tweet oder Video könnte auch diesen Zweck erfüllen.
Bilder sind für jeden Beitrag wichtig, aber versuchen Sie, die Bilder so weit wie vernünftig und möglich zu komprimieren / zuzubereiten. Dies wird dazu beitragen, die riesige Größe zu mildern, die ein Github -Repo wachsen kann, was voller Bilder ist.
Cross-Posting-Inhalte wirken sich negativ auf die SEO-Scores aus. Daher sollte es nicht erfolgen, es sei denn, es werden zusätzliche Sorgfalt und Aufmerksamkeit erhoben, um die erforderlichen "OG" -Kapfen einzuschließen. Stellen Sie sicher, dass alle Inhalte im OpenFAAS -Community -Blog original sind.
Eine Docker -Komponierungsdatei wird bereitgestellt, um die Entwicklung/den Beitrag zur Website und zum Blog zu vereinfachen. Diese wurde verifiziert, um sowohl OSX als auch Windows 10 zu arbeiten (beim Entwickeln/Schreiben unter Windows verwenden Sie bitte die UNIX -Zeilenende in Ihrem Editor).
Führen Sie die Website lokal mit:
docker compose up
Dadurch wird die Website lokal unter - http: // localhost: 4000 verfügbar.
Starting openfaas-www_openfaas-jekyll_1 ... done
Attaching to openfaas-www_openfaas-jekyll_1
openfaas-jekyll_1 | ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux-musl]
openfaas-jekyll_1 | Configuration file: /srv/jekyll/_config.yml
openfaas-jekyll_1 | Source: /srv/jekyll
openfaas-jekyll_1 | Destination: /srv/jekyll/_site
openfaas-jekyll_1 | Incremental build: disabled. Enable with --incremental
openfaas-jekyll_1 | Generating...
openfaas-jekyll_1 | Remote Theme: Using theme cloudcannon/frisco-jekyll-template
openfaas-jekyll_1 | done in 3.074 seconds.
openfaas-jekyll_1 | Auto-regeneration: enabled for '/srv/jekyll'
openfaas-jekyll_1 | Server address: http://0.0.0.0:4000
openfaas-jekyll_1 | Server running... press ctrl-c to stop.
Alle Änderungen an der Site in Ihrem Editor werden im Container abgeholt und die Website wird regeneriert ( beachten Sie, dass Sie keine Änderungen an _config.yml enthalten. Sie müssen den Docker -Container neu starten, um diese Änderungen abzuholen).
Wenn Sie beispielsweise Ihren eigenen Beitrag in _posts/2018-07-31-my-post.md hinzufügen
openfaas-jekyll_1 | Regenerating: 1 file(s) changed at 2018-07-31 21:28:36
openfaas-jekyll_1 | _posts/2018-08-22-my-post.md
openfaas-jekyll_1 | Remote Theme: Using theme cloudcannon/frisco-jekyll-template
openfaas-jekyll_1 | ...done in 2.0199265 seconds.
_data/users.ymlimages/users-logos/ Der Abschnitt mit Mitwirkenden auf der Zielseite wird mit einem kleinen node in der Datei generate-stats.js generiert. Es wird empfohlen, dieses Skript auszuführen, bevor Sie eine PR öffnen. Dadurch wird sichergestellt, dass der Abschnitt zwischen Mitwirkenden auf dem neuesten Stand ist:
node generate-stats.js
HINWEIS: Erfordert Node.js auf Ihrem System.
Um einen Blog -Beitrag ordnungsgemäß einem Autor zugeschrieben zu haben, müssen sie dem Team hinzugefügt werden, indem eine <author_name>.md -Datei im Verzeichnis _staff_members erstellt werden.
Die Anzeige des Teammitglieds auf der Teamseite basiert auf der Position in der Datei data/members.yml.
Die Zuordnung in einem Blog -Beitrag basiert auf dem Dateinamen.
Beispielsweise kann _staff_members/alex.md zur Zuordnung verwendet werden, indem die folgenden Metadaten ein Beitrag festgelegt werden:
author_staff_member: alex
Dies führt dazu, dass ein Autorenfeld mit jedem zugewiesenen Beitrag angezeigt wird:
Die Definition der Autorin nimmt das folgende Format an:
---
name: Alex Ellis
position: Founder
image_path: /images/author/ellis.jpg
twitter_username: alexellisuk
blurb: Founder of <a href="https://twitter.com/openfaas">@openfaas</a>. Open Source <a href="https://twitter.com/vmware">@vmware</a>.
---
| Schlüssel | Details |
|---|---|
| Name | Vollständiger Name des beitragenden Autors |
| Position | Kostenlose Textbeschreibung ihrer Beziehung zum Projekt |
| Image_Path | Pfad zum Autorenporträt, dies sollte ein 154px * 154px -Bild sein |
| Twitter_username | Autoren Twitter Handle (ohne @ ) |
| Klappentext | Kostenlose Textinformationen über den Benutzer, dies sollte sehr kurz sein |
### einen Beitrag beitragen
Der Beitrag eines Beitrags ist so einfach wie die Erhöhung eines PR, der Ihren Beitrag im Markdown -Format zusammen mit eingebetteten Bildern enthält.
Ihr Post -Markdown sollte im Verzeichnis _posts erstellt werden und die Datei sollte die folgende Struktur einnehmen.
yyyy-mm-dd-short-description-of-post.md
Wenn Sie Zweifel haben, sollten Sie sich die vorhandenen Beiträge ansehen, um Ideen darüber zu erhalten, was akzeptabel ist.
Der Beitrag besteht aus zwei Teilen, einem Header der Yaml Front Materie, der den Posten beschreibt und Jekyll mit Hinweisen zum Rendern/Zuschreibung usw. und dem nur Standard -Markdown ausgestattet ist.
Die Post -Metadaten nennen das folgende Formular:
---
title: Introducing the OpenFaaS Operator for Serverless on Kubernetes
date: 2018-07-14
image: /images/kubernetes-operator-crd/pexels-asphalt-blue-sky-clouds-490411.jpg
categories:
- kubernetes
author_staff_member: alex
canonical_url: https://blog.alexellis.io/introducing-the-openfaas-operator/
---
| Schlüssel | Details |
|---|---|
| Titel | Titel des Blog -Beitrags |
| Datum | Veröffentlichen Sie das Datum des Blog-Beitrags im yyyy-mm-dd Format |
| Bild | Pfad zum Bild, der hinter dem Titel angezeigt wird, sollte dies in einem Verzeichnis mit demselben Namen wie dem Blog -Beitrag unter dem images -Verzeichnis hinzugefügt werden. |
| Kategorien | Eine optionale Liste von Kategorien, unter die der Beitrag fällt, sollten Sie immer vorhandene Kategorien aus früheren Beiträgen wiederverwenden |
| Author_Staff_Member | Name der Autorendatei im Verzeichnis _staff_members , verwendet für die Zuordnung (siehe vorheriger Abschnitt) |
| Canonical_url | Sie müssen dieses Feld festlegen, wenn der Blog -Beitrag bereits bei einer anderen URL veröffentlicht wurde. Vorlieben für den ursprünglichen Inhalt. |
Während Jekyll mehrere Formate unterstützt, sollten Sie Ihren Beitrag im Markdown -Format einreichen.
Die folgende Anleitung beschreibt die Syntax:
Es ist auch sehr nützlich, vorhandene Beiträge mit den zugrunde liegenden Markdown -Dateien zu vergleichen, wenn Sie erfahren möchten, wie Sie Ihren Beitrag formatieren möchten.
Das Hinzufügen von Bildern verwendet das normale Markdown-Format, und obwohl externe Bilder möglich sind, wird es vorgezogen, dass Sie alle Bilder in Ihr PR aufnehmen, diese sollten in einem Verzeichnis mit demselben Namen wie dem Beitrag unter dem images Verzeichnis auftreten, z. B. images/kubernetes-operator-crd/ .
Hinweis Achten Sie darauf, dass Sie nur vernünftige Bildgrößen einbeziehen.
Die Site verwendet die Sass Stylesheet -Sprache, alle Änderungen an den Websites aussehen und das Gefühl mit SASS vorgenommen werden, tragen keine RAW .css -Dateien bei.
Wir verwenden auch Bulma als CSS -Framework. Bevor Sie Stiländerungen / -eradungen vornehmen, sollten Sie bitte:
Die Navigationsleiste und die Fußzeile der Site werden in den folgenden Dateien über YAML konfiguriert:
_data/footer.yml_data/navigation.ymlDas Hinzufügen von Einträgen zu beiden Fällen sollte als letzter Ausweg sein, da sie nicht überfüllt sein dürfen.
Für ein detaillierteres Verständnis für die Erstellung der Website finden Sie in der Dokumentation Jekyll- und Github Pages:
Die Site verwendet auch die folgenden Plugins:
Weitere Informationen darüber finden Sie die oben genannte Dokumentation, wie jedes Plugin verwendet und konfiguriert werden kann.
rm -rf outg/ * ; ffmpeg -i videoplayback.mp4 -vf " select='not(mod(n,2000))',setpts='N/(30*TB)' " -f image2 -y outg/out%03d.jpg
ffmpeg -f image2 -framerate 1 -i outg/out%003d.jpg -vf " scale=width=-2:height=ih/2 " out.gif
