Skip to content

Commit

Permalink
docs: Update Chinese site docs of Serverless Framework (#7535)
Browse files Browse the repository at this point in the history
  • Loading branch information
tinafangkunding committed Apr 3, 2020
1 parent 00f1a28 commit 2b09adb
Show file tree
Hide file tree
Showing 36 changed files with 988 additions and 1,038 deletions.
2 changes: 1 addition & 1 deletion docs/cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Serverless Framework 可以帮您以更少的成本和开销, 快速构建 Serve

Serverless Framework 包括一个开源的,支持多云部署的 CLI 插件,此外也支持 Dashboard 的展示,用于进一步简化 Serverless 应用的开发,部署和测试等体验,并且支持您更加方便的管控和监控 Serverless 应用(该功能即将支持)。

无论您是刚开始接触 Serverless Framework,希望快速、便捷部署无服务器应用;还是您已经使用过 Serverless 开源 CLI,希望探索更多高级能力。都可以从这里[快速开始](./getting-started)
无论您是刚开始接触 Serverless Framework,希望快速、便捷部署无服务器应用;还是您已经使用过 Serverless Framework,希望探索更多高级能力。都可以从这里[快速开始](./getting-started)
42 changes: 38 additions & 4 deletions docs/cn/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,41 @@ menuItems:

# Serverless Framework 快速开始

**首先,需要将 Serverless Framework 开源 CLI 安装到本地环境。**
**首先,需要将 Serverless Framework 安装到本地环境。**

## 方式一:二进制安装

如果您的本地环境没有安装 Node.js,您可以直接使用二进制的方式进行安装:

### MacOS/Linux 系统

打开命令行,输入以下命令:

```sh
$ curl -o- -L https://slss.io/install | bash
```

如果之前您已经安装过二进制版本,可以通过下列命令进行升级:

```sh
$ serverless upgrade
```

### Windows 系统

Windows 系统支持通过 [chocolatey](https://chocolatey.org/) 进行安装。打开命令行,输入以下命令:

```sh
$ choco install serverless
```

如果之前您已经安装过二进制版本,可以通过下列命令进行升级:

```sh
$ choco upgrade serverless
```

## 方式二:NPM 安装

```bash
# 安装 serverless cli
Expand All @@ -31,11 +65,11 @@ npm update -g serverless

如果你的环境中还没有安装 Node 8 或者更高的版本,那么你需要首先安装 [Node.js](https://nodejs.org/zh-cn/download/)

**Serverless Framework 安装完毕后,您可以直接运行如下命令,即可快速通过 CLI 部署你的第一个 Serverless 应用。**
**Serverless Framework 安装完毕后,您可以直接运行如下命令,即可快速通过 Serverless Framework 快速部署你的第一个 Serverless 应用。**

```bash
# 创建一个新的 serverless 服务
serverless create -t tencent-nodejs
serverless
```

更多高阶能力的支持,可以参考[快速入门](./providers/tencent/cli-reference/create),或者参照左侧目录,进一步探索。
更多高阶能力的支持,可以参考[快速入门](./providers/tencent/components/quickstart.md),或者参照左侧目录,进一步探索。
12 changes: 0 additions & 12 deletions docs/cn/providers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,3 @@ layout: Doc
</div>
<br/>
<br/>

## Connecting your provider

To deploy functions, specify your provider in your service's `serverless.yml` file under the `provider` key and make sure your provider credentials are setup on your machine or CI/CD system.

```yml
# serverless.yml
service: my-service-name

provider:
name: tencent
```
45 changes: 3 additions & 42 deletions docs/cn/providers/tencent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,7 @@ layout: Doc

<!-- DOCS-SITE-LINK:END -->

# 腾讯云 CLI 文档

**注意:** 使用前需要申请使用腾讯云密钥 [腾讯云访问密钥](https://console.cloud.tencent.com/cam/capi)

<div class="docsSections">
<div class="docsSection">
<div class="docsSectionSubHeader">
<h4>CLI 文档导航</h4>
</div>
<div class="docsProviderItems">
<ul>
<li><a href="./cli-reference/create.md">部署创建</a></li>
<li><a href="./cli-reference/install.md">快速安装</a></li>
<li><a href="./cli-reference/deploy.md">部署服务</a></li>
<li><a href="./cli-reference/deploy-function.md">部署函数</a></li>
<li><a href="./cli-reference/deploy-list.md">部署列表</a></li>
<li><a href="./cli-reference/invoke.md">云端调用</a></li>
<li><a href="./cli-reference/logs.md">日志查看</a></li>
<li><a href="./cli-reference/metrics.md">运行数据统计</a></li>
<li><a href="./cli-reference/info.md">信息获取</a></li>
<li><a href="./cli-reference/rollback.md">回滚服务</a></li>
<li><a href="./cli-reference/remove.md">删除服务</a></li>
</ul>
</div>
</div>
# 腾讯云 Serverless Framework 文档

<div class="docsSection">
<div class="docsSectionSubHeader">
Expand All @@ -49,8 +25,8 @@ layout: Doc
<li><a href="./components/high-level-components/tencent-koa.md">Koa 组件</a></li>
<li><a href="./components/high-level-components/tencent-flask.md"> Python Flask 组件</a></li>
<li><a href="./components/high-level-components/tencent-laravel.md"> PHP Laravel 组件</a></li>
<li><a href="./components/high-level-components/tencent-react-full-stack.md">部署 React.js+Express.js 应用</a></li>
<li><a href="./components/high-level-components/tencent-vue-full-stack.md">部署 Vue.js+Express.js 应用</a></li>
<li><a href="./components/high-level-components/tencent-react-full-stack.md">部署 React 全栈应用</a></li>
<li><a href="./components/high-level-components/tencent-vue-full-stack.md">部署 Vue 全栈应用</a></li>
<li><a href="./components/high-level-components/tencent-hexo.md">搭建 Hexo 博客</a></li>
<li><a href="./components/high-level-components/tencent-website.md">搭建静态网站</a></li>
<li><a href="./components/basic-components/tencent-scf.md">云函数 SCF 组件</a></li>
Expand All @@ -62,18 +38,3 @@ layout: Doc
</ul>
</div>
</div>

<div class="docsSection">
<div class="docsSectionSubHeader">
<h4>事件类型</h4>
</div>
<div class="docsProviderItems">
<ul>
<li><a href="./events/apigateway.md">API 网关</a></li>
<li><a href="./events/cloud-kafka.md">消息队列 CKafka</a></li>
<li><a href="./events/cmq.md">消息队列 CMQ</a></li>
<li><a href="./events/cos.md">对象存储 COS</a></li>
<li><a href="./events/timer.md">定时触发 Timer</a></li>
</ul>
</div>
</div>
39 changes: 0 additions & 39 deletions docs/cn/providers/tencent/cli-reference/README.md

This file was deleted.

67 changes: 0 additions & 67 deletions docs/cn/providers/tencent/cli-reference/create.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/cn/providers/tencent/cli-reference/deploy-function.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/cn/providers/tencent/cli-reference/deploy-list.md

This file was deleted.

56 changes: 0 additions & 56 deletions docs/cn/providers/tencent/cli-reference/deploy.md

This file was deleted.

0 comments on commit 2b09adb

Please sign in to comment.