Skip to content

Commit

Permalink
feat: 静态资源走cdn
Browse files Browse the repository at this point in the history
  • Loading branch information
ostli authored and zoswing committed Dec 23, 2021
1 parent 8598b93 commit f457fe2
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 37 deletions.
2 changes: 1 addition & 1 deletion .gitignore
@@ -1,5 +1,5 @@
node_modules
/docs/.vuepress/dist/
dist/
package-lock.json
yarn.lock
yarn-error.log
Expand Down
3 changes: 2 additions & 1 deletion Dockerfile
Expand Up @@ -3,5 +3,6 @@ FROM nginx

COPY nginx.conf /etc/nginx/

COPY ./docs/.vuepress/dist /usr/share/nginx/html
COPY ./dist /usr/share/nginx/html


4 changes: 4 additions & 0 deletions docs/.vuepress/common.js
@@ -0,0 +1,4 @@
module.exports = {
cdnBase: 'https://abc-pcweb-1251316161.file.myqcloud.com/',
cdnPath: 'qq-channel/',
};
8 changes: 6 additions & 2 deletions docs/.vuepress/config.js
@@ -1,11 +1,15 @@
const { convertSummary } = require('./summary-sidebar');
const nodesdkConfig = require('../develop/nodesdk/config');
const commonConfig = require('./common');
// openapi 外部文档隐藏的接口,注意不要携带.md后缀
// 废弃,请使用 summary-public 来约束可以展示的内容
const hiddenApi = [];

module.exports = {
module.exports = ctx => ({
base: '/wiki/',
configureWebpack: (config, isServer) => {
config.output.publicPath = ctx.isProd ? commonConfig.cdnBase + commonConfig.cdnPath : this.base;
},
title: ' QQ机器人文档',
description:
'QQ小程序是连接年轻用户的新方式,覆盖8亿新生代活跃网民。轻便快捷的开发模式,将能在QQ内被轻松获取和传播。',
Expand Down Expand Up @@ -149,4 +153,4 @@ module.exports = {
],
],
},
};
});
12 changes: 10 additions & 2 deletions docs/.vuepress/enhanceApp.js
@@ -1,6 +1,14 @@
import Element from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
const commonConfig = require('./common');

export default ({ Vue, options, router }) => {
export default ({ Vue, options, router, siteData, isServer }) => {
Vue.use(Element);
};
const isProd = process.env.NODE_ENV === 'production';
Vue.prototype.$withBotBase = function (path) {
if (path.charAt(0) === '/') {
path = path.slice(1);
}
return (isProd ? commonConfig.cdnBase + commonConfig.cdnPath : siteData.base) + path;
};
};
46 changes: 23 additions & 23 deletions docs/README.md
Expand Up @@ -20,7 +20,7 @@ QQ频道机器人通过开放的平台承载机器人的定制化功能,让开

## 接入流程

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.001.png')" alt="接入流程">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.001.png')" alt="接入流程">

### 1. 阅读文档

Expand All @@ -38,7 +38,7 @@ QQ频道机器人通过开放的平台承载机器人的定制化功能,让开

主体类型选择「公司」

<img :src="$withBase('/images/introduce/choice-body.png')" alt="选择公司">
<img :src="$withBotBase('/images/introduce/choice-body.png')" alt="选择公司">


::: tip 温馨提示
Expand All @@ -51,14 +51,14 @@ QQ频道机器人通过开放的平台承载机器人的定制化功能,让开

请填写**未注册过 QQ 机器人、QQ 小程序、QQ 小游戏的邮箱账号**,并登陆邮箱,查收激活邮件,点击激活链接。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.002.png')" alt="填写邮箱和密码">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.002.png')" alt="填写邮箱和密码">


##### 2.2.2 企业主体认证

企业账号需要上传营业执照照片、主体名称、号码类型、证件号码,请确保照片清晰,填写内容无误。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.003.jpeg')" alt="企业主体认证">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.003.jpeg')" alt="企业主体认证">


::: tip 温馨提示
Expand All @@ -75,7 +75,7 @@ QQ频道机器人通过开放的平台承载机器人的定制化功能,让开
- 用于扫码的 QQ 号需已进行过实名认证。
:::

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.004_1.jpeg')" alt="管理员信息登记">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.004_1.jpeg')" alt="管理员信息登记">

::: tip 温馨提示

Expand All @@ -90,7 +90,7 @@ QQ频道机器人通过开放的平台承载机器人的定制化功能,让开

QQ 机器人企业主体资质认证包括工商信息校验、财务信息校验 2 个环节。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.004.png')" alt="企业主体开发者资质审核主流程">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.004.png')" alt="企业主体开发者资质审核主流程">

::: tip 温馨提示
**请务必尽快完成此环节,通过资质认证后开发者才能发起提审流程。**
Expand Down Expand Up @@ -129,7 +129,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

阅读和签署开发者服务平台协议,如被平台发现违法协议者,将依据法律追究责任。

<img :src="$withBase('/images/introduce/account.png')" alt="填写邮箱和密码">
<img :src="$withBotBase('/images/introduce/account.png')" alt="填写邮箱和密码">


