openfaas.github.io
1.0.0
Ce référentiel contient la page Web et le blog OpenFAAS - https://www.openfaas.com, créés à l'aide de Jekyll et une fourche modifiée du modèle CloudCannon Frisco et construit / hébergé à l'aide de pages GitHub.
Les sections suivantes fournissent un guide de base pour certaines modifications courantes qui seront apportées au site, ajoutant des publications, des auteurs, etc.
Tous les articles de blog doivent avoir un titre et une description, cela aide avec le référencement. Le nom de l'auteur pourrait être mentionné dans la description.
Format:
Courte intro / aperçu (150 mots)
Série d'étapes logiques ou de points / sujets
ENGRAGEZ le diagramme conceptuel, la vidéo ou l'image pour aider à faire la cause.
Pointez des documents / github ou autre chose.
Si nécessaire, montrez des remerciements à d'autres qui ont collaboré ou donné des commentaires que vous avez utilisés. Lorsque vous travaillez sur GitHub, cela est disponible dans l'histoire du public, alors utilisez avec parcimonie.
Lorsque vous utilisez des étapes, utilisez la voix active / impérative pour les titres.
Bien:
Mauvais:
L'anglais est largement parlé, mais n'est pas la première langue de tous les lecteurs. Cette publication couvre également de nombreux sujets techniques, vous pouvez être un expert, mais vos lecteurs sont peu susceptibles de l'être, alors considérez les deux lorsque vous écrivez votre article.
Écrivez en anglais simple à tout moment, lorsqu'un mot plus simple existe l'utiliser, évitez les mots dérivés du latin lorsque cela est possible, évitez les gérous où un verbe actif peut le remplacer.
Si vous écrivez un article, votre voix devrait se retrouver et votre expérience. C'est pourquoi vous écrivez le message - essayez d'éviter d'utiliser le temps passif ou les déclarations, où vous pouvez utiliser une phrase qui commence par I .
Avant:
Après:
Utilisez des phrases courtes:
Avant:
Après:
Pour certaines recommandations supplémentaires, voir:
Ce poste, par Raphael A. Finkel, Université du Kentucky.
Et [avant et après] http://www.plaineNenglish.co.uk/campaigning/examples/before-and-after.html] de plainenglish.co.uk
Tout en utilisant des termes amusants comme "Boom!", "Fun and Profit" et faire des blagues en texte, peut bien fonctionner sur un blog personnel. Le blog et la documentation OpenFAAS devraient avoir une utilisation minimale de ce type de termes "amusants" ou "mignons".
Les opinions doivent être présentées comme votre propre point de vue. Si vous avez des données pour sauvegarder votre position, cela vous aidera à rendre votre point crédible. Si vous n'avez pas de données, assurez-vous que le lecteur comprend cela en vous rapportant à vous-même I believe that .. , I found it easier to ..
Si vous indiquez des données de fait / objectifs, vous devez également le soutenir avec des devis, des liens, etc.
Méfiez-vous des lois sur le droit d'auteur. Si vous utilisez un diagramme ou incorporez un devis de quelque part, assurez-vous de lui donner une attribution appropriée.
Placez toutes les images dans un sous-dossier ./images/<post-name>
Chaque message doit avoir une photo d'arrière-plan choisie à partir de photographies gratuites ou fournies avec une licence Creative Commons. Ne tirez pas d'images de Google sans vérifier que l'utilisation / la licence est d'abord valide. Cramez l'arrière-plan à une largeur de 1600 pixels. Utilisez JPEG et visez la taille de 200KB-280KB lors de l'exportation (augmentation de la compression)
Vous pouvez encore réduire la taille en limitant la "qualité" du JPEG de 100% à quelque chose de plus bas comme 70-75%.
Pexels
Désactiver
Images et captures d'écran au poste
Chaque article de blog devrait avoir au moins un diagramme conceptuel. Cela devrait montrer le flux logique ou la vue abstraite de la fonctionnalité, des nouvelles ou de la conception. Un tweet ou une vidéo intégrée pourrait également servir cet objectif.
Les images sont importantes pour chaque message, mais essayez de compresser / recadrer les images autant que raisonnable et possible. Cela aidera à atténuer la taille énorme qu'un repo github peut se développer qui est plein d'images.
Le contenu croisé affecte négativement les scores SEO, il ne faut donc pas être fait à moins que des soins et une attention supplémentaires ne soient faits pour inclure les en-têtes "OG" requis. Assurez-vous que tout le contenu du blog de la communauté OpenFAAS est original.
Un fichier Docker Compose est fourni pour simplifier le développement / la contribution du site Web et du blog, cela a été vérifié pour fonctionner sur OSX et Windows 10 (lors du développement / écriture sur Windows, veuillez utiliser Unix Line Endings dans votre éditeur).
Exécutez le site localement avec:
docker compose up
Cela rendra le site disponible localement sur - http: // localhost: 4000.
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.
Toutes les modifications apportées au site de votre éditeur seront ramassées à l'intérieur du conteneur et le site sera régénéré ( Remarque Cela n'inclut pas les modifications à _config.yml , vous devez redémarrer le conteneur Docker pour récupérer ces modifications).
Par exemple, si vous ajoutez votre propre message dans _posts/2018-07-31-my-post.md vous verrez Jekyll détecter le changement et régénérer le site, rafraîchir votre navigateur ramassera les modifications.
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/ La section des contributeurs sur la page de destination est générée à l'aide d'un petit script node situé dans le fichier generate-stats.js . Il est recommandé d'exécuter ce script avant d'ouvrir un PR. Cela garantira que la section des contributeurs est à jour:
node generate-stats.js
Remarque: nécessite que Node.js soit installé sur votre système.
Afin d'avoir un article de blog correctement attribué à un auteur, ils doivent être ajoutés à l'équipe en créant un fichier <author_name>.md dans le répertoire _staff_members .
L'affichage du membre de l'équipe sur la page de l'équipe est basé sur la position dans le fichier data / membres.yml.
L'attribution dans un article de blog est basée sur le nom de fichier.
Par exemple, _staff_members/alex.md peut être utilisé pour l'attribution en définissant les métadonnées suivantes A Post:
author_staff_member: alex
Qui se traduit par une boîte d'auteur affichée avec chaque message attribué:
La définition de l'auteur prend le format suivant:
---
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>.
---
| Clé | Détails |
|---|---|
| nom | Nom complet de l'auteur contributeur |
| position | Description du texte libre de leur relation avec le projet |
| image_path | Chemin vers le portrait des auteurs, ce devrait être une image 154px * 154px |
| Twitter_Username | Gandage des auteurs Twitter (sans @ ) |
| texte de présentation | Informations sur le texte gratuit sur l'utilisateur, cela devrait être très court |
### Contribution d'un message
La contribution d'un message est aussi simple que de soulever un RP contenant votre message au format Markdown avec toutes les images intégrées.
Votre marque de poste doit être créée dans le répertoire _posts et le fichier doit prendre la structure suivante.
yyyy-mm-dd-short-description-of-post.md
Si vous en doutez, jetez un œil aux messages existants pour des idées sur ce qui est acceptable.
Le poste se compose de deux parties, un en-tête de la matière avant YAML qui décrit le message et fournit à Jekyll des indices pour le rendu / attribution, etc., et le corps du post qui n'est que de marquage standard.
Les métadonnées post-post prennent le formulaire suivant:
---
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/
---
| Clé | Détails |
|---|---|
| titre | Titre de l'article de blog |
| date | Publier la date du billet de blog au format yyyy-mm-dd |
| image | Chemin vers l'image qui sera affichée derrière le titre, cela devrait être ajouté dans un répertoire avec le même nom que le billet de blog sous le répertoire images . |
| catégories | Une liste facultative des catégories dans lesquelles le poste tombe, vous devez toujours réutiliser les catégories existantes des articles précédents où |
| auteur_staff_member | Nom du fichier des auteurs dans le répertoire _staff_members , utilisé pour l'attribution (voir la section précédente) |
| canonical_url | Vous devez définir ce champ si le billet de blog a déjà été publié sur une autre URL. La préférence est donnée au contenu original. |
Alors que Jekyll prend en charge plusieurs formats, vous devez soumettre votre message au format Markdown.
Le guide suivant décrit la syntaxe:
Il est également très utile de comparer les articles existants avec les fichiers de marque sous-jacents lorsque vous souhaitez apprendre à formater votre message.
L'ajout d'images utilise le format Markdown normal, et bien que des images externes soient possibles, il est préféré que vous incluez toutes les images de votre PR, celles-ci devraient aller dans un répertoire avec le même nom que le post sous le répertoire d' images , par exemple images/kubernetes-operator-crd/ .
Remarque Veillez à inclure uniquement les tailles d'image raisonnables, vous devez vous assurer que vous avez redimensionné / traité toutes les images avant de les ajouter à votre RP.
Le site utilise le langage de feuille de style SASS, toutes les modifications de l'apparence et de la sensation des sites doivent être effectuées à l'aide de SASS, ne contribuent pas les fichiers .css bruts.
Nous utilisons également Bulma comme cadre CSS. Avant d'apporter des modifications / ajouts de style, veuillez considérer:
Le Navbar et le pied de page du site sont configurés via YAML dans les fichiers suivants:
_data/footer.yml_data/navigation.ymlAjouter des entrées à l'un ou l'autre devrait être en dernier recours car ils ne doivent pas devenir encombrés.
Pour une compréhension plus détaillée de la façon dont le site est construit, veuillez vous référer à la documentation des pages Jekyll et Github:
Le site utilise également les plugins suivants:
Reportez-vous à la documentation ci-dessus pour plus de détails sur la façon dont chaque plugin peut être utilisé et configuré.
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
