該存儲庫包含OpenFAAS網頁和博客-https://www.openfaas.com,使用Jekyll和CloudCannon Frisco Template的修改後叉創建,並使用GitHub頁面構建/託管。
以下各節為將對網站進行的一些常見更改提供了基本指南,並添加了帖子,作者等。
所有博客文章都必須具有標題和描述,這有助於SEO。作者的名字可以在描述中提及。
格式:
簡短的介紹/概述(150個單詞)
一系列邏輯步驟或點 /主題
嵌入概念圖,視頻或圖片以幫助製作情況。
指向DOC/GITHUB或其他內容。
如有必要,向其他合作或提供您使用的反饋的人表示感謝。在GitHub上工作時,這在公共歷史上可用,因此請謹慎使用。
使用步驟時,請使用主動/命令性語音進行標題。
好的:
壞的:
英語的說話廣泛,但不是所有讀者的母語。該出版物還涵蓋了許多技術主題,您可能是專家,但是您的讀者不太可能成為專家,因此在撰寫文章時都要考慮這兩個。
始終以簡單的英語寫入,當存在一個簡單的單詞時,請避免從拉丁語中得出的單詞,避免使用活躍動詞可以替換它的gerunds。
如果您正在寫一篇文章,那麼您的聲音應該會遇到和經驗。這就是為什麼您正在撰寫帖子 - 嘗試避免使用被動時態或語句,您可以在其中使用以I開頭的句子。
前:
後:
使用簡短的句子:
前:
後:
有關其他建議,請參見:
這篇文章,肯塔基大學拉斐爾·芬克爾(Raphael A. Finkel)。
and [and]
雖然使用“繁榮!”,“有趣和利潤”之類的有趣術語,並在文本中開玩笑,但可以在個人博客上運作良好。 OpenFAAS博客和文檔應最少使用這種“樂趣”或“可愛”術語。
意見應作為您自己的觀點提出。如果您有數據備份您的職位,這將有助於您的觀點可信。 I found it easier to ..您沒有數據,請確保讀者通過與您自己有關I believe that ..
如果您說明事實 /客觀數據,則還應使用引號,鏈接等來備份此內容。
當心版權法。如果您使用圖表或嵌入某個地方的報價,請確保給它適當的歸因。
將所有圖像放在子文件中./images/<post-name>中
每個帖子都應從免費股票攝影中挑選的背景照片或提供創意共享許可證。請勿在不檢查使用 /許可證是否有效的情況下從Google中拉出圖像。將背景裁剪為1600像素的寬度。出口時使用JPEG並將其瞄準200KB-280KB(增加壓縮)
您可以通過將JPEG的“質量”從100%限製到較低的70-75%來進一步降低大小。
pexels
Unplash
內部圖像和屏幕截圖
每個博客文章應至少具有一個概念圖。這應該顯示功能,新聞或設計的邏輯流或抽象視圖。嵌入式推文或視頻也可以實現此目的。
圖像對於每個帖子都很重要,但請盡可能合理和可能地壓縮 /裁剪圖像。這將有助於減輕GitHub回購可以增長的巨大尺寸,其中充滿圖像。
交叉填充內容會對SEO分數產生負面影響,因此,除非提出額外的注意和關注以包括所需的“ OG”標頭,否則不應完成。確保OpenFAAS社區博客上的所有內容都是原始的。
提供了一個Docker組成的文件來簡化網站和博客的開發/貢獻,已驗證可以在OSX和Windows 10上使用(在Windows上開發/寫作時,請在編輯器中使用Unix Line Endings)。
在本地運行以下網站:
docker compose up
這將使網站在-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.
編輯器中對網站進行的任何更改都將在容器內部拾取,並將重新生成該站點(請注意,這不包括對_config.yml的更改,您必須重新啟動Docker容器以拾取這些更改)。
例如,如果您在_posts/2018-07-31-my-post.md中添加自己的帖子,您會看到Jekyll檢測到更改並重新生成該站點,刷新瀏覽器會添加任何更改。
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/登錄頁面上的“貢獻者”部分正在使用generate-stats.js文件中的一個小node腳本生成。建議您在打開PR之前運行此腳本。這將確保貢獻者部分是最新的:
node generate-stats.js
注意:需要在系統上安裝node.js。
為了使博客文章正確地歸因於作者,必須通過在_staff_members目錄中創建<author_name>.md文件來將它們添加到團隊中。
團隊成員在團隊頁面上的顯示基於數據/成員中的位置。
博客文章中的歸因基於文件名。
例如, _staff_members/alex.md可以通過設置以下元數據的帖子來使用:
author_staff_member: alex
這導致每個分配的帖子都顯示一個作者框:

作者定義採用以下格式:
---
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>.
---
| 鑰匙 | 細節 |
|---|---|
| 姓名 | 作者的全名 |
| 位置 | 他們與項目關係的免費文本描述 |
| image_path | 通往作者肖像的路徑,這應該是154px * 154px圖像 |
| Twitter_username | 作者Twitter句柄(沒有@ ) |
| blurb | 有關用戶的免費文本信息,這應該很短 |
###貢獻帖子
貢獻帖子與籌集包含您的帖子的PR以及任何嵌入式圖像一樣直接。
您的郵標應在_posts目錄中創建,文件應採用以下結構。
yyyy-mm-dd-short-description-of-post.md
如果您有疑問,請查看現有的帖子,以了解可接受的想法。
該帖子由兩個部分組成,一個YAML的前物質標頭,該標題描述了帖子,並為Jekyll提供了渲染/歸因等的提示,以及僅是標準降價的郵局。
元數據以下表格:
---
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/
---
| 鑰匙 | 細節 |
|---|---|
| 標題 | 博客文章的標題 |
| 日期 | 以yyyy-mm-dd格式發布博客文章的日期 |
| 圖像 | 將顯示標題後面顯示的圖像的路徑,應將其添加到一個目錄中,名稱與images目錄下的博客文章相同。 |
| 類別 | 帖子屬於的類別的可選列表,您應始終從可行的帖子中重複使用現有類別 |
| fure_staff_member | _staff_members目錄中的作者文件的名稱,用於歸因(請參見上一節) |
| canonical_url | 如果博客文章已經在另一個URL上發布,則必須設置此字段。優先考慮原始內容。 |
儘管Jekyll支持多種格式,但您應該以降級格式提交帖子。
以下指南描述了語法:
當您想學習如何格式化帖子時,將現有帖子與基礎降價文件進行比較也非常有用。
添加圖像使用普通的標記格式,儘管可以在PR中包含任何圖像,但除了外部圖像,這些圖像應該以與images目錄下的帖子相同的名稱中的目錄,例如images/kubernetes-operator-crd/ 。
請注意,要注意僅包括合理的圖像尺寸,您應該確保在將圖像添加到PR之前進行調整/處理任何圖像。
該網站使用SASS樣式表語言,對網站的任何更改都必須使用SASS進行,不會貢獻RAW .css文件。
我們還使用Bulma作為CSS框架。在進行任何樣式更改 /添加之前,請考慮:
該網站的Navbar和頁腳在以下文件中通過YAML配置:
_data/footer.yml_data/navigation.yml添加條目應該是最後的手段,因為它們不得變得混亂。
有關如何構建網站的更詳細了解,請參考Jekyll和Github頁面文檔:
該網站還使用以下插件:
有關如何使用和配置每個插件的詳細信息,請參閱上面的文檔。
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