Merge pull request #30 from devsapp/new_docs

update docs

Author: anycodes

async-task/python3/cloudshell.md

@@ -1,6 +1,6 @@
-# 快速体验 Python3.6 Event 函数案例
+# 快速体验 Python3.6 Async Task 函数案例
 
-欢迎您使用Serverless Devs开发者工具进行项目开发，本实验是基于Serverless Devs部署 Python3.6 Event 案例到阿里云函数计算。
+欢迎您使用Serverless Devs开发者工具进行项目开发，本实验是基于Serverless Devs部署 Python3.6 Async Task 案例到阿里云函数计算。
 
 整个实验过程包括：
 - [下载工具](#下载工具)
@@ -9,7 +9,7 @@
 - [部署项目](#部署项目)
 - [更多信息](#更多信息)
 
-> - [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/master/event-function/fc-event-python3.6/src)
+> - [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/master/async-task/python3/src)
 
 ## 下载工具
 
@@ -38,14 +38,14 @@ npm install -g @serverless-devs/s
 进行项目初始化：
 
 ```
-s init start-fc-event-python3 -d start-fc-event-python3
+s init start-async-task-python3 -d start-async-task-python3
 ```
 
 在初始化的过程中，可能涉及到部分服务的开通、参数的获取以及参数的定义，请根据命令行的提醒进行具体的操作。
 
 ## 部署项目
 
-- 进入项目：`cd start-fc-event-python3`
+- 进入项目：`cd start-async-task-python3`
 - 进行项目的部署：`s deploy`
 
 稍等片刻，即可完成项目的部署。

async-task/python3/publish.yaml

@@ -1,6 +1,6 @@
 Type: Application
 Name: start-async-task-python3
-Version: 0.0.2
+Version: 0.1.1
 Provider:
   - 阿里云
 Description: 快速部署一个 Python 3.6 的 async task 函数到阿里云函数计算。
@@ -13,8 +13,43 @@ Category: 新手入门
 Service:
   函数计算:
     Authorities:
-      - 创建函数
-      - 删除函数
-      - 创建服务
-      - 删除服务
-    Runtime: Python
+      - AliyunFCFullAccess
+      - AliyunLogFullAccess
+    Runtime: custom container
+Parameters:
+  type: object
+  additionalProperties: false # 不允许增加其他属性
+  required: # 必填项
+    - region
+    - serviceName
+  properties:
+    region:
+      title: 地域
+      type: string
+      default: cn-hangzhou
+      description: 创建应用所在的地区
+      enum:
+        - cn-beijing
+        - cn-hangzhou
+        - cn-shanghai
+        - cn-qingdao
+        - cn-zhangjiakou
+        - cn-huhehaote
+        - cn-shenzhen
+        - cn-chengdu
+        - cn-hongkong
+        - ap-southeast-1
+        - ap-southeast-2
+        - ap-southeast-3
+        - ap-southeast-5
+        - ap-northeast-1
+        - eu-central-1
+        - eu-west-1
+        - us-west-1
+        - us-east-1
+        - ap-south-1
+    serviceName:
+      title: 服务名
+      type: string
+      default: async-task-service
+      description: 服务名称，只能包含字母、数字、下划线和中划线。不能以数字、中划线开头。长度在 1-128 之间

async-task/python3/readme.md

@@ -1,25 +1,61 @@
-# 阿里云函数计算 Python 3.6 async task 案例
+# 阿里云函数计算 Python3.6 Async Task 函数案例
 
-只需几步就可以快速在阿里云函数计算服务上体验 Python 3.6 的 async task：
+<toc>
 
-- 初始化项目：`s init start-async-task-python3`
+<p align="center"><b> 中文 | <a href="./readme_en.md"> English </a>  </b></p>
+
+- [快速开始](#快速开始)
+    - [通过应用中心部署](#通过应用中心部署)
+    - [通过命令行工具部署](#通过命令行工具部署)
+    - [通过阿里云CloudShell部署](#通过阿里云CloudShell部署)
+- [应用详情](#应用详情)
+- [关于我们](#关于我们)
+
+</toc>
+
+# 快速开始
+
+- [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/master/async-task/python3/src)
+
+## 通过应用中心部署
+
+<appcenter>
+
+您可以在阿里云 [:earth_asia: 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>
+
+## 通过命令行工具部署
+
+> 在开始之前，需要先安装 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)
+
+- 初始化项目：`s init start-async-task-python3 -d start-async-task-python3`    
+    > 涉及到确定密钥的选择、服务名称的确定、函数名称的确定以及容器镜像的确定    
 - 进入项目：`cd start-async-task-python3`
-- 部署项目：`s deploy`
-- 触发项目
-  - 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 函数一次  
-
-即可实现`Python 3.6` async task 案例的初始化、部署整个流程。
-
-> 本应用仓库地址：https://github.com/devsapp/start-fc
-
-------------------------------------
-> # More
-> 欢迎您使用阿里云函数计算 FC 组件进行项目开发   
-> 组件仓库地址/帮助文档：https://github.com/devsapp/fc   
-> Yaml参考文档：https://github.com/devsapp/fc/blob/main/docs/zh/yaml.md   
-> 快速入门：
->   - 快速创建应用：https://github.com/devsapp/fc/blob/main/docs/zh/quick_start_application.md
->   - 快速使用命令：https://github.com/devsapp/fc/blob/main/docs/zh/quick_start_function.md
-------------------------------------
+- 部署项目：`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 函数一次  
+
+
+## 通过阿里云CloudShell部署
+
+如果您不想在应用中心中快速体验，也不想下载命令行工具体验，您也可以在[ :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 工具：
+    - 仓库：[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    

async-task/python3/readme_en.md

@@ -1,4 +1,4 @@
-# Alibaba Cloud Function Compute Python3.6 Event function case
+# Alibaba Cloud Function Compute Python3.6 Async Task function case
 
 <toc>
 
@@ -13,17 +13,20 @@
 
 # Quick start
 
-- [:octocat: source](https://github.com/devsapp/start-fc/tree/master/event-function/fc-event-python3.6/src)
+- [:octocat: source](https://github.com/devsapp/start-fc/tree/master/async-task/python3/src)
 
 ## Deploy via command line tools
 
 > Before starting, you need to install the Serverless Devs developer tools: `npm install @serverless-devs/s -g`, for more installation methods, please refer to [Serverless Devs Installation Documentation](https://www.serverless-devs.com/serverless-devs/install) , you also need to configure key information for Alibaba Cloud. For the method of configuring key information, please refer to [Alibaba Cloud Key Configuration Document](https://www.serverless-devs.com/fc/config)
 
-- Initialize the project: `s init start-fc-event-python3 -d start-fc-event-python3`
+- Initialize the project: `s init start-async-task-python3 -d start-async-task-python3`
     > It involves determining the selection of the key, the determination of the service name, the determination of the function name, and the determination of the container image
-- Enter the project: `cd start-fc-event-python3`
+- Enter the project: `cd start-async-task-python3`
 - Deploy the project: `s deploy -y`
-- Invoke function: `s invoke -e '{"key":"val"}'`
+- Invoke function:
+   - 1. `s async-task invoke -e {} --invocation-type async`,  The task function is called successfully once. It is expected that after 30s, the function will be executed successfully, which will trigger the call of DeST succ function once
+   - 2. `s async-task invoke -e {"mock_error":1} --invocation-type async`, Call the task function once. It is expected that if the task function fails once, it will trigger the call of DeST fail function once
+   - 3. `s async-task invoke -e {} --invocation-type async`,  Successfully call the task function once. During the function execution, canceling the execution of the task function on the console will trigger the call of DeST fail function once
 
 # Application details
 

async-task/python3/src/readme.md

@@ -1,25 +1,61 @@
-# 阿里云函数计算 Python 3.6 async task 案例
+# 阿里云函数计算 Python3.6 Async Task 函数案例
 
-只需几步就可以快速在阿里云函数计算服务上体验 Python 3.6 的 async task：
+<toc>
 
-- 初始化项目：`s init start-async-task-python3`
+<p align="center"><b> 中文 | <a href="./readme_en.md"> English </a>  </b></p>
+
+- [快速开始](#快速开始)
+    - [通过应用中心部署](#通过应用中心部署)
+    - [通过命令行工具部署](#通过命令行工具部署)
+    - [通过阿里云CloudShell部署](#通过阿里云CloudShell部署)
+- [应用详情](#应用详情)
+- [关于我们](#关于我们)
+
+</toc>
+
+# 快速开始
+
+- [:octocat: 源代码](https://github.com/devsapp/start-fc/tree/master/async-task/python3/src)
+
+## 通过应用中心部署
+
+<appcenter>
+
+您可以在阿里云 [:earth_asia: 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>
+
+## 通过命令行工具部署
+
+> 在开始之前，需要先安装 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)
+
+- 初始化项目：`s init start-async-task-python3 -d start-async-task-python3`    
+    > 涉及到确定密钥的选择、服务名称的确定、函数名称的确定以及容器镜像的确定    
 - 进入项目：`cd start-async-task-python3`
-- 部署项目：`s deploy`
-- 触发项目
-  - 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 函数一次  
-
-即可实现`Python 3.6` async task 案例的初始化、部署整个流程。
-
-> 本应用仓库地址：https://github.com/devsapp/start-fc
-
-------------------------------------
-> # More
-> 欢迎您使用阿里云函数计算 FC 组件进行项目开发   
-> 组件仓库地址/帮助文档：https://github.com/devsapp/fc   
-> Yaml参考文档：https://github.com/devsapp/fc/blob/main/docs/zh/yaml.md   
-> 快速入门：
->   - 快速创建应用：https://github.com/devsapp/fc/blob/main/docs/zh/quick_start_application.md
->   - 快速使用命令：https://github.com/devsapp/fc/blob/main/docs/zh/quick_start_function.md
-------------------------------------
+- 部署项目：`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 函数一次  
+
+
+## 通过阿里云CloudShell部署
+
+如果您不想在应用中心中快速体验，也不想下载命令行工具体验，您也可以在[ :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 工具：
+    - 仓库：[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