Educates培训平台：从零开始创建技术工作坊教程

工作坊创建概述

Educates培训平台是一个基于Kubernetes的技术培训解决方案，它允许开发者创建和部署交互式技术培训工作坊。本文将详细介绍如何使用Educates命令行工具创建、部署和管理技术工作坊。

准备工作坊环境

在开始创建工作坊前，需要确保已经正确安装并配置了Educates命令行工具。该工具提供了创建新工作坊的模板功能，能够快速搭建工作坊的基本框架。

创建工作坊基础结构

使用以下命令生成一个新工作坊：

educates new-workshop lab-new-workshop

命令说明：

• lab-new-workshop是工作坊目录名称
• 名称必须符合RFC 1035标签命名规范
• 建议名称以lab-为前缀
• 名称长度建议不超过25个字符

最佳实践建议：

1. 工作坊名称全部使用小写字母
2. 避免使用特殊字符，仅使用连字符"-"作为分隔符
3. 名称应具有描述性，便于识别工作坊内容

工作坊内容渲染器选择

Educates支持两种内容渲染器：

1. Hugo渲染器（推荐）：

   • 基于Hugo静态网站生成器
   • 仅支持Markdown格式
   • 性能更好，功能更丰富

2. Classic渲染器（已弃用）：

   • 自定义动态Web应用
   • 支持Markdown和AsciiDoc
   • 未来版本将移除

如需创建使用Classic渲染器的工作坊，可添加--template classic参数：

educates new-workshop lab-new-workshop --template classic

工作坊目录结构解析

生成的工作坊包含以下核心文件和目录：

lab-new-workshop/
├── README.md                  # 工作坊说明文档
├── workshop/                  # 工作坊内容目录
│   ├── content/               # 教学材料目录
│   └── config.yaml            # Hugo渲染器配置文件(可选)
├── resources/                 # Kubernetes资源配置
│   └── workshop.yaml          # 工作坊部署描述文件
└── exercises/                 # 练习文件目录(可选)

部署工作坊流程

完整部署工作坊需要以下步骤：

1. 发布工作坊内容：

   educates publish-workshop
   

   该命令将工作坊内容打包为OCI镜像并推送到本地镜像仓库

2. 部署工作坊环境：

   educates deploy-workshop
   

   在Kubernetes集群中创建工作坊环境

3. 访问工作坊：

   educates browse-workshops
   

   打开浏览器访问培训门户

4. 查看访问凭证（如需）：

   educates view-credentials
   

内容开发与测试

修改教学内容

1. 编辑workshop/content/目录下的Markdown文件
2. 发布更新：

   educates publish-workshop
   

3. 创建新的工作坊会话查看更改

实时开发模式

使用Hugo渲染器时，可启用实时重载功能：

educates serve-workshop --patch-workshop

此模式下：

• 修改内容会自动刷新浏览器
• 无需重复发布工作坊
• 按Ctrl+C退出实时模式

更新工作坊定义

修改resources/workshop.yaml后，执行：

educates update-workshop

练习文件管理

最佳实践：

1. 将所有练习文件放入exercises/目录
2. 终端和编辑器默认工作目录将设置为该目录
3. 在指导中使用完整路径（如~/exercises/example-1）

清理工作坊资源

完成开发后，可删除工作坊部署：

educates delete-workshop

总结

Educates培训平台提供了完整的工具链来创建和管理技术培训工作坊。通过本文介绍的工作流程，开发者可以高效地构建交互式技术培训内容，并利用Kubernetes的强大能力提供可扩展的培训环境。无论是简单的技术演示还是复杂的手把手实验，Educates都能提供良好的支持。