fix all readme

devsapp · May 16, 2022 · fdf1df3 · fdf1df3
1 parent 12e1f6e
commit fdf1df3
Show file tree

Hide file tree

Showing 312 changed files with 6,430 additions and 8,506 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,4 +13,5 @@ bin
 Nuget*
 .idea
 node-v12.16.1-linux-x64*
-nginx
+nginx
+index.py
diff --git a/async-task/python3/hook/index.js b/async-task/python3/hook/index.js
@@ -7,20 +7,6 @@ async function preInit(inputObj) {
     
     Tips：
     - FC Component: https://www.serverless-devs.com/fc/readme`)
-
-    try {
-        var process = require('child_process')
-        const version = (await process.execSync('s -v')).toString()
-        const versionNumber = version.match(/s: 2\.0\.(.*?),/)[1]
-        if (Number(versionNumber) < 103) {
-            console.log('\x1B[31m%s\x1B[0m', '    * The application requires that the version of Serverless Devs is at least 2.0.103')
-            console.log('\x1B[31m%s\x1B[0m', '    * Plaese upgraded through [npm install -g @serverless-devs/s]\n\n')
-        }
-    } catch (e) {
-        console.log(e)
-        console.log(`    - Serverless Devs Version >= v2.0.103
-        `)
-    }
 }
 
 async function postInit(inputObj) {

diff --git a/async-task/python3/publish.yaml b/async-task/python3/publish.yaml
@@ -1,6 +1,6 @@
 Type: Application
 Name: start-async-task-python3
-Version: 0.1.5
+Version: 0.1.15
 Provider:
   - 阿里云
 Description: 快速部署一个 Python 3.6 的 async task 函数到阿里云函数计算。

diff --git a/async-task/python3/readme.md b/async-task/python3/readme.md
@@ -1,62 +1,84 @@
-# 阿里云函数计算 Python3.6 Async Task 函数案例
+# start-async-task-python3 帮助文档
 
-<toc>
+<p align="center" class="flex justify-center">
+    <a href="https://www.serverless-devs.com" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=start-async-task-python3&type=packageType">
+  </a>
+  <a href="http://www.devsapp.cn/details.html?name=start-async-task-python3" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=start-async-task-python3&type=packageVersion">
+  </a>
+  <a href="http://www.devsapp.cn/details.html?name=start-async-task-python3" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=start-async-task-python3&type=packageDownload">
+  </a>
+</p>
 
-<p align="center"><b> 中文 | <a href="./readme_en.md"> English </a>  </b></p>
+<description>
 
-- [阿里云函数计算 Python3.6 Async Task 函数案例](#阿里云函数计算-python36-async-task-函数案例)
-- [快速开始](#快速开始)
-  - [通过应用中心部署](#通过应用中心部署)
-  - [通过命令行工具部署](#通过命令行工具部署)
-  - [通过阿里云CloudShell部署](#通过阿里云cloudshell部署)
-- [应用详情](#应用详情)
-- [关于我们](#关于我们)
+快速部署一个 Python 3.6 的 async task 函数到阿里云函数计算。
 
-</toc>
+</description>
 
-# 快速开始
+<table>
 
-- [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/main/async-task/python3/src)
+## 前期准备
+使用该项目，推荐您拥有以下的产品权限 / 策略：
 
-## 通过应用中心部署
+| 服务/业务 | 函数计算 |     
+| --- |  --- |   
+| 权限/策略 | AliyunFCFullAccess<br/>AliyunLogFullAccess |  
 
-<appcenter>
+</table>
 
-您可以在阿里云 [:earth_asia: Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-async-task-python3) ，快速体验该应用：   
+<codepre id="codepre">
 
-[![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=start-async-task-python3) 
+# 代码 & 预览
 
-</appcenter>
+- [ :smiley_cat:  源代码](https://github.com/devsapp/start-fc/blob/main/async-task/python3)
 
-## 通过命令行工具部署
+</codepre>
 
-> 在开始之前，需要先安装 Serverless Devs 开发者工具：`npm install @serverless-devs/s -g`，更多安装方法，可以参考[Serverless Devs 安装文档](https://www.serverless-devs.com/serverless-devs/install) ，针对阿里云还需要配置密钥信息，配置密钥信息的方法可以参考[阿里云密钥配置文档](https://www.serverless-devs.com/fc/config)
+<deploy>
 
-- 初始化项目：`s init start-async-task-python3 -d start-async-task-python3`    
-    > 涉及到确定密钥的选择、服务名称的确定、函数名称的确定以及容器镜像的确定    
-- 进入项目：`cd start-async-task-python3`
-- 部署项目：`s deploy -y`
-- 调用函数：
-   - 1. `s async-task invoke -e {} --invocation-type async`,  成功调用一次 task 函数， 预计 30s 后， 函数执行成功， 会触发调用dest-succ 函数一次 
-   - 2. `s async-task invoke -e {"mock_error":1} --invocation-type async`, 调用一次 task 函数, 预期让 task 函数执行失败一次，会触发调用 dest-fail 函数一次  
-   - 3. `s async-task invoke -e {} --invocation-type async`,  成功调用一次 task 函数， 在函数执行过程中，在控制台取消这次任务函数的执行， 会触发调用 dest-fail 函数一次  
+## 部署 & 体验
 
+<appcenter>
 
-## 通过阿里云CloudShell部署
+-  :fire:  通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-async-task-python3) ，
+[![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=start-async-task-python3)  该应用。 
+
+</appcenter>
 
-如果您不想在应用中心中快速体验，也不想下载命令行工具体验，您也可以在[ :rocket:  阿里云 CloudShell](https://api.aliyun.com/new#/tutorial?action=git_open&git_repo=https://github.com/devsapp/start-fc.git&tutorial=async-task/python3/cloudshell.md) 中快速体验。
+- 通过 [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 start-async-task-python3 -d start-async-task-python3`   
+    - 进入项目，并进行项目部署：`cd start-async-task-python3 && s deploy -y`
+
+</deploy>
+
+<appdetail id="flushContent">
 
 # 应用详情
 
+
+
 本应用仅作为学习和参考使用，您可以基于本项目进行二次开发和完善，实现自己的业务逻辑
 
-# 关于我们
 
-- Serverless Devs 工具：
-    - 仓库：[https://www.github.com/serverless-devs/serverless-devs](https://www.github.com/serverless-devs/serverless-devs)    
-      > 欢迎帮我们增加一个 :star2: 
-    - 官网：[https://www.serverless-devs.com/](https://www.serverless-devs.com/)
-- 阿里云函数计算组件：
-    - 仓库：[https://github.com/devsapp/fc](https://github.com/devsapp/fc)
-    - 帮助文档：[https://www.serverless-devs.com/fc/readme](https://www.serverless-devs.com/fc/readme)
-- 钉钉交流群：33947367    
+
+</appdetail>
+
+<devgroup>
+
+## 开发者社区
+
+您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：
+
+<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> | 
+
+</p>
+
+</devgroup>
diff --git a/async-task/python3/readme_en.md b/async-task/python3/readme_en.md
diff --git a/async-task/python3/src/readme.md b/async-task/python3/src/readme.md
@@ -1,62 +1,84 @@
-# 阿里云函数计算 Python3.6 Async Task 函数案例
+# start-async-task-python3 帮助文档
 
-<toc>
+<p align="center" class="flex justify-center">
+    <a href="https://www.serverless-devs.com" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=start-async-task-python3&type=packageType">
+  </a>
+  <a href="http://www.devsapp.cn/details.html?name=start-async-task-python3" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=start-async-task-python3&type=packageVersion">
+  </a>
+  <a href="http://www.devsapp.cn/details.html?name=start-async-task-python3" class="ml-1">
+    <img src="http://editor.devsapp.cn/icon?package=start-async-task-python3&type=packageDownload">
+  </a>
+</p>
 
-<p align="center"><b> 中文 | <a href="./readme_en.md"> English </a>  </b></p>
+<description>
 
-- [阿里云函数计算 Python3.6 Async Task 函数案例](#阿里云函数计算-python36-async-task-函数案例)
-- [快速开始](#快速开始)
-  - [通过应用中心部署](#通过应用中心部署)
-  - [通过命令行工具部署](#通过命令行工具部署)
-  - [通过阿里云CloudShell部署](#通过阿里云cloudshell部署)
-- [应用详情](#应用详情)
-- [关于我们](#关于我们)
+快速部署一个 Python 3.6 的 async task 函数到阿里云函数计算。
 
-</toc>
+</description>
 
-# 快速开始
+<table>
 
-- [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/main/async-task/python3/src)
+## 前期准备
+使用该项目，推荐您拥有以下的产品权限 / 策略：
 
-## 通过应用中心部署
+| 服务/业务 | 函数计算 |     
+| --- |  --- |   
+| 权限/策略 | AliyunFCFullAccess<br/>AliyunLogFullAccess |  
 
-<appcenter>
+</table>
 
-您可以在阿里云 [:earth_asia: Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-async-task-python3) ，快速体验该应用：   
+<codepre id="codepre">
 
-[![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=start-async-task-python3) 
+# 代码 & 预览
 
-</appcenter>
+- [ :smiley_cat:  源代码](https://github.com/devsapp/start-fc/blob/main/async-task/python3)
 
-## 通过命令行工具部署
+</codepre>
 
-> 在开始之前，需要先安装 Serverless Devs 开发者工具：`npm install @serverless-devs/s -g`，更多安装方法，可以参考[Serverless Devs 安装文档](https://www.serverless-devs.com/serverless-devs/install) ，针对阿里云还需要配置密钥信息，配置密钥信息的方法可以参考[阿里云密钥配置文档](https://www.serverless-devs.com/fc/config)
+<deploy>
 
-- 初始化项目：`s init start-async-task-python3 -d start-async-task-python3`    
-    > 涉及到确定密钥的选择、服务名称的确定、函数名称的确定以及容器镜像的确定    
-- 进入项目：`cd start-async-task-python3`
-- 部署项目：`s deploy -y`
-- 调用函数：
-   - 1. `s async-task invoke -e {} --invocation-type async`,  成功调用一次 task 函数， 预计 30s 后， 函数执行成功， 会触发调用dest-succ 函数一次 
-   - 2. `s async-task invoke -e {"mock_error":1} --invocation-type async`, 调用一次 task 函数, 预期让 task 函数执行失败一次，会触发调用 dest-fail 函数一次  
-   - 3. `s async-task invoke -e {} --invocation-type async`,  成功调用一次 task 函数， 在函数执行过程中，在控制台取消这次任务函数的执行， 会触发调用 dest-fail 函数一次  
+## 部署 & 体验
 
+<appcenter>
 
-## 通过阿里云CloudShell部署
+-  :fire:  通过 [Serverless 应用中心](https://fcnext.console.aliyun.com/applications/create?template=start-async-task-python3) ，
+[![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=start-async-task-python3)  该应用。 
+
+</appcenter>
 
-如果您不想在应用中心中快速体验，也不想下载命令行工具体验，您也可以在[ :rocket:  阿里云 CloudShell](https://api.aliyun.com/new#/tutorial?action=git_open&git_repo=https://github.com/devsapp/start-fc.git&tutorial=async-task/python3/cloudshell.md) 中快速体验。
+- 通过 [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 start-async-task-python3 -d start-async-task-python3`   
+    - 进入项目，并进行项目部署：`cd start-async-task-python3 && s deploy -y`
+
+</deploy>
+
+<appdetail id="flushContent">
 
 # 应用详情
 
+
+
 本应用仅作为学习和参考使用，您可以基于本项目进行二次开发和完善，实现自己的业务逻辑
 
-# 关于我们
 
-- Serverless Devs 工具：
-    - 仓库：[https://www.github.com/serverless-devs/serverless-devs](https://www.github.com/serverless-devs/serverless-devs)    
-      > 欢迎帮我们增加一个 :star2: 
-    - 官网：[https://www.serverless-devs.com/](https://www.serverless-devs.com/)
-- 阿里云函数计算组件：
-    - 仓库：[https://github.com/devsapp/fc](https://github.com/devsapp/fc)
-    - 帮助文档：[https://www.serverless-devs.com/fc/readme](https://www.serverless-devs.com/fc/readme)
-- 钉钉交流群：33947367    
+
+</appdetail>
+
+<devgroup>
+
+## 开发者社区
+
+您如果有关于错误的反馈或者未来的期待，您可以在 [Serverless Devs repo Issues](https://github.com/serverless-devs/serverless-devs/issues) 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态，您可以通过以下渠道进行：
+
+<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> | 
+
+</p>
+
+</devgroup>
diff --git a/async-task/python3/src/readme_en.md b/async-task/python3/src/readme_en.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,4 +13,5 @@ bin @@
     Nuget*
     .idea
     node-v12.16.1-linux-x64*
-    nginx
+    nginx
+    index.py