服务商文档上线流程

本文介绍服务商如何将文档发布到计算巢GitHub文档库中。

前提条件

服务已经发布上线。

操作步骤

  1. 提交工单页面中提交计算巢服务申请文档链接,或根据计算巢控制台提供的钉钉交流群的二维码,加入计算巢的技术交流群,在钉钉群内交流。

    说明

    在工单的内容描述处,需要填写服务的中英文名称。

  2. 计算巢服务会根据工单中的产品名生成GitHub文档库链接。例如:https://github.com/aliyun-computenest/quickstart-gbase。

  3. 获取GitHub文档库链接后,填写服务实例部署文档内容。

    部署文档的格式为MarkDown格式。您可以在本地使用MarkDown完成部署文档的编辑后直接上传,也可以在计算巢GitHub文档库中直接编辑。

    • 上传本地文件

      1. 在GitHub文档库中,单击Add File,在弹出的弹框中选择Upload files

      2. 在上传界面,上传本地文档。上传

    • 在线编辑部署文档

      1. 在GitHub文档库中,单击Add File,在弹出的弹框中选择Create new file

      2. 在新增界面,填写文档名称和文档内容。在线编辑

  4. 上传或编辑完成后,单击Pull requests更新文档。

  5. 再单击New pull request,待计算巢官方审核通过后,会自动合并到主干并自动更新到网页。

    New pull request

后续步骤

完成上线后,可以在服务实例部署界面,单击服务部署和使用说明进入页面,查看详细的部署指导。

查看部署文档