colossal-cloud-docs-assets

国内潞晨云镜像文档说明

该项目以镜像文档作为静态资源，通过 github pages 部署。潞晨云文档前端将会远程调用该仓库的镜像文档。

文档结构

图片放在images/目录下，视频放在videos/目录下。镜像相关MarkDown 文件放在pages/目录下，应用启动器相关MarkDown 文件放在aiapp/目录下。pages.json即为导出的镜像文档，通过 pre-commit 自动配置，一般不需要关心。

注意事项

1. 需要安装 python(>3.5) 和 pre-commit，安装完成后，repo 根目录下执行pre-commit install，pages.json 如需手动配置，git commit 时加上--no-verify即可。

1. MarkDown 文件放在pages/目录下。pages/不支持多级目录。

1. 视频一定要压缩

• 视频压缩推荐网站：https://compress-video.file-converter-online.com

1. md 文档不要出现文件头，会导致资源无法获取

• 错误 ❌ 🌰：

---
title: Open-Sora
tags: [open-sora 1.1 inference]
---

# Open-Sora 1.1

• 正确 ✅ 🌰：

# Open-Sora 1.1

1. 图片或视频的 url 的同时支持相对 URL 如../images/DeepSpeed_1.png 和 远程 URL https://assets.luchentech.com/images/DeepSpeed_1.png。使用远程 URL，需要将图片视频上传到 repo main 分支，并且跑完流水线才会生效。视频如要是用相对 URL 则无法预览，但不影响线上文档实际渲染。

1. 视频请遵循以下格式，以远程 URL 为例：

<p align="center">
  <video width="640" height="360" controls>
      <source src="https://assets.luchentech.com/videos/{文件全称}" type="video/{文件后缀}"></source>
  </video>
</p>

🌰：llama3_inference.mp4

<p align="center">
  <video width="640" height="360" controls>
      <source src="https://assets.luchentech.com/videos/llama3_inference.mp4" type="video/mp4"></source>
  </video>
</p>

1. 文档更新，并且流水线跑完后，请联系管理员更新部署。

• dev 环境：http://211.102.192.109:30080/doc/
• 线上：https://cloud.luchentech.com/doc/

1. ](../images/和../videos/字段只能出现在图片和视频的 URL 上，其他地方要规避出现上述两种字段，不然会被替换成远程 baseURL https://assets.luchentech.com/。

PR 发起流程

该仓库主分支 main 不支持直接提交，需要提交自己的分支（从 main 分支切出），然后发起 PR 到主分支。

1. 需要安装 python(>3.5) 和 pre-commit，安装完成后，repo 根目录下执行pre-commit install。

2. 切换到 main 分支，拉取远程更新，并切出自己分支

git checkout main && git pull && git checkout -b {your_branch_name}

1. 对 repo 进行编辑，编辑完成后，在本地文件夹打开终端并输入

git add . && git commit -m "{your_commit_message}"

1. 提交到远程

git push --set-upstream origin {your_branch_name}

如再次推送该分支执行git push 即可

1. 提交 PR 到主分支

2. PR 合并完成，并跑完流水线，请联系管理员更新部署。