Files
iotlcm/website/pages/guide/tutorial.md
T
技小云 d78379486c feat: 新增开源版官网骨架 website/,并接入部署编排与网关路由
- website/:VitePress 官网工程(首页/功能/对比/快速开始/部署运维/教程/社区),与文档站同构
- 两种形态由 SITE_BASE 决定:/www/ 子路径(过渡)与 / 根路径(独立域名),内容同源
- deploy/:新增 with-website profile、网关 /www/ 路由、多域名 website vhost 段
- Makefile:新增 website 镜像条目与 make website 目标
- 教程页给出部署/使用两支视频的元数据与录制要求,官网留有教程入口
2026-11-04 10:41:05 +08:00

2.8 KiB

title, description, outline
title description outline
教程视频 部署与使用的录屏教程 deep

教程视频

开源版的上手路径只有两条:把平台跑起来(部署)与把平台用起来(使用)。两条路径各一支录屏视频,文字文档只作配套说明,不替代视频。

部署教程

项 内容
标题 iotLCM 开源版部署教程:从零到可用
目标观众 第一次接触本项目、具备 Linux 与 Docker 基础的开发者与实施工程师
时长 12 ~ 15 分钟
发布位置 官网本页 + 源码仓库 README 顶部 + B 站
关联文档 快速开始、部署与运维
关联仓库路径 deploy/、website/、docs/

视频覆盖:

  1. 环境准备:Docker 与 Compose 版本检查、端口占用确认、机器规格建议
  2. 取代码:git clone 公开仓库,确认目录结构
  3. 启动:docker compose up -d,观察 MySQL 初始化日志直到种子数据导入完成
  4. 验证:登录管理端、打开文档站与 OpenAPI 文档、跑一次状态查询
  5. 收尾:改默认口令、停栈与清理数据卷

使用教程

项 内容
标题 iotLCM 开源版使用教程:核心功能实操
目标观众 已完成部署、准备给业务方上手的管理员与运营人员
时长 15 ~ 20 分钟
发布位置 官网本页 + 源码仓库 README 顶部 + B 站
关联文档 功能、文档站的使用手册
关联仓库路径 admin-svr/、admin-ui/、openapi/、worker-svr/

视频覆盖:

  1. 卡信息:列表检索、按三码查卡、卡详情与用量查看
  2. 库存与划拨:入库后的代理商维度划拨
  3. 资费与业务受理:套餐配置、开通/续费/停复机、达量断网
  4. 通道与批次:通道配置查看、批量操作与异步进度
  5. 对外接口:申请 API 凭证并完成一次真实调用
  6. 账号与工单:企业用户与角色、告警工单处理

视频文件放置约定

成片放在仓库的 website/public/videos/ 下,文件名用小写连字符加版本号(如 deploy-tutorial-v1.mp4),页面里以相对路径引用:

<video controls src="/videos/deploy-tutorial-v1.mp4"></video>

若改投 B 站等外部托管,页面保留外链入口即可,视频文件不进仓库(避免仓库体积膨胀)。

录制备忘

  • 录屏环境用与观众一致的环境:干净的 Ubuntu + Docker Compose V2,不要在已有业务实例上录
  • 涉及口令的片段一律打码,示例口令用编排里的默认值
  • 步骤与 快速开始 严格一致,视频里出现的每条命令都必须能原样复制执行
  • 每个视频产出配套字幕或要点说明(Markdown),随视频一起发布