Merge pull request #14 from AlioLozy/main

fix service listr

Author: Eroyi

docs/requirements.md

@@ -27,9 +27,9 @@ title: 部署要求
 
 POC 将采用 Docker-Compose 的方式部署，所需的配置可以参考下表▼：
 
-| CPU  | 内存 | 储存空间 | 服务            |
-| ---- | ---- | -------- | --------------- |
-| 4 核 | 8 GB | 200 GB   | [[业务¹]](#explain1)、[[基建²]](#explain2) 混合部署 |
+| CPU  | 内存 | 储存空间 | 服务                                                |
+| ---- | ---- | -------- | --------------------------------------------------- |
+| 4 核 | 8 GB | 100 GB   | [[业务¹]](#explain1)、[[基建²]](#explain2) 混合部署 |
 
 该配置档的服务器所能承载的 [极限³](#explain3)  指标参见下表▼：
 

docs/servicelist.md

@@ -5,209 +5,223 @@ title: 业务组件
 
 # 业务组件
 
-### 组件介绍
+#### 业务网关
 
-#### gateway
-组件介绍请参考下表：
+服务名：**gateway**
 
-业务网关。
+* 网关用于接受所有业务请求，反向代理到小程序平台中的具体业务服务处理，所有业务接口统一由此暴露出去；
 
-网关用于接受所有业务请求，反向代理到小程序平台中的具体业务服务处理，所有业务接口统一由此暴露出去。
+* 网关上会配置jwt、rate-limiting、监控、链路跟踪以及自定义开发等插件，根据业务需要做相关校验或者拦截处理。
 
-网关上会配置jwt、rate-limiting、监控、链路跟踪以及自定义开发等插件，根据业务需要做相关校验或者拦截处理。
+<p></p>
 
+#### 角色管理模块、账号系统
 
+服务名：**account-system**
 
-#### account-system
+* 小程序平台两个主要角色是机构方和运营方，运营方对机构方进行审核、审批、管控等。使用小程序平台之前，需要机构方进行注册、申请。
 
-角色管理模块。
+<p></p>
 
-小程序平台两个主要角色是机构方和运营方，运营方对机构方进行审核、审批、管控等。使用小程序平台之前，需要机构方进行注册、申请。
+#### 灰度数据查看最新模块
 
+服务名：**app-gray-statistics-center**
 
+* 查看小程序灰度数据详情，包括：用户分布区域、用户使用终端类型、异常次数、打开次数，以及已上架和灰度版本对比情况。
 
-#### app-gray-statistics-center
+<p></p>
 
-灰度数据查看中心模块。
+#### 小程序、应用管理模块
 
-查看小程序灰度数据详情，包括：用户分布区域、用户使用终端类型、异常次数、打开次数，以及已上架和灰度版本对比情况。
+服务名：**app-manage-svr**
 
+* 该模块是对小程序整个生存信息的管理服务，其中包括小程序创建、小程序信息维护、小程序审核、小程序上下架、应用创建、应用关联小程序这些子任务。该模块是运行时直接调用获取小程序详情（包括小程序描述、logo、下载包等）的入口和出口，所以也是小程序访问量最大的核心模块之一。
 
+<p></p>
 
-#### app-manage-svr
+#### 小程序搜索模块
 
-小程序管理模块。
+服务名：**app-search**
 
-该模块是对小程序整个生存信息的管理服务，其中包括小程序创建、小程序信息维护、小程序审核、小程序上下架、应用创建、应用关联小程序这些子任务。该模块是运行时直接调用获取小程序详情（包括小程序描述、logo、下载包等）的入口和出口，所以也是小程序访问量最大的核心模块之一。
+* 应用已关联的小程序可在 SDK 进行搜索查看。
 
+<p></p>
 
+#### 小程序搜索爬虫模块
 
-#### app-search
+服务名：**app-spider**
 
-小程序搜索模块。
+* 对小程序搜索信息进行统一处理。
 
+<p></p>
 
+#### 小程序编译工程模块
 
-#### app-spider
+服务名：**applet-build-manager**
 
-数据统计模块。
+* 小程序编译结果的管理。
 
+<p></p>
 
+#### 前端小程序编译工程模块
 
-#### applet-build-manager
+服务名：**applet-build**
 
-小程序编译工程模块。
+* 对小程序进行编译
 
+<p></p>
 
+#### 小程序文章发布中心模块
 
-#### applet-build
+服务名：**article-pub-center**
 
-前端小程序编译工程模块。
+* 用于运行端发布通告、文章、期刊等。
 
+<p></p>
 
+#### 待办中心模块
 
-#### article-pub-center
+服务名：**audit-manage-svr**
 
-小程序文章发布中心模块。
+* 运营端、机构端待办中心
 
-用于运行端发布通告、文章、期刊等。
+<p></p>
 
+#### 鉴权核查模块
 
+服务名：**auth-checker**
 
-#### audit-manage-svr
+* 对用户权限进行校验
 
-待办中心模块。
+<p></p>
 
+#### 基础库服务模块
 
+服务名：**basic-pack-svr**
 
-#### auth-checker
+* 本服务主要为记录 SDK 运行时、基础库、凡泰助手的版本信息。
 
-鉴权核查模块。
+<p></p>
 
+#### SDK 控制管理模块
 
+服务名：**control-manager**
 
-#### basic-pack-svr
+* SDK 获取配置信息，需要后端统一管理。
 
-基础库服务模块。
+<p></p>
 
-本服务主要为记录 SDK 运行时、基础库、凡泰助手的版本信息。
+#### 数据加工模块
 
+服务名：**data-clean**
 
+* 对于服务端获取到的数据进行收集、统计
 
-#### control-manager
+<p></p>
 
-SDK 控制管理模块。
+#### 数据上报模块
 
-SDK 获取配置信息，需要后端统一管理。
+服务名：**data-report**
 
+* 本服务主要为操作日志和日志上报服务，操作日志和数据上报接口将收集获取的数据丢入 Kafka，由另外专门的协程来消费处理，最终录入 Elasticsearch，提供给业务做各种搜索和统计。
 
+<p></p>
 
-#### data-clean
+#### 数据统计模块
 
-数据加工模块
+服务名：**data-static**
 
+* 移动端上报数据进行统一处理模块
 
+<p></p>
 
-#### data-report
+#### 设备安全管理模块
 
-数据上报模块。
+服务名：**device-security**
 
-本服务主要为操作日志和日志上报服务，操作日志和数据上报接口将收集获取的数据丢入 Kafka，由另外专门的协程来消费处理，最终录入 Elasticsearch，提供给业务做各种搜索和统计。
+* 用于在账号登录的时候，生产 refresh token、jwt。
 
+<p></p>
 
+#### 域名管理模块
 
-#### data-static
+服务名：**domain-manager**
 
-数据统计模块。
+* 该模块是为了对小程序访问的域名进行控制，域名分为：服务域名、业务域名、白名单域名
+  1. 服务域名：小程序运行的时候，需要对小程序发行方的服务器进行访问，该访问的地址也就是这里所说的服务域名。
+  2. 业务域名：小程序运行的时候，除了对服务域名访问之外，还需要对第三方域名进行访问，第三方域名要求合规化，那么需要改业务域名进行合规校验，也就是，业务域名需要校验文件进行校验才可以进行访问。
+  3. 白名单域名：白名单域名，指的是运营审核方确定合规并且可以正常访问，无需校验的域名访问，例如：证监会、百度等。
 
+<p></p>
 
+#### 投诉反馈模块
 
-#### device-security
+服务名：**feedback-svr**
 
-设备安全管理模块。
+* 本服务主要记录用户投诉、举报、产品建议信息服务。
 
-用于在账号登录的时候，生产 refresh token、jwt。
+<p></p>
 
+#### 帮助中心模块
 
+服务名：**help-center-svr**
 
-#### domain-manager
+* 帮助中心的数据处理。
 
-域名管理模块。
+<p></p>
 
-该模块是为了对小程序访问的域名进行控制，域名分为：服务域名、业务域名、白名单域名。
+#### License 校验中心模块
 
-1. 服务域名：小程序运行的时候，需要对小程序发行方的服务器进行访问，该访问的地址也就是这里所说的服务域名。
+服务名：**license-checker**
 
-2. 业务域名：小程序运行的时候，除了对服务域名访问之外，还需要对第三方域名进行访问，第三方域名要求合规化，那么需要改业务域名进行合规校验，也就是，业务域名需要校验文件进行校验才可以进行访问。
+* License 用于决定小程序平台的部分功能，例如小程序数量、应用数量、灰度发布数量等。
 
-3. 白名单域名：白名单域名，指的是运营审核方确定合规并且可以正常访问，无需校验的域名访问，例如：证监会、百度等。
+<p></p>
 
+#### 网盘中间层服务模块
 
+服务名：**netdisk-proxy**
 
-#### feedback-svr
+* 本服务主要为网盘服务提供一个中间层鉴权服务。
 
-投诉反馈模块。
+<p></p>
 
-本服务主要记录用户投诉、举报、产品建议信息服务。
+#### 通知中心模块
 
+服务名：**notify**
 
+* 可以发布运营端通知和机构端消息。
 
-#### help-center-svr
+<p></p>
 
-帮助中心模块。
+#### 数据上报服务模块
 
+服务名：**open-api**
 
+* 本服务主要为对外开发接口提供统一接入服务。
 
-#### license-checker
+<p></p>
 
-License 校验中心模块。
+#### 规则引擎服务模块
 
-License 用于决定小程序平台的部分功能，例如小程序数量、应用数量、灰度发布数量等。
+服务名：**rule-engine-svr**
 
+* 本服务主要为灰度发布、定制发布进行规则的配置和校验。
 
+<p></p>
 
-#### netdisk-proxy
+#### SDK 审核管理模块
 
-网盘中间层服务模块。
+服务名：**sdk-manager**
 
-本服务主要为网盘服务提供一个中间层鉴权服务。
+* 在运营端对企业端提交的SDK进行审核，在企业端提交 SDK 进行审核。
 
+<p></p>
 
+#### 发送验证码网关模块
 
-#### notify
+服务名：**verify-code-gateway**
 
-通知中心模块。
+* 可以配置网关，将短信验证码发送给指定的短信渠道，例如：腾讯云、客户自己的短信服务等。
 
-可以发布运营端通知和机构端消息。
-
-
-
-#### open-api
-
-数据上报服务模块。
-
-本服务主要为对外开发接口提供统一接入服务。
-
-
-
-#### rule-engine-svr
-
-规则引擎服务模块。
-
-本服务主要为灰度发布、定制发布进行规则的配置和校验。
-
-
-
-#### sdk-manager
-
-SDK 审核管理模块。
-
-在运营端对企业端提交的SDK进行审核，在企业端提交 SDK 进行审核。
-
-
-
-#### verify-code-gateway
-
-发送验证码网关模块。
-
-可以配置网关，将短信验证码发送给指定的短信渠道，例如：腾讯云、客户自己的短信服务等。
+<p></p>