开始制作

基础要求

要编写交互式实验和挑战，你必须具备以下基本技能：

使用 Linux 的命令行界面，LabEx 的实验和挑战都是基于 Linux 系统。
Git 和 GitHub 用于内容的提交和版本控制。
Markdown 基本语法用于文档的编写。
JSON 文件格式用于管理配置文件。
基本的英文读写能力。
如果你在中国大陆地区，需要一个稳定的本地代理，以便于顺利访问 GitHub 和 LabEx 网站。请不要询问我们使用什么代理，我们不会回答这个问题。

当然，也同时需要你具备期望制作实验和挑战相关的专业技能知识。

认领任务

接下来，介绍作者如何在 LabEx 平台上认领任务。

筛选 Issue

认领 Issue

组织结构

我们的实验和挑战都是基于 GitHub 仓库进行组织的，每个仓库包含一个或多个实验和挑战。了解文件的组织结构对你正确提交内容非常重要。

基本说明

我们会提前创建好一个 GitHub 仓库，其中包含多个文件夹，每个实验和挑战都在一个独立的文件夹内。文档存放结构如下：

repo-name
└── linux
    ├── lab-name-1
    ├── lab-name-2
    ├── challenge-name-3
    ├── ……

其中：

linux：是一个 Skill Tree 文件夹；
lab-name-1：是一个示例 Lab 文件夹；
challenge-name-3：是一个示例 Challenge 文件夹；

格式要求

内容规范

以下是单个实验/挑战的完整内容规范。请仔细阅读，然后按照要求提交内容，我们会对内容进行 Review。

基础配置

{
  "type": "lab",
  "title": "Basic Template",
  "description": "The description of basic template",
  "difficulty": "Beginner",
  "time": 5,
  "hidden": false,
  "fee_type": "pro",
  "contributors": []
}

index.json 中存在 5 个基础配置项：

type: 必须为 lab 或者 challenge. 关于实验和挑战
title: 实验/挑战的标题，采用 Title Case 格式。通常情况下，标题与文件夹名称完全一致。
description: 简介，通常为 1 ～ 2 句话，10 ～ 100 个单词，为 intro.md 更精简的版本。
time: 预估完成时间，单位为分钟，通常为 5 的倍数，可以按每个步骤 5 分钟计算。
difficulty: 难度，必须为 Beginner，Intermediate 或者 Advanced。
hidden: 是否隐藏，默认为 False，管理员配置项，作者无需处理。
fee_type: 收费类型，默认为 Pro，管理员配置项，作者无需处理。
contributors: 贡献者列表，系统通过 GitHub 提交记录自动补充，作者无需处理。

难度定义

完整示例

下面是一个完整的配置文件示例：

index.json

{
  "type": "lab",
  "title": "Basic Template",
  "description": "The description of basic template",
  "difficulty": "Beginner",
  "time": 5,
  "hidden": false,
  "fee_type": "pro",
  "details": {
    "steps": [
      {
        "title": "Bananas",
        "text": "step1.md",
        "verify": [
          {
            "name": "Verify if bananas.txt exists",
            "file": "verify1-1.sh",
            "hint": "Please create file bananas.txt in /home/labex",
            "timeout": 0,
            "showstderr": true
          },
          {
            "name": "Verify if apples.txt exists",
            "file": "verify1-2.sh",
            "hint": "Please create apples.txt in /home/labex",
            "timeout": 10,
            "showstderr": true
          }
        ],
        "skills": ["linux/ls", "linux/cd"],
        "solutions": ["step1-solution.md", "solution2.py"]
      },
      {
        "title": "Oranges",
        "text": "step2.md",
        "verify": [
          {
            "name": "Verify if oranges.txt exists",
            "file": "verify2.sh",
            "hint": "Please create file test.txt in /home/labex",
            "timeout": 0,
            "showstderr": true
          }
        ],
        "skills": ["linux/ls", "linux/cd"],
        "solutions": ["step2-solution.md"]
      }
    ],
    "intro": {
      "text": "intro.md",
      "background": "setup.sh"
    },
    "finish": {
      "text": "finish.md"
    },
    "assets": {
      "host01": [
        {
          "file": "*.txt",
          "target": "~/"
        }
      ]
    }
  },
  "backend": {
    "imageid": "webide-ubuntu:2004"
  },
  "contributors": []
}

基础

进阶

其他

基础要求

认领任务

认领 Issue

组织结构

内容规范

基础

进阶

其他

​基础要求

​认领任务

​组织结构

​内容规范

基础要求

认领任务

组织结构

内容规范