服務(wù)商文檔上線流程
本文介紹服務(wù)商如何將文檔發(fā)布到計(jì)算巢GitHub文檔庫中。
前提條件
服務(wù)已經(jīng)發(fā)布上線。
操作步驟
在提交工單頁面中提交計(jì)算巢服務(wù)申請文檔鏈接,或根據(jù)計(jì)算巢控制臺提供的釘釘交流群的二維碼,加入計(jì)算巢的技術(shù)交流群,在釘釘群內(nèi)交流。
說明在工單的內(nèi)容描述處,需要填寫服務(wù)的中英文名稱。
計(jì)算巢服務(wù)會(huì)根據(jù)工單中的產(chǎn)品名生成GitHub文檔庫鏈接。例如:https://github.com/aliyun-computenest/quickstart-gbase。
獲取GitHub文檔庫鏈接后,填寫服務(wù)實(shí)例部署文檔內(nèi)容。
部署文檔的格式為MarkDown格式。您可以在本地使用MarkDown完成部署文檔的編輯后直接上傳,也可以在計(jì)算巢GitHub文檔庫中直接編輯。
上傳本地文件
在GitHub文檔庫中,單擊Add File,在彈出的彈框中選擇Upload files。
在上傳界面,上傳本地文檔。
在線編輯部署文檔
在GitHub文檔庫中,單擊Add File,在彈出的彈框中選擇Create new file。
在新增界面,填寫文檔名稱和文檔內(nèi)容。
上傳或編輯完成后,單擊Pull requests更新文檔。
再單擊New pull request,待計(jì)算巢官方審核通過后,會(huì)自動(dòng)合并到主干并自動(dòng)更新到網(wǎng)頁。
后續(xù)步驟
完成上線后,可以在服務(wù)實(shí)例部署界面,單擊服務(wù)部署和使用說明進(jìn)入頁面,查看詳細(xì)的部署指導(dǎo)。