Skip to content

Commit 0a01e9f

Browse files
authored
Merge pull request #6 from serverless-tencent/stag
fix link issue
2 parents da9691c + 06d486d commit 0a01e9f

File tree

10 files changed

+61
-65
lines changed

10 files changed

+61
-65
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ Serverless Framework 通过 CLI 工具与腾讯云紧密合作,为中国用户
1414

1515
## 开始使用
1616

17-
通过 Serverless CLI 工具可以创建,调试,部署,查看,移除 serverless 应用,马上[安装 Serverless CLI](./quickstart/installation.md) 并使用。
17+
通过 Serverless CLI 工具可以创建,调试,部署,查看,移除 serverless 应用,马上[安装 Serverless CLI](./quickstart/installation) 并使用。
1818

1919
### 函数应用开发
2020

2121
Serverless 为函数应用开发者提供了一个统一的开发框架,通过 serverelss 开发者可以快速开发,调试,部署。结合静态站点,API 网关,数据库等其他云上资源,函数应用拥有更强大的能力和使用场景。
2222

23-
开始 [使用 serverless 开发函数应用](./quickstart/function-dev.md)
23+
开始 [使用 serverless 开发函数应用](./quickstart/function-dev)
2424

2525
### 组件应用开发
2626

2727
Serveless 为使用传统框架(如:Nextjs, Express, Django 等)开发的应用提供了运行环境支持,通过 serverless 组件开发者可以继续使用传统框架开发应用,也可以通过简单改造将原有应用迁移到 serverless 平台。
2828

29-
开始 [使用 serverless 开发组件应用](./quickstart/components-dev.md)
29+
开始 [使用 serverless 开发组件应用](./quickstart/components-dev)
3030

3131
### SaaS 应用托管
3232

@@ -74,6 +74,6 @@ Serverless Components 通过定制的基础设施支持更多开发场景,如
7474

7575
目前腾讯云的函数开发也通过组件提供了支持,可以使用 SCF 组件的对应运行时组件来进行函数开发。组件相关的命令和用法对于函数 SCF 组件 同样适用。
7676