:::tip 温馨提示
Expand All @@ -140,7 +140,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

前往账号填写的邮箱地址进行账号激活,点击邮箱中的链接即可激活账号。

<img :src="$withBase('/images/introduce/mail.png')" alt="激活邮箱">
<img :src="$withBotBase('/images/introduce/mail.png')" alt="激活邮箱">

:::tip 温馨提示

Expand All @@ -157,7 +157,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

**当前机器人处于内测中,入驻的个体均为平台邀请并筛选的个体开发者,需签署隐私保密协议,如存在对外泄露平台信息情况,公司将对其追究法律责任!!!**

<img :src="$withBase('/images/introduce/manager.png')" alt="管理员信息登记">
<img :src="$withBotBase('/images/introduce/manager.png')" alt="管理员信息登记">

:::tip 温馨提示
**如实名认证信息填写错误,则人脸识别无法通过,须修改正确后再扫码通过。**
Expand All @@ -167,7 +167,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

点击按钮即可进入开发者管理端。

<img :src="$withBase('/images/introduce/finish-register.png')" alt="完成注册">
<img :src="$withBotBase('/images/introduce/finish-register.png')" alt="完成注册">

### 4. 创建机器人

Expand All @@ -183,7 +183,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

- **沙箱频道 ID 号**:该频道由开发者在频道中自主创建,提交机器人基本信息后,机器人会出现在沙箱频道的机器人列表当中,开发者可在沙箱频道里进行功能自测,便于填写复审时需要的自测报告。

<img :src="$withBase('/images/introduce/create-robot.png')" alt="获得BotAppID&添加沙箱频道">
<img :src="$withBotBase('/images/introduce/create-robot.png')" alt="获得BotAppID&添加沙箱频道">

:::tip 温馨提示

Expand All @@ -204,7 +204,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

**点击频道右上角「...」--->点击「频道设置」--->点击「机器人」--->添加测试机器人**

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.006.png')" alt="添加机器人">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.006.png')" alt="添加机器人">

### 5. 开发设置

Expand All @@ -220,13 +220,13 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

在跳转 `h5` 需要 `OAuth` 的时候使用 (如机器人服务是跳转小程序,可忽略),回调地址上限为`10`条。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.008.png')" alt="回调地址">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.008.png')" alt="回调地址">

#### 5.3 消息 URL 配置

填写机器人下发消息中所包含的链接域名,域名需在此处提交后才可生效,域名上限为`20`条,每年可修改`50`次。

<img :src="$withBase('/images/introduce/callback-info-url.png')" alt="消息 URL 配置">
<img :src="$withBotBase('/images/introduce/callback-info-url.png')" alt="消息 URL 配置">

:::tip 温馨提示
域名需提前进行ICP备案,并通过域名校验才可报备成功。
Expand All @@ -241,7 +241,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校
**产品ID填写:** 需要在此处填写兔小巢反馈空间的产品ID,C端用户的机器人反馈才可同步至此处,详细获取路径如开发者端提示:设置-->产品设置-->产品ID。


<img :src="$withBase('/images/introduce/feedback.png')" alt="频道用户意见反馈">
<img :src="$withBotBase('/images/introduce/feedback.png')" alt="频道用户意见反馈">

:::tip 温馨提示
兔小巢创建与使用详情可点击[**用户反馈空间创建攻略**](https://docs.qq.com/doc/DY0FBR0FUSm5lT0pn)
Expand All @@ -251,7 +251,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

基本信息修改限制:每月可修改`5`次。

<img :src="$withBase('/images/introduce/config.png')" alt="设置">
<img :src="$withBotBase('/images/introduce/config.png')" alt="设置">

### 7. 权限设置

Expand All @@ -268,7 +268,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校
- **发布权限**:拥有该权限的成员可编辑和提交语料、服务、指令等模块。
- **开发设置**:拥有该权限的成员可编辑和提交回调地址、URL 模块。

<img :src="$withBase('/images/introduce/auth.png')" alt="权限">
<img :src="$withBotBase('/images/introduce/auth.png')" alt="权限">

:::tip 温馨提示
**登陆权限是基础权限,要拥有发布权限和开发权限的前提是拥有登陆权限**
Expand All @@ -278,7 +278,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

开发者可以通过发布设置配置对话类型语料以及机器人服务,此处配置的语料和功能配置完毕,均需通过代码开发实现。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.009.png')" alt="发布设置">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.009.png')" alt="发布设置">

#### 8.1 语料配置

Expand All @@ -296,7 +296,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

**图片链接:** 填写机器人回答中图片的`url`链接,图片链接`url`需带`http``https`前缀,图片不允许涉及政治敏感与色情。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.010.png')" alt="语料配置">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.010.png')" alt="语料配置">

:::tip 温馨提示
**所有开发者注册完机器人默认拥有“不校验语料id”能力,即不需要在管理端的对话型语料里进行语料报备,直接使用代码实现AB回复逻辑即可,一旦机器人被平台发现有违规行为,该能力将被收回,所有被动消息均需要在此处进行报备才可发出。**
Expand Down Expand Up @@ -367,7 +367,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校
- **权限菜单**:请选择本服务是开放给所有用户还是仅针对频道主和管理员。


