VMware Tanzu Labs Educates培训平台工作坊内容编写指南

工作坊内容格式概述

VMware Tanzu Labs Educates培训平台是一个功能强大的教学工具，它支持两种主要的内容格式：Markdown和AsciiDoc。这两种格式各有特点，开发者可以根据个人偏好选择使用。

对于Markdown格式，文件扩展名应为.md；而AsciiDoc格式则应使用.adoc扩展名。平台提供了两种渲染引擎：classic和hugo。其中hugo渲染器仅支持Markdown格式，这与Hugo静态网站生成器的特性保持一致。

图片资源管理

在内容创作过程中，图片资源的管理方式取决于所选的渲染引擎：

• 使用classic渲染器时，图片可以直接放在与Markdown或AsciiDoc文件相同的目录中
• 使用hugo渲染器时：
  • 如果使用单个.md文件，图片需要放置在workshop/static目录下
  • 如果使用页面包（page bundle，即包含index.md文件的目录），图片可以放在该页面包目录内（仅当图片专用于该页面时）

交互式命令标注

Educates平台的一个强大特性是能够将代码块转换为可交互元素，允许学员直接点击执行命令。

基本命令执行

在Markdown中，使用以下语法标注可执行命令：

```execute
echo "执行此命令"
```

在AsciiDoc中，则使用role注解：

[source,bash,role=execute]
----
echo "执行此命令"
----

多终端控制

当工作坊配置了多个终端时，可以通过后缀指定目标终端：

```execute-1
echo "在终端1执行"
```

```execute-2
echo "在终端2执行"
```

要同时在所有终端执行命令：

```execute-all
clear
```

中断运行中的命令

要中断正在运行的命令：

```terminal:interrupt
session: 1
```

文本复制功能

除了执行命令，还可以设置可点击复制的文本内容：

```copy
echo "复制这段文本"
```

```copy-and-edit
echo "复制并编辑这段文本"
```

AsciiDoc中的实现方式：

[source,bash,role=copy]
----
echo "复制这段文本"
----

[source,bash,role=copy-and-edit]
----
echo "复制并编辑这段文本"
----

增强型点击操作

平台提供了更灵活的YAML格式标注方式，支持更多自定义选项。

终端操作增强

```terminal:execute
command: echo "增强型命令执行"
session: 1
clear: true
```

终端输入模拟

```terminal:input
text: mypassword
session: 1
endl: false
```

终端清理

```terminal:clear-all
```

仪表板控制

工作坊内容可以包含控制仪表板的交互元素：

```dashboard:open-url
url: https://example.com/
```

```dashboard:create-dashboard
name: 示例终端
url: terminal:example
```

集成编辑器功能

当启用内置编辑器时，可以通过特殊操作控制编辑器行为：

文件操作

```editor:open-file
file: ~/exercises/example.txt
line: 10
```

```editor:append-lines-to-file
file: ~/exercises/example.txt
text: |
    这是第一行
    这是第二行
```

文本匹配与替换

```editor:select-matching-text
file: ~/exercises/example.txt
text: "search_pattern"
before: 2
after: 2
```

```editor:replace-text-selection
file: ~/exercises/example.txt
text: "replacement_text"
```

文件下载功能

平台支持直接从工作坊内容触发文件下载：

```files:download-file
path: .kube/config
download: my-kubeconfig
preview: true
```

```files:copy-file
path: .kube/config
preview: true
```

最佳实践建议

1. 对于新项目，建议使用YAML格式的增强型点击操作，它提供了更丰富的功能和更好的可维护性
2. 合理组织图片资源，特别是在使用hugo渲染器时，注意文件位置要求
3. 对于复杂的多终端场景，明确指定目标终端以避免混淆
4. 使用预览功能时，注意文件大小，避免加载过大文件影响用户体验

通过合理利用这些功能，可以创建出高度交互式、用户体验良好的技术培训内容，显著提升教学效果。