openfaas.github.io
1.0.0
Repositori ini berisi halaman web dan blog OpenFaaS - https://www.openfaas.com, dibuat menggunakan jekyll dan garpu yang dimodifikasi dari templat Cloudcannon Frisco dan dibangun/di -host menggunakan halaman GitHub.
Bagian berikut memberikan panduan dasar untuk beberapa perubahan umum yang akan dilakukan ke situs, menambahkan posting, penulis dll.
Semua posting blog harus memiliki judul dan deskripsi, ini membantu dengan SEO. Nama penulis dapat disebutkan dalam deskripsi.
Format:
Intro/Tinjauan Pendek (150 kata)
Serangkaian langkah logis atau poin / topik
Sematkan diagram konseptual, video atau gambar untuk membantu membuat kasus.
Menunjuk ke dokumen/github atau yang lainnya.
Jika perlu tunjukkan pengakuan kepada orang lain yang berkolaborasi atau memberikan umpan balik yang Anda gunakan. Saat mengerjakan GitHub, ini tersedia dalam sejarah publik, jadi gunakan dengan hemat.
Saat menggunakan langkah -langkah, gunakan suara aktif/imperatif untuk judul.
Bagus:
Buruk:
Bahasa Inggris secara luas diucapkan, tetapi bukan bahasa pertama dari semua pembaca. Publikasi ini juga mencakup banyak topik teknis, Anda mungkin ahli, tetapi pembaca Anda tidak mungkin, jadi pertimbangkan keduanya ketika Anda menulis artikel Anda.
Tulis dalam bahasa Inggris biasa setiap saat, ketika kata yang lebih sederhana menggunakannya, hindari kata -kata yang berasal dari bahasa Latin jika memungkinkan, hindari gerund di mana kata kerja aktif dapat menggantikannya.
Jika Anda menulis artikel, maka suara Anda harus muncul, dan pengalaman Anda. Itulah sebabnya Anda menulis postingan - cobalah untuk menghindari penggunaan tense atau pernyataan pasif, di mana Anda dapat menggunakan kalimat yang dimulai dengan I .
Sebelum:
Setelah:
Gunakan kalimat pendek:
Sebelum:
Setelah:
Untuk beberapa rekomendasi tambahan, lihat:
Pos ini, oleh Raphael A. Finkel, Universitas Kentucky.
Dan [sebelum & sesudah] http://www.plainenglish.co.uk/campaigning/examples/before-and-after.html] dari plainenglish.co.uk
Sementara menggunakan istilah yang menyenangkan seperti "boom!", "Menyenangkan dan laba" dan membuat lelucon dalam teks, dapat bekerja dengan baik di blog pribadi. Blog dan dokumentasi OpenFaaS harus memiliki penggunaan minimal dari istilah "menyenangkan" atau "lucu" semacam ini.
Pendapat harus disajikan sebagai sudut pandang Anda sendiri. Jika Anda memiliki data untuk mencadangkan posisi Anda, ini akan membantu membuat poin Anda kredibel. Jika Anda tidak memiliki data, maka pastikan pembaca memahami hal ini dengan berhubungan dengan diri Anda, I believe that .. , I found it easier to ..
Jika Anda menyatakan data fakta / obyektif, Anda juga harus mendukungnya dengan kutipan, tautan, dll.
Waspadalah terhadap undang -undang hak cipta. Jika Anda menggunakan diagram atau menyematkan kutipan dari suatu tempat, pastikan Anda memberikan atribusi yang tepat.
Tempatkan semua gambar dalam sub-folder ./images/<post-name>
Setiap posting harus memiliki foto latar belakang yang dipetik dari fotografi stok gratis atau diberikan lisensi Creative Commons. Jangan menarik gambar dari Google tanpa memeriksa bahwa penggunaan / lisensi valid terlebih dahulu. Tanam latar belakang hingga 1.600 piksel. Gunakan JPEG dan AIM untuk ukuran 200kb-280kb saat mengekspor (Tingkatkan kompresi)
Anda dapat mengurangi ukuran lebih lanjut dengan membatasi "kualitas" JPEG dari 100% menjadi sesuatu yang lebih rendah seperti 70-75%.
Pexels
Unsplash
Gambar dan tangkapan layar di pos
Setiap posting blog harus memiliki setidaknya satu diagram konseptual. Ini harus menunjukkan aliran logis atau tampilan abstrak dari fitur, berita atau desain. Tweet atau video tertanam juga dapat melayani tujuan ini.
Gambar penting untuk setiap posting, tetapi cobalah untuk memampatkan / memotong gambar sebanyak yang masuk akal dan mungkin. Ini akan membantu mengurangi ukuran besar yang dapat ditumbuhkan oleh repo GitHub yang penuh dengan gambar.
Konten pemasangan silang secara negatif mempengaruhi skor SEO, jadi tidak boleh dilakukan kecuali perawatan tambahan dan perhatian dibuat untuk memasukkan header "OG" yang diperlukan. Pastikan semua konten di blog OpenFaaS Community adalah asli.
File Docker Compose disediakan untuk menyederhanakan pengembangan/berkontribusi ke situs web dan blog, ini telah diverifikasi untuk bekerja pada OSX dan Windows 10 (saat mengembangkan/menulis di Windows, silakan gunakan ujung baris UNIX di editor Anda).
Jalankan situs secara lokal dengan:
docker compose up
Ini akan membuat situs tersedia secara lokal di - 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.
Setiap perubahan yang dilakukan pada situs di editor Anda akan diambil di dalam wadah dan situs akan diregenerasi ( perhatikan ini tidak termasuk perubahan ke _config.yml , Anda harus memulai kembali wadah Docker untuk mengambil perubahan tersebut).
Misalnya, jika Anda menambahkan posting Anda sendiri di _posts/2018-07-31-my-post.md Anda akan melihat Jekyll mendeteksi perubahan dan meregenerasi situs, menyegarkan browser Anda akan mengambil perubahan apa pun.
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/ Bagian kontributor di halaman arahan sedang dihasilkan menggunakan skrip node kecil yang terletak di file generate-stats.js . Dianjurkan agar Anda menjalankan skrip ini sebelum membuka PR. Ini akan memastikan bagian kontributor terkini:
node generate-stats.js
Catatan: Membutuhkan Node.js untuk diinstal pada sistem Anda.
Untuk memiliki posting blog yang dikaitkan dengan baik dengan penulis, mereka harus ditambahkan ke tim dengan membuat file <author_name>.md di direktori _staff_members .
Tampilan anggota tim di halaman tim didasarkan pada posisi dalam file data/anggota.yml.
Atribusi dalam posting blog didasarkan pada nama file.
Misalnya, _staff_members/alex.md dapat digunakan untuk atribusi dengan mengatur metadata berikut:
author_staff_member: alex
Yang menghasilkan kotak penulis yang ditampilkan dengan setiap posting yang ditetapkan:
Definisi penulis mengambil format berikut:
---
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>.
---
| Kunci | Detail |
|---|---|
| nama | Nama lengkap penulis yang berkontribusi |
| posisi | Deskripsi teks gratis tentang hubungan mereka dengan proyek |
| image_path | Jalur ke potret penulis, ini harus menjadi gambar 154px * 154px |
| twitter_username | Penulis Twitter Handle (tanpa @ ) |
| uraian | Informasi teks gratis tentang pengguna, ini harus sangat singkat |
### menyumbangkan posting
Berkontribusi sebuah pos sama lurus ke depan seperti menaikkan PR yang berisi posting Anda dalam format markdown bersama dengan gambar tertanam.
Markdown posting Anda harus dibuat di direktori _posts dan file harus mengambil struktur berikut.
yyyy-mm-dd-short-description-of-post.md
Jika Anda ragu, lihat posting yang ada untuk ide tentang apa yang bisa diterima.
Pos tersebut terdiri dari dua bagian, header materi depan YAML yang menjelaskan pos dan memberikan jekyll dengan isyarat untuk rendering/atribusi dll, dan badan pos yang hanya penurunan harga standar.
Metadata posting mengambil formulir berikut:
---
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/
---
| Kunci | Detail |
|---|---|
| judul | Judul posting blog |
| tanggal | Publikasikan tanggal posting blog dalam format yyyy-mm-dd |
| gambar | Jalur ke gambar yang akan ditampilkan di belakang judul, ini harus ditambahkan dalam direktori dengan nama yang sama seperti posting blog di bawah direktori images . |
| kategori | Daftar kategori opsional yang diawasi postingan, Anda harus selalu menggunakan kembali kategori yang ada dari posting sebelumnya jika layak |
| Author_staff_member | Nama File Penulis di Direktori _staff_members , digunakan untuk atribusi (lihat bagian sebelumnya) |
| Canonical_url | Anda harus mengatur bidang ini jika posting blog telah diterbitkan di URL lain. Preferensi diberikan pada konten asli. |
Sementara Jekyll mendukung banyak format, Anda harus mengirimkan posting Anda dalam format Markdown.
Panduan berikut menjelaskan sintaks:
Ini juga sangat berguna untuk membandingkan posting yang ada dengan file penurunan harga yang mendasari ketika Anda ingin belajar cara memformat posting Anda.
Menambahkan gambar menggunakan format penurunan harga normal, dan sementara gambar eksternal mungkin lebih disukai bahwa Anda memasukkan gambar apa pun dalam PR Anda, ini harus masuk dalam direktori dengan nama yang sama dengan pos di bawah direktori images , misalnya images/kubernetes-operator-crd/ .
Catatan berhati -hati untuk hanya memasukkan ukuran gambar yang masuk akal, Anda harus memastikan bahwa Anda telah mengubah ukuran/memproses gambar apa pun sebelum menambahkannya ke PR Anda.
Situs ini menggunakan bahasa Sass Stylesheet, setiap perubahan pada situs terlihat dan nuansa harus dibuat menggunakan sass, jangan berkontribusi file .css mentah.
Kami juga menggunakan Bulma sebagai kerangka kerja CSS kami. Sebelum membuat perubahan gaya / penambahan, harap pertimbangkan:
Navbar dan footer situs dikonfigurasi melalui YAML di file berikut:
_data/footer.yml_data/navigation.ymlMenambahkan entri ke keduanya harus sebagai pilihan terakhir karena mereka tidak boleh menjadi berantakan.
Untuk pemahaman yang lebih rinci tentang bagaimana situs ini dibangun, silakan merujuk ke dokumentasi halaman Jekyll dan GitHub:
Situs ini juga menggunakan plugin berikut:
Lihat dokumen di atas untuk detail tentang bagaimana setiap plugin dapat digunakan dan dikonfigurasi.
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