<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.011.png')" alt="服务配置">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.011.png')" alt="服务配置">

:::tip 温馨提示
**开发者可添加、删减功能,管理端配置的功能顺序与 C 端机器人资料卡展示的功能顺序一致**
Expand All @@ -389,7 +389,7 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

开发者可添加、删减指令,管理端配置的功能顺序与 C 端机器人指令集展示的功能顺序一致,建议将常用/核心的指令前置。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.012.png')" alt="指令配置">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.012.png')" alt="指令配置">

:::warning 注意
**指令和服务模块暂不需要单独提审,自测完成后,填写自测报告与自测报告一起提审**
Expand All @@ -399,15 +399,15 @@ QQ 机器人企业主体资质认证包括工商信息校验、财务信息校

开发者需下载机器人自测报告模版,在自测频道内根据模板要求测试机器人的功能,并填写完自测报告后上传。

<img :src="$withBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.013.png')" alt="自测报告">
<img :src="$withBotBase('/images/introduce/Aspose.Words.a59f0707-65ac-4bec-8de6-d0d8efeb74d0.013.png')" alt="自测报告">

- **自测报告**[机器人自测报告模板](https://docs.qq.com/sheet/DZlplZ1FFQUpmWWVt)

- **审核结果**:请自行在对应提审模块查看,如果审核不通过,则需要修改后再次提交审核。

- **审核时效**:工作日`24`小时内审核,不支持催审,请耐心等待审核验收结果。

<img :src="$withBase('/images/introduce/audit.png')" alt="自测报告-审核">
<img :src="$withBotBase('/images/introduce/audit.png')" alt="自测报告-审核">

::: tip 温馨提示
提交功能配置审核前需完成机器人的资质认证,提交审核后,服务配置、指令配置和自测报告将一起送往平台进行审核。
Expand Down
6 changes: 3 additions & 3 deletions docs/develop/nodesdk/README.md
Expand Up @@ -14,16 +14,16 @@

整个 SDK 分三层设计:`应用层``框架层``基础层`,具体结构如下图所示:

<img :src="$withBase('/images/node-sdk/framework.png')" alt="SDK 底层架构设计">
<img :src="$withBotBase('/images/node-sdk/framework.png')" alt="SDK 底层架构设计">

整个 SDK 设计与实现基于**两条主线**

1. NodeSDK 与基础侧的通信模块,属于机器人**被动接受消息**。比如有用户@机器人、新
用户加入频道触发的事件等等。
<img :src="$withBase('/images/node-sdk/api-client.png')" alt="SDK 底层架构设计">
<img :src="$withBotBase('/images/node-sdk/api-client.png')" alt="SDK 底层架构设计">
2. 机器人通过 NodeSDK 调用基础能力,属于机器人**主动触发消息**。比如欢迎语提醒、
定时打卡任务触发、查询当前频道成员列表等等。
<img :src="$withBase('/images/node-sdk/ws-client.png')" alt="SDK 底层架构设计">
<img :src="$withBotBase('/images/node-sdk/ws-client.png')" alt="SDK 底层架构设计">

## 安装

Expand Down
8 changes: 4 additions & 4 deletions docs/develop/nodesdk/message/message_template.md
Expand Up @@ -19,7 +19,7 @@

### 样式(id=23)

<img :src="$withBase('/images/node-sdk/msg-tpl-23.png')" alt="接入流程">
<img :src="$withBotBase('/images/node-sdk/msg-tpl-23.png')" alt="接入流程">

### 模板格式

Expand Down Expand Up @@ -154,7 +154,7 @@

### 样式(id=24)

<img :src="$withBase('/images/node-sdk/msg-tpl-24.png')" alt="接入流程">
<img :src="$withBotBase('/images/node-sdk/msg-tpl-24.png')" alt="接入流程">

### 模板格式

Expand Down Expand Up @@ -233,7 +233,7 @@

### 样式(id=34)

<img :src="$withBase('/images/node-sdk/msg-tpl-34.png')" alt="接入流程">
<img :src="$withBotBase('/images/node-sdk/msg-tpl-34.png')" alt="接入流程">

### 模板格式

Expand Down Expand Up @@ -312,7 +312,7 @@

### 样式(id=37)

<img :src="$withBase('/images/node-sdk/msg-tpl-37.png')" alt="接入流程">
<img :src="$withBotBase('/images/node-sdk/msg-tpl-37.png')" alt="接入流程">

### 模板格式

Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -39,7 +39,7 @@
},
"scripts": {
"dev": "vuepress dev docs --temp .temp",
"build": "vuepress build docs --temp .temp",
"build": "vuepress build docs --temp .temp --dest dist",
"lint-md": "npm run lint-md:style && npm run lint-md:wording",
"lint-md:style": "remark --quiet --frail .",
"lint-md:wording": "textlint './docs/**/*.md'",
Expand Down

0 comments on commit f457fe2

Please sign in to comment.