AWS要把自家的技術文件開源,張開手歡迎外界對官方文件提出修改請求,現在開發者可以到GitHub上瀏覽並修改AWS釋出的這些文件,以程式碼版本控制的概念共同維護技術文件。

AWS在3月13日開源138份開發者與使用者手冊到GitHub,AWS表示,歡迎開發者提交修改請求,無論是修正錯誤、改進或是增加新的程式碼範例都行,另外,還可以添加詳細資訊並重新調整句子和段落以提高描述精準度。

這已經不是AWS第一次這麼做,在今年初AWS就將SDK開發者手冊放到GitHub上,並且邀請有興趣的團體貢獻文件內容。

貢獻者要參與修改AWS技術文件,必須先擁有一個GitHub帳號。當發現官方技術文件需要更改的部分,就能拜訪GitHub網頁版本的文件,並在頁面上點擊Edit on GitHub按鍵,如此便能讓貢獻者編輯文件的原始本文,而這個原始本文是用來輸出為HTML、PDF以及Kindle版本的文件。

與GitHub程式碼版本控制的概念相同,貢獻者可以先Fork一份複本獨立編輯,當編輯完成後,並在Propose file change的欄位總結改變的內容,經過確認修改部分無誤後,點擊Create pull request(PR),確認後送出請求。

這個修改的內容會視貢獻者修改的服務主題,分配給負責該服務的團隊,例如貢獻者修改了Elastic Beanstalk相關文件,則會由 Elastic Beanstalk團隊負責審核PR,他們會決定接受PR、拒絕PR,或是與貢獻者進行討論,負責的團隊必須在48小時內作出回應,而貢獻者也會接收到PR的最新處理狀態。

AWS也順帶提醒,當貢獻者新加入一個開源專案時,應該先以較小以及高水準的內容編輯,獲取經驗以及建立名聲,並且每次的PR應該長度適中,切勿在一次PR更改龐大的資料,增加審核難度。


Advertisement

更多 iThome相關內容