Merge pull request #22 from devsapp/fix-video-process-flow

fix video-process-flow
devsapp · Feb 9, 2023 · 1f75072 · 1f75072
2 parents bfdbb4b + bcbf669
commit 1f75072
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 33 deletions.
diff --git a/video-process-flow/publish.yaml b/video-process-flow/publish.yaml
@@ -1,6 +1,6 @@
 Type: Application
 Name: video-process-flow
-Version: 0.1.3
+Version: 0.1.4
 Provider:
   - 阿里云
 Description: 基于 FC + Serverless Workflow + OSS + NAS + FFmpeg 实现的弹性高可用、并行处理的视频转码服务

diff --git a/video-process-flow/src/readme.md b/video-process-flow/src/readme.md
@@ -1,4 +1,6 @@
-# video-process-flow帮助文档
+> 注：当前项目为 Serverless Devs 应用，由于应用中会存在需要初始化才可运行的变量（例如应用部署地区、服务名、函数名等等），所以**不推荐**直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用，**强烈推荐**通过 `s init ` 的方法或应用中心进行初始化，详情可参考[部署 & 体验](#部署--体验) 。
+
+# video-process-flow 帮助文档
 
 <p align="center" class="flex justify-center">
     <a href="https://www.serverless-devs.com" class="ml-1">
@@ -14,53 +16,75 @@
 
 <description>
 
-> ***基于 FC + Serverless Workflow + OSS + NAS + FFmpeg 实现的弹性高可用、并行处理的视频转码服务***
+基于 FC + Serverless Workflow + OSS + NAS + FFmpeg 实现的弹性高可用、并行处理的视频转码服务
 
 </description>
 
-<table>
+<codeUrl>
+
+- [:smiley_cat: 代码](https://github.com/devsapp/start-ffmpeg/tree/master/video-process-flow/src)
+
+</codeUrl>
+<preview>
+
+</preview>
 
 ## 前期准备
-使用该项目，推荐您拥有以下的产品权限 / 策略：
 
-| 服务/业务 | 函数计算 |  硬盘挂载 |  VPC |  工作流 | 其它 |     
-| --- |  --- |   --- |   --- |   --- |   --- | 
-| 权限/策略 | AliyunFCFullAccess |  AliyunNASFullAccess |  AliyunVPCFullAccess |  AliyunFnFFullAccess |AliyunECSFullAccess |  
+使用该项目，您需要有开通以下服务：
 
+<service>
 
-</table>
+| 服务              | 备注                                   |
+| ----------------- | -------------------------------------- |
+| 函数计算 FC       | 转码等函数部署在函数计算               |
+| Serverless 工作流 | 视频处理工作流部署在 Serverless 工作流 |
+| 文件存储 NAS      | 视频临时处理工作区间位于文件存储 NAS   |
+| 专有网络 VPC      | NAS 挂载点需要有 VPC                   |
 
-<codepre id="codepre">
+</service>
 
-# 代码 & 预览
+推荐您拥有以下的产品权限 / 策略：
+<auth>
 
-- [:smiley_cat: 源代码](https://github.com/devsapp/start-ffmpeg/tree/master/video-process-flow)
+| 服务/业务 | 权限                | 备注                                                             |
+| --------- | ------------------- | ---------------------------------------------------------------- |
+| 函数计算  | AliyunFCFullAccess  | 创建或者更新转码等函数                                           |
+| 硬盘挂载  | AliyunNASFullAccess | 视频临时处理工作区间位于文件存储 NAS， 需要有自动创建 NAS 的权限 |
+| VPC       | AliyunVPCFullAccess | NAS 需要 VPC 挂载点， 需要有 VPC 自动创建的能力                  |
+| 工作流    | AliyunFnFFullAccess | 创建或者更新音视频处理工作流                                     |
+| 其它      | AliyunECSFullAccess | 函数计算 NAS 挂载点需要交换机和安全组， 需要有自动创建的权限     |
 
-        
+</auth>
 
-</codepre>
+<remark>
 
-<deploy>
+</remark>
+
+<disclaimers>
+
+</disclaimers>
 
 ## 部署 & 体验
 
 <appcenter>
-
+   
 - :fire: 通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=video-process-flow) ，
-[![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://fcnext.console.aliyun.com/applications/create?template=video-process-flow)  该应用。 
-
+  [![Deploy with Severless Devs](https://img.alicdn.com/imgextra/i1/O1CN01w5RFbX1v45s8TIXPz_!!6000000006118-55-tps-95-28.svg)](https://fcnext.console.aliyun.com/applications/create?template=video-process-flow) 该应用。
+   
 </appcenter>
-
+<deploy>
+
 - 通过 [Serverless Devs Cli](https://www.serverless-devs.com/serverless-devs/install) 进行部署：
-    - [安装 Serverless Devs Cli 开发者工具](https://www.serverless-devs.com/serverless-devs/install) ，并进行[授权信息配置](https://www.serverless-devs.com/fc/config) ；
-    - 初始化项目：`s init video-process-flow -d video-process-flow`   
-    - 进入项目，并进行项目部署：`cd video-process-flow&& s deploy -y`
-
+  - [安装 Serverless Devs Cli 开发者工具](https://www.serverless-devs.com/serverless-devs/install) ，并进行[授权信息配置](https://docs.serverless-devs.com/fc/config) ；
+  - 初始化项目：`s init video-process-flow -d video-process-flow `
+  - 进入项目，并进行项目部署：`cd video-process-flow && s deploy - y`
+   
 </deploy>
 
-<appdetail id="flushContent">
+## 应用详情
 
-# 应用详情
+<appdetail id="flushContent">
 
 如下图所示， 假设用户上传一个 mov 格式的视频到 OSS, OSS 触发器自动触发函数执行， 函数调用 FnF 执行，FnF 同时进行 1 种或者多种格式的转码(由 s.yaml 中的 DST_FORMATS 参数控制)， 本示例配置的是同时进行 mp4, flv, avi 格式的转码。
 
@@ -74,15 +98,19 @@
 
 ![image](https://img.alicdn.com/tfs/TB1A.PSzrj1gK0jSZFuXXcrHpXa-570-613.png)
 
-**视频示例:**
+</appdetail>
+
+## 使用文档
 
-[![Watch the video](https://img.alicdn.com/imgextra/i2/O1CN01XvnqJu1XLS8SAU7LT_!!6000000002907-2-tps-250-155.png)](http://devsapp.functioncompute.com/video/video-process-flow.mp4)
+<usedetail id="flushContent">
 
-**P.S.**  当您想要仅在一个简单的函数中直接完成视频处理逻辑时，可以参考[音视频转码Job](https://github.com/devsapp/start-ffmpeg/tree/master/transcode)
+**操作视频教程:**
 
+[![Watch the video](https://img.alicdn.com/imgextra/i2/O1CN01XvnqJu1XLS8SAU7LT_!!6000000002907-2-tps-250-155.png)](http://devsapp.functioncompute.com/video/video-process-flow.mp4)
 
+**P.S.** 当您想要仅在一个简单的函数中直接完成视频处理逻辑时，可以参考[音视频转码 Job](https://github.com/devsapp/start-ffmpeg/tree/master/transcode)
 
-</appdetail>
+</usedetail>
 
 <devgroup>
 
@@ -93,9 +121,8 @@
 <p align="center">
 
 | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407298906_20211028074819117230.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407044136_20211028074404326599.png" width="130px" > | <img src="https://serverless-article-picture.oss-cn-hangzhou.aliyuncs.com/1635407252200_20211028074732517533.png" width="130px" > |
-|--- | --- | --- |
-| <center>微信公众号：`serverless`</center> | <center>微信小助手：`xiaojiangwh`</center> | <center>钉钉交流群：`33947367`</center> | 
+| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| <center>微信公众号：`serverless`</center>                                                                                         | <center>微信小助手：`xiaojiangwh`</center>                                                                                        | <center>钉钉交流群：`33947367`</center>                                                                                           |
 
 </p>
-
-</devgroup>
+</devgroup>