教程维护

教程 tutorial 维护

教程 维护使用文档，是为了方便助教维护管理与教程资料相关的内容。

使用场景

• 教程内容错误。
• 知识模块关联的 教程 不对应。
• 新增一个单独的 教程 卡片。
• 章节的 教程 新增（资料服务）。

更新方式

资料服务更新

详细步骤

1. 更新资料服务(注意，这个步骤是大前提)

2. 跟进讲师编写好教程，并提交到 main 分支

3. 更新 tutorial 项目结构，产生新的文档服务

4. 获取学员系统课程 id 和阶段的 id（数字格式）

5. 登录 V2 版本学员系统，在“我的课程”中找到需要绑定 教程 的课程学员系统的课程 id 为 url 中资源路径的末端。

6. 进入课程详情页，打开开发者工具 F12，刷新页面，查看与课程标识同名的接口，查看 sections 数组中对应阶段的 id。

7. 刷新缓存，构建完成之后，需要刷新课程的缓存信息。 需要对用到此章节的课程进行刷新操作，刷新使用的课程 id 来源于第 2 步骤

教程 内容错误（链接无变化）

功能说明

在助教检查系统的 教程 的时候，发现了内容有错误，仅需要更新 教程 的内容，不需要更新关联关系

步骤说明

详细步骤

1. 更新资料服务 参照 资料服务更新

教程 内容错误（链接有变化）

功能说明

在助教检查系统的 教程 的时候，发现了内容有错误，需要更新 教程 的内容及关联关系

步骤说明

详细步骤

1. 更新资料服务 参照 资料服务更新
2. 在学员系统的页面打开开发者的网络页签，找到 教程 的 id
3. 在学员系统后端接口使用 教程 的 id 进行 教程 更新操作
4. 刷新缓存 参照 资料服务更新 的详细步骤 3

知识模块关联的 教程 不对应

功能说明

在助教检查系统的 教程 的时候，发现了内容关联错误，仅需要更新的关联关系

步骤说明

详细步骤

1. 进入教程服务中，找到正确的 教程 的链接地址
2. 在学员系统后端进行 教程 的修改操作 参考 教程 内容错误（链接有变化）详细步骤 3
3. 刷新缓存 参照 资料服务更新 的详细步骤 3

新增一个单独的 教程 卡片

功能说明

某些时候，例如某个营销课程需要外放一个 教程

步骤说明

详细步骤

1. 更新 教程 服务 参照 资料服务更新 的详细步骤 1
2. 在学员系统开发环境上添加 教程，此时会返回 教程 的 id
3. 在学员系统的页面打开开发者的网络页签，找到章节的 id
4. 在学员系统开发环境上使用章节 id 和 教程 的 id 进行 教程关联 即章节的更新操作
5. 刷新缓存 参照 资料服务更新 的详细步骤 3

章节的 教程 新增（资料服务）

• 注意：这部分内容通常由讲师完成，除非特殊情况，建议由助教敦促讲师完成

• 在 Book 中，点击链接找到自己要更新的模块。比如 performance 就是性能。

• 点击对应的子模块进入目录。将项目 clone 下来。
• 然后将 教程 更新到对应目录下面。注意 教程 更新的规则，目录一定要与大纲的级别、编程语言对应。
• 注意，一定要在本地分支修改之后，走 MergeRequest 的方式合入到 main 分支。
• 合入成功之后，则参考 【更新资料服务(注意，这个步骤是大前提)】之后继续更新PPT即可。