作為部落格寫作夥伴提供幫助
Kubernetes 有兩個官方部落格,CNCF 也有自己的部落格,你也可以在上面釋出有關 Kubernetes 的內容。請閱讀 為 Kubernetes 部落格投稿 以瞭解這兩個部落格。
當人們作為作者向任一部落格投稿時,Kubernetes 專案會將作者配對為“寫作夥伴”。本頁面解釋瞭如何履行夥伴角色。
在繼續閱讀本頁面之前,您應確保至少已閱讀了 文章提交 的大綱。
夥伴職責
作為寫作夥伴,您將
- 幫助部落格團隊準備好要合併和釋出的文章
- 支援您的夥伴創作出適合合併的內容
- 對您的夥伴撰寫的文章進行審閱
當團隊將您與另一位作者配對時,想法是你們雙方透過審閱對方的草稿文章來互相支援。大多數閱讀 Kubernetes 部落格文章的人並非專家;內容應儘量讓該受眾容易理解,或至少適當支援非專家讀者。
部落格團隊也會在從草稿到釋出的整個過程中提供幫助。他們將直接批准您的文章釋出,或者可以安排批准流程。
支援部落格團隊
您在此的主要責任是在合理的時間內溝通您的能力、可用性和進展。如果很多周過去了,您的夥伴仍未收到您的訊息,這將使整體工作耗費更長的時間。
支援您的夥伴
此過程分為兩個部分
(這是推薦的選項)
部落格團隊建議文章的主要作者使用 Google Docs 或 HackMD (由他們選擇) 設定協作編輯。然後,主要作者將該文件與以下人員共享:
- 任何聯合作者
- 您 (他們的寫作夥伴)
- 理想情況下,還包括一名指定的部落格團隊成員。
作為寫作夥伴,您將閱讀草稿文字,並直接提出建議或以其他方式提供反饋。部落格作者通常也同時是您的寫作夥伴,因此他們會以同樣的方式對您的部落格文章草稿提供反饋。
您的角色是推薦最少的更改,以使文章在釋出時看起來很好。如果有一個圖表確實不合邏輯,或者寫作非常不清晰:請提供反饋。如果您對措辭或標點符號有細微的意見分歧,請忽略。讓文章作者以他們自己的風格寫作,前提是他們符合 部落格指南。
在此準備就緒後,首席作者將開啟一個拉取請求,並使用 Markdown 提交文章。然後,您提供一個 審閱。
一些作者更喜歡從 協作編輯 開始;其他人則喜歡直接進入 GitHub。
無論他們選擇哪種方式,您的角色是提供反饋,讓部落格團隊能夠進行簡單的籤核並確認文章可以作為草稿合併。有關作者需要做什麼,請參閱 將文章提交給 Kubernetes 部落格。
使用 GitHub 的建議功能指出任何必需的更改。
一旦 Markdown 和其他內容 (如圖片) 看起來沒問題,您就提供一個正式的 審閱。
拉取請求審閱
請遵循《審閱拉取請求》中有關 部落格的部分。
當您認為開啟的部落格拉取請求足夠好可以合併時,在拉取請求中新增 /lgtm
命令。
這表示“我同意”(looks good to me) 的意見,並會指示倉庫自動化工具 (Prow) 繼續處理。/lgtm
命令可以讓您發表意見,無論您是否是 Kubernetes 專案的正式成員。
您或文章作者應該告知部落格團隊,有一篇文章已準備好進行籤核。根據提交指南的說明,它應該已經在 front matter 中標記為 draft: true
。
後續步驟
對於您作為寫作夥伴,沒有第四步。一旦拉取請求可以合併,部落格團隊 (或貢獻者站點的貢獻者溝通團隊) 將接手處理。根據反饋,您可能需要返回到之前的步驟,但通常您可以期望您的夥伴工作已經完成。