中文 | English

召集令!成為Arduino文件網站的貢獻者

(感謝Arduino.cc官網開放授權,使我們得以編譯這篇文章,特此致謝!若讀者想要進一步閱讀原文,請點擊:https://blog.arduino.cc/2022/02/28/arduino-documentation-goes-open-source-for-community-contributions/?fbclid=IwAR2JXD0e2UomL8Bv4Zd81nxgIZtKSu27AED2D5vYU8SOje8jxu9aVbCkld0謝謝。)

眾所周知,Arduino是完全開源的。現在,我們(編按:在此指Arduino團隊)的文件與幫助中心網站也正式加入這樣的行列。世界各地的Arduino愛好者,皆可透過他們的公開GitHub倉儲,為Arduino官方文件網站上的內容,貢獻一己之力。

如何貢獻呢?

因所有內容皆透過GitHub倉儲處理,首先,您需要一個GitHub帳戶。

接下來,請前往Arduino的「文件倉儲(Docs repo)」或「幫助中心倉儲(Help Center repo)」。在檔案列內,您可看到「content」資料夾,請點入這個資料夾,在裡面可發現各種不同頁面。在此需注意的是,因「content」資料夾內包含多層次的子資料夾,所以您可能需要仔細找尋,直到找著您所要的頁面。(編按:請參考下圖。)

翻攝自Arduino.cc官網,特此致謝!

您可直接於GitHub網站內編輯內容,完全無需下載任何檔案。只要針對內容,提出想要的更改、建議或貢獻。接下來,您可建立一個「分支(branch)」,然後點擊「Pull request」按鈕,您所做出的內容改變,將傳送至Arduino Docs團隊,等候他們的審查。一旦您所做出的改變被採納,您將因貢獻而在Git歷史記錄中被提及。

此外,在文件網站(Docs)上、各式各樣開發板和擴充板的教學文件頁面,您可找著一個前往GitHub內正確檔案的捷徑。就在教學文件頁面的右手邊,可看見一個名為「Suggest Changes」的新欄位,在此欄位內,有一個「Edit this page」的按鈕。(編按:請參考下圖。)

翻攝自Arduino.cc官網,特此致謝!

若您想要進行編輯,請點擊此按鈕,您將直達GitHub倉儲內的相關檔案。所以,意欲貢獻者將不需深入前面所提及的「content」資料夾,以尋找相關檔案。

您可貢獻些什麼呢?

若您想貢獻所長的話,不一定只有簡單的更正或編輯,更可以提交您自己的教學文件或文章。但該如何進行呢?您可以分叉(Fork)某個倉儲,添加您自己的內容,最後建立一個「Pull request」即可。

文件與幫助中心網站上的每項內容,皆經過我們精心策畫,所以,我們無法保證您提交的更正、編輯、教學文件或文章一定會被發佈,但如果您覺得有非常寶貴的內容值得分享,我們竭誠歡迎!

在開始編寫實際內容前,請您務必閱讀指南,並盡可能在問題追踪器中總結您的提案,以便從我們的內容團隊和Arduino社群獲得反饋。

最後,請您密切注意文件與幫助中心的GitHub倉儲,以獲得成為貢獻者並加入社群的機會!

分享到社群