77-
> 关于 Serverless Framework 的任何使用问题、建议或者经验分享欢迎到 [Serverless 中文讨论社区](https://github.com/serverless/serverless-tencent/discussions) 分享讨论。同时使用中遇到的 bug 也欢迎通过 [BUG反馈](https://github.com/serverless/serverless-tencent/issues/new/choose) 提交并追踪。
77+
> 关于 Serverless Framework 的任何使用问题、建议或者经验分享欢迎到 [Serverless 中文讨论社区](https://github.com/serverless/serverless-tencent/discussions) 分享讨论。同时使用中遇到的 bug 也欢迎通过 [BUG 反馈](https://github.com/serverless/serverless-tencent/issues/new/choose) 提交并追踪。
7878
7979
**下一步:[开始使用 serverless](./quickstart/installation)**

components/backend.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ Serverless Framework 提供了许多流行前端组件来帮助前端使用 serv
1919

2020
在创建后端框架模板之后,用户可以按照框架的开发方式进行后端应用开发。Serverless Framework 组件应用对后端并没有任何特殊限制。
2121

22-
<!-- ## API 网关 TODO: 添加API网关说明 -->
23-
2422
## 调试模式
2523

2624
在项目部署之后,可以通过`sls dev`开启调试模式, 调试会链接到云端的函数,进行在线调试开发。

components/components-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ express-starter › 信息成功加载
9797

9898
### dev 远程开发模式
9999

100-
启动远程开发模式,更多调试模式详情请参考[远程开发模式](../basic/dev-mode.md)
100+
启动远程开发模式,更多调试模式详情请参考[远程开发模式](../basic/dev-mode)
101101

102102
```sh
103103
# 进入组件应用的开发调试模式

function/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Serverless Framework 通过 SCF Component 提供了基于腾讯 SCF 的函数开
6161
}
6262
```
6363

64-
同时 Serverless Framework 还支持的事件有 [API 网关触发器](https://cloud.tencent.com/document/product/583/12513), [COS 触发器](https://cloud.tencent.com/document/product/583/9707), [CLS 触发器](https://cloud.tencent.com/document/product/583/49587), [定时触发器](https://cloud.tencent.com/document/product/583/9708), [CMQ Topic 触发器](https://cloud.tencent.com/document/product/583/11517), [CKafka 触发器](https://cloud.tencent.com/document/product/583/17530), [MPS 触发器](https://cloud.tencent.com/document/product/583/50833), [CLB 触发器](https://cloud.tencent.com/document/product/583/52635), [云 API 触发器](https://cloud.tencent.com/document/product/583/18198), 更多请查看[触发器配置](../basic/trigger.md)
64+
同时 Serverless Framework 还支持的事件有 [API 网关触发器](https://cloud.tencent.com/document/product/583/12513), [COS 触发器](https://cloud.tencent.com/document/product/583/9707), [CLS 触发器](https://cloud.tencent.com/document/product/583/49587), [定时触发器](https://cloud.tencent.com/document/product/583/9708), [CMQ Topic 触发器](https://cloud.tencent.com/document/product/583/11517), [CKafka 触发器](https://cloud.tencent.com/document/product/583/17530), [MPS 触发器](https://cloud.tencent.com/document/product/583/50833), [CLB 触发器](https://cloud.tencent.com/document/product/583/52635), [云 API 触发器](https://cloud.tencent.com/document/product/583/18198), 更多请查看[触发器配置](../basic/trigger)
6565

6666
### Context 运行时
6767

@@ -96,7 +96,7 @@ Context 包括了当前调用的执行超时时间,内存限制,以及当次
9696

9797
> 更多使用介绍请查看[函数应用开发](../quickstart/function-dev).
9898
99-
Serverless Framework 支持创建以下语言的函数应用模板
99+
Serverless Framework 支持创建以下语言的函数应用模板
100100

101101
- Node.js 函数应用([scf-nodejs](https://github.com/serverless-components/tencent-examples/tree/master/scf-nodejs)): Node.js 10.15 和 Node.js12.16
102102
- Python 函数应用([scf-python](https://github.com/serverless-components/tencent-examples/tree/master/scf-python)): Python2.7 和 Python3.6
@@ -109,4 +109,4 @@ Serverless Framework 支持创建以下语言的函数应用模板
109109
- [Node.js 函数应用开发](./nodejs)
110110
- [Python 函数应用开发](./python)
111111
- [Golang 函数应用开发](./golang)
112-
- [PHP 函数应用站点](./php)
112+
- [PHP 函数应用站点](./php)

function/function-commands.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Serverless CLI 支持以下功能命令:
1616

1717
```sh
1818
# 调用函数应用默认函数
19-
$ serverless invoke
19+
$ serverless invoke
2020

2121
# 调用函数应用默认函数的生产环境版本并使用指定 Event 数据
2222
$ serverless invoke --stage prod --data '{"foo":"bar"}'
@@ -25,18 +25,18 @@ $ serverless invoke --stage prod --data '{"foo":"bar"}'
2525

2626
#### 命令选项
2727

28-
[//]: - `--function``-f` 调用的函数名称,默认使用配置handler指定函数
28+
[//]: - `--function``-f` 调用的函数名称,默认使用配置 handler 指定函数
2929

30-
- `--stage``-s` 指定环境名称,默认使用配置环境
31-
- `--region``-r` 指定地区名称,默认使用配置地区
32-
- `--data``-d` 指定传入函数的事件(event)参数数据,需要使用序列化的 JSON 格式
33-
- `--path``-p` 指定传入还输的事件(event)参数的 JSON 文件路径
30+
- `--stage``-s` 指定环境名称,默认使用配置环境
31+
- `--region``-r` 指定地区名称,默认使用配置地区
32+
- `--data``-d` 指定传入函数的事件(event)参数数据,需要使用序列化的 JSON 格式
33+
- `--path``-p` 指定传入还输的事件(event)参数的 JSON 文件路径
3434

3535
[//]: > 使用单函数 SCF Component 不需要指定 `function` 参数, 只有多函数组件需要指定 `funciton` 参数
3636

3737
> 需要升级 Serverless CLI 为 3.10.0 以上版本
3838
39-
### invoke local 本地调用
39+
### invoke local 本地调用
4040

4141
通过此命令在本地调用函数。 同时可以发送 event 和 context 数据到函数进行本地调用测试。
4242

@@ -50,24 +50,24 @@ $ serverless invoke local --data '{"foo":"bar"}'
5050

5151
#### 命令选项
5252

53-
[//]: - `--function` `-f` 调用函数名称,默认使用配置handler指定函数
53+
[//]: - `--function` `-f` 调用函数名称,默认使用配置 handler 指定函数
5454

55-
* `--data``-d` 指定传入函数的事件(event)参数数据,需要使用序列化的 JSON 格式
55+
- `--data``-d` 指定传入函数的事件(event)参数数据,需要使用序列化的 JSON 格式
5656

57-
* `--path``-p` 指定传入还输的事件(event)参数的 JSON 文件路径
57+
- `--path``-p` 指定传入还输的事件(event)参数的 JSON 文件路径
5858

59-
* `--context` 指定传入函数的上下文(context)参数数据,需要使用序列化的 JSON 格式
59+
- `--context` 指定传入函数的上下文(context)参数数据,需要使用序列化的 JSON 格式
6060

61-
* `--contextPath``-x` 指定传入函数的上下文(context)参数的 JSON 文件路径
61+
- `--contextPath``-x` 指定传入函数的上下文(context)参数的 JSON 文件路径
6262

63-
* `--env``-e` 指定环境变量信息 如: --env VAR=val
63+
- `--env``-e` 指定环境变量信息 如: --env VAR=val
6464

65-
* `--config``-c` 指定使用的配置文件
65+
- `--config``-c` 指定使用的配置文件
6666

6767
> 本地调试函数目前仅支持 Node.js, 其他运行时的支持会在后续陆续推出。
6868
>
6969
> 需要升级 Serverless CLI 为 3.10.0 以上版本
7070
7171
### 其他组件命令
7272

73-
同时其他[组件命令](../components/components-commands.md)也可以在函数组件中使用。
73+
同时其他[组件命令](../components/components-commands)也可以在函数组件中使用。

infrastructure/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@ menuText: "基础组件说明"
44
layout: Doc
55
---
66

7-
87
# 基础组件说明
98

10-
- [SCF 函数组件](./scf.md)
9+
- [SCF 函数组件](./scf)
1110
- [API 网关](./api-gateway)
1211
- [COS 对象存储](./cos)
1312
- [CDN 内容分发](./cdn)
1413
- [VPC 私有网络](./vpc)
1514
- [Layer 组件](./layer)
1615
- [PostgreSQL 数据库](./postgresql)
1716
- [TDSQL-C 数据库](./tdsql-c)
18-

infrastructure/scf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ serverless remove
6161

6262
执行 `serverless deploy` 时,根据 serverless.yml 文件中的配置对云函数资源进行创建或更新。一份简单的 serverlesss.yml 文件如下:
6363

64-
> **说明**:配置详情请参考 [全量配置文档](../basic/yaml.md)
64+
> **说明**:配置详情请参考 [全量配置文档](../basic/yaml)
6565
6666
```
6767
#scf组件配置样例

quickstart/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ inputs: # 组件部署所需的参数
5656
environment: release # 网关发布环境。[test, prepub,release]
5757
```
5858

59-
> 不同组件的配置不完全一样,具体组件支持的参数配置相见相关组件[说明及示例](../components/README.md)。
59+
> 不同组件的配置不完全一样,具体组件支持的参数配置相见相关组件[说明及示例](../components/README)。
6060

6161
## 管理应用
6262

@@ -76,10 +76,10 @@ $ serverless dev
7676
$ serverless remove
7777
```
7878

79-
> 组件命令需要在组件项目目录中执行。更多关于命令的说明请查看 [组件命令](../components/components-commands.md) 和 [函数命令](../function/function-commands.md)
79+
> 组件命令需要在组件项目目录中执行。更多关于命令的说明请查看 [组件命令](../components/components-commands) 和 [函数命令](../function/function-commands)
8080

8181
**下一步:**
8282

8383
- [安装并使用](./installation)
8484
- [开发函数应用](./function-dev)
85-
- [开发组件应用](./components-dev)
85+
- [开发组件应用](./components-dev)

quickstart/components-dev.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ apigw:
8080
102s › express-starter › 部署成功
8181
```
8282

83-
> 如果有使用全局密钥有可能会与上面流程不同,关于登陆的更多方式和说明请查看[腾讯云账号控制](../basic/tencent-account.md)相关内容获得更详细帮助。
83+
> 如果有使用全局密钥有可能会与上面流程不同,关于登陆的更多方式和说明请查看[腾讯云账号控制](../basic/tencent-account)相关内容获得更详细帮助。
8484
8585
部署成功后会显示
8686

@@ -157,7 +157,7 @@ apigw:
157157
express-starter › 监听中 ...
158158
```
159159

160-
加下来修改代码保存后都会立即部署到腾讯云上,并可以立即开始测试。更多关于调试模式的使用方法请参考[调试模式](../basic/dev-mode.md)
160+
加下来修改代码保存后都会立即部署到腾讯云上,并可以立即开始测试。更多关于调试模式的使用方法请参考[调试模式](../basic/dev-mode)
161161

162162
> 调试模式不建议频繁保存代码,每次代码保存都会触发部署,过于频繁保存可能导致调试模式出现异常。
163163

@@ -204,4 +204,3 @@ express-starter › 信息成功加载
204204
```
205205

206206
**下一步:[了解组件开发(component)指南](../components/README)**
207-

quickstart/function-dev.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ layout: Doc
55
---
66

77
# 函数应用开发
8+
89
通过 Serverless CLI 的交互命令可以快速创建一个 Serverless 项目,函数项目请选择 `scf-starter`
910

10-
> 与国际版本不同,Serverless 中国通过 SCF 组件实现了国际版的函数开发功能。同时用户可以使方便的整合更多的腾讯云基础设施。详细说明请查看[函数开发(function)指南](../function/README.md)
11+
> 与国际版本不同,Serverless 中国通过 SCF 组件实现了国际版的函数开发功能。同时用户可以使方便的整合更多的腾讯云基础设施。详细说明请查看[函数开发(function)指南](../function/README)
1112
1213
## 初始化函数应用
1314

@@ -22,21 +23,21 @@ $ serverless
2223

2324
```sh
2425
Serverless: 当前未检测到 Serverless 项目,是否希望新建一个项目? Yes
25-
Serverless: 请选择你希望创建的 Serverless 应用
26-
27-
react-starter - 快速部署一个 React.js 应用
28-
restful-api - 快速部署一个 REST API 使用 python + API gateway
29-
❯ scf-starter - 快速部署一个云函数
30-
vue-starter - 快速部署一个 Vue.js 基础应用
31-
website-starter - 快速部署一个静态网站
32-
eggjs-starter - 快速部署一个Egg.js 基础应用
33-
express-starter - 快速部署一个 Express.js 基础应用
34-
35-
Serverless: 请选择应用的运行时
36-
scf-golang - 快速部署一个 golang 云函数
37-
❯ scf-nodejs - 快速部署一个 nodejs 云函数
38-
scf-php - 快速部署一个 PHP 云函数
39-
scf-python - 快速部署一个 python 云函数
26+
Serverless: 请选择你希望创建的 Serverless 应用
27+
28+
react-starter - 快速部署一个 React.js 应用
29+
restful-api - 快速部署一个 REST API 使用 python + API gateway
30+
❯ scf-starter - 快速部署一个云函数
31+
vue-starter - 快速部署一个 Vue.js 基础应用
32+
website-starter - 快速部署一个静态网站
33+
eggjs-starter - 快速部署一个Egg.js 基础应用
34+
express-starter - 快速部署一个 Express.js 基础应用
35+
36+
Serverless: 请选择应用的运行时
37+
scf-golang - 快速部署一个 golang 云函数
38+
❯ scf-nodejs - 快速部署一个 nodejs 云函数
39+
scf-php - 快速部署一个 PHP 云函数
40+
scf-python - 快速部署一个 python 云函数
4041

4142
Serverless: 请输入项目名称 my-scf-nodejs
4243
Serverless: 正在安装 scf-nodejs 应用...
@@ -71,17 +72,17 @@ handler: index.main_handler
7172
memorySize: 128
7273
lastVersion: $LATEST
7374
traffic: 1
74-
triggers:
75-
-
75+
triggers:
76+
-
7677
NeedCreate: true
7778
created: true
7879
serviceId: service-mqkih33e
7980
serviceName: serverless
8081
subDomain: service-mqkih33e-xxxxxxxx.gz.apigw.tencentcs.com
8182
protocols: http
8283
environment: release
83-
apiList:
84-
-
84+
apiList:
85+
-
8586
path: /
8687
method: GET
8788
apiName: index
@@ -90,16 +91,16 @@ triggers:
9091
businessType: NORMAL
9192
isBase64Encoded: false
9293
apiId: api-97zm7fws
93-
internalDomain:
94-
urls:
94+
internalDomain:
95+
urls:
9596
- http://service-mqkih33e-xxxxxxxx.gz.apigw.tencentcs.com/release/
9697

9798
应用控制台: https://serverless.cloud.tencent.com/apps/my-scf-nodejs-7398d46a/scf-nodejs/dev
9899

99100
21s › scf-nodejs › 执行成功
100101
```
101102

102-
> 如果有使用全局密钥有可能会与上面流程不同,关于登陆的更多方式和说明请查看[腾讯云账号控制](../basic/tencent-account.md)相关内容获得更详细帮助。
103+
> 如果有使用全局密钥有可能会与上面流程不同,关于登陆的更多方式和说明请查看[腾讯云账号控制](../basic/tencent-account)相关内容获得更详细帮助。
103104
104105
部署成功后会显示
105106

@@ -191,17 +192,17 @@ handler: index.main_handler
191192
memorySize: 128
192193
lastVersion: $LATEST
193194
traffic: 1
194-
triggers:
195-
-
195+
triggers:
196+
-
196197
NeedCreate: true
197198
created: true
198199
serviceId: service-mqkih33e
199200
serviceName: serverless
200201
subDomain: service-mqkih33e-xxxxxxxxxx.gz.apigw.tencentcs.com
201202
protocols: http
202203
environment: release
203-
apiList:
204-
-
204+
apiList:
205+
-
205206
path: /
206207
method: GET
207208
apiName: index
@@ -210,13 +211,13 @@ triggers:
210211
businessType: NORMAL
211212
isBase64Encoded: false
212213
apiId: api-97zm7fws
213-
internalDomain:
214-
urls:
214+
internalDomain:
215+
urls:
215216
- http://service-mqkih33e-xxxxxxxxxx.gz.apigw.tencentcs.com/release/
216217
217218
应用控制台: https://serverless.cloud.tencent.com/apps/my-scf-nodejs-7398d46a/scf-nodejs/dev
218219
219220
scf-nodejs › 信息成功加载
220221
```
221222

222-
**下一步:[了解函数开发(function)指南](../functions/README)**
223+
**下一步:[了解函数开发(function)指南](../functions/README)**

0 commit comments

Comments
 (0)