## Problem to solve SaaS 由于其云端开放特性，会有各种水平的用户注册并使用SaaS。 对于注册使用SaaS的新用户，需要为用户提供一个使用引导，以便用户能通过一个简短快速的流程来了解产品的内和使用方法。 现有继承的onboarding流程不够清晰，且文档存在无法访问的情况。 | learn GitLab 的CI | 进入CI/CD的提示｜ | ------ | ------ | || | 同时@warren Wong 也提供了用户Onboard的建议。 ## Proposal 当用户首次进入SaaS时，按照用户的经验及偏好进行Onboarding的流程。 流程需要为用户提供一个明确的、愉悦的体验流程，避免用户过多的记忆和提供过多的信息。 用户完成注册的项目后，在learn GitLab的页面中添加新的教学引导内容替换原有内容。 | 任务未完成 | 任务完成 | | ------ | ------ | |  |  | 本次替换的**教学内容** * 教学CI/CD 从产品实际出发，设计产品路线如下： 1. 新用户教学引导用户使用CI 用户onboarding流程完成后的learn GitLab的页面中替换现有的CI教学教学中包含：概念内容讲解、动手实验内容、实验结果检查并反馈。 1. 使用project template，编排教学内容 2. 交互使用Triage Ops ，话术奖励，并引导用户行为 3. 教学内容分步展现 1. ReadMe：放简介，提示去看Issue 4. Issue介绍CI ，并说明完成后会有下一步指导。 5. 完成指定动作后，通过Triage Ops自动发送鼓励话术和下一步内容。 | 步骤 | 描述 | webhook | 其他动作 | | --- | --- | --- | --- | | 1 | 1. 引导进入仓库创CI yaml。2. 使用指定模板 – 基础 bash。3. 提交文件。 | pipeline | 观察pipeline | | 2 | 1. 使用在线编辑 2. 添加一个test阶段的job 3. 提交 | pipeline | 观察pipeline增加了一个job | | 3 | 1. 使用在线编辑 2. 添加一个新的阶段 - review 3. 复制代码段 4. 提交 | pipeline | 观察pipeline增加了一个stage | | 4 | 1. 使用在线编辑 2. 修改review 阶段 3. 改成手动触发 4. 提交 | pipeline | 观察pipeline并手动继续 | | 5 | 1. 增加build阶段任务 2. 复制制品相关代码 3. 提交 4. 观察job的制品库。 | pipeline有制品 | 观察制品库 | | 6（待定） | 同理处理Dockerfile 软件包和镜像库 > 容器镜像库 查看 build image 作业容器镜像 | pipeline 镜像库？ | 观察镜像库 | | 7 | 关闭Issue | issue | Learn gitlab 对应内容完成 | ### User story 1. 作为用户，在试用产品时，期望能有一步一步指导的教学内容。 | Acceptance criteria | | | --- | --- | | Given | 用户 | | When | 注册成功，进入learn GitLab后 | | then | 点击“创建或导入仓库”和“设置 CI/CD“链接后，跳转对应教学指导 | 2. 作为用户，在我通过教程学习功能时，希望能有运行的反馈，让我知道运行是否成功。 | Acceptance criteria | | | --- | --- | | Given | 用户 | | When | 按照教学内容进行操作，成功完成关键节点时 | | then | 通过机器人评论的方式，给予成功的反馈，并提示下一步内容。 | User Case 1：用户进入教程 1. 用户在激活账户后登录，完成群组、项目创建引导 2. 进入展示`学习GitLab`的界面 3. 用户点击`设置您的第一个项目的CI/CD` 4. 跳转进入Learn GitLab项目中，对应教学Issue。 User Case 2：用户完成教学步骤，获得下一步指示。 1. 用户阅读教学提示内容。 2. 按照内容完成教学内容。 3. 监控程序获得动作完成信息，且判断符合当前提示内容 4. 在用户对应的Issue内，以评论方式给出下一步。 User case 3 : 回复触发及回复顺序 1. 当且仅当用户完成了learn GitLab对应Issue中第一个动作后，才会第一次回复。 2. 回复顺序严格按照文档要求 1. 即用户如果没完成前一步，但在实际操作中满足了后续某一步回复条件，也不会触发回复机制。 User case 4 : 教学内容完成 1. 用户完成既定动作中最后一步。 2. 该项教学任务完成，同一用户不再触发。 3. 完成后`学习GitLab`的界面，对应任务完成  ### **Further details：** `设置CI/CD` 需要修改的内容： - 准备在Learn GitLab项目中添加基础`.gitlab-ci.yml` 文件，确保可运行。 可以参考或复用 ……/-/ci/editor?template=Getting-Started - 修改CI/CD对应Issue内容，以符合需求内容。 - 需要有流程对用户行为进行监控，在用户完成指定动作时，作出反馈和更新。 **运行流程：** 1. 点击按钮，进入对应的Issue。（Issue在Learn GitLab 项目中） 2. Issue内简要说明和第一步引导。指示下一步为` Assign yourself` 3. 机器人评论指示下一步，点击链接，进入CI/CD 页面（带?template=Getting-Started），创建文件。 4. 提交运行pipeline，并让观察状态。（共享runner） 5. （待定）机器人评论指示下一步，修改pipeline内容（文档提供脚本复制），增加阶段-单元测试，通过提交代码运行pipeline。 6. 机器人评论指示下一步， 提示已完成，提示关闭Issue。 7. 任务完成。 ## Intended users SaaS new users ## Feature Usage Metrics 增加新用户CI的使用比例