更新帮助文档,readme链接

README.md

@@ -45,12 +45,9 @@ Using TCA can help team find normative, structural, security vulnerabilities and
 
 ## Getting Started
 
-- [How to get start](https://tencent.github.io/CodeAnalysis/)
+- [How to deploy](https://tencent.github.io/CodeAnalysis/en/quickStarted/)
 - [How to use TCA Action](https://github.com/TCATools/TCA-action/blob/main/README.md)
-- [How to deploy server and web](https://tencent.github.io/CodeAnalysis/zh/quickStarted/deploySever.html#通过源代码)
-- [How to deploy server and web with docker-compose](https://tencent.github.io/CodeAnalysis/zh/quickStarted/deploySever.html#通过docker-compose)
-- [How to use client](https://tencent.github.io/CodeAnalysis/zh/quickStarted/deployClient.html)
-- [Deploy Q&A](https://tencent.github.io/CodeAnalysis/zh/quickStarted/FAQ.html)
+- [How to use client](https://tencent.github.io/CodeAnalysis/en/guide/客户端/本地分析.html)
 
 ## Community
 

README_ZH.md

@@ -43,12 +43,9 @@
 
 ## 快速入门
 
-- [快速入门](https://tencent.github.io/CodeAnalysis/)
+- [快速部署](https://tencent.github.io/CodeAnalysis/zh/quickStarted/)
 - [如何使用TCA Action快速体验](https://github.com/TCATools/TCA-action/blob/main/README.md)
-- [如何在本地部署Server与Web](https://tencent.github.io/CodeAnalysis/zh/quickStarted/deploySever.html#通过源代码)
-- [如何通过Docker-Compose部署Server与Web](https://tencent.github.io/CodeAnalysis/zh/quickStarted/deploySever.html#通过docker-compose)
-- [如何使用客户端](https://tencent.github.io/CodeAnalysis/zh/quickStarted/deployClient.html)
-- [部署常见问题与解决方式](https://tencent.github.io/CodeAnalysis/zh/quickStarted/FAQ.html)
+- [如何使用客户端](https://tencent.github.io/CodeAnalysis/zh/guide/客户端/本地分析.html)
 
 ## 社区
 

doc/.vuepress/configs/navbar/zh.ts

@@ -19,6 +19,7 @@ export const zh: NavbarConfig = [
       {
         text: '深入',
         children: [
+          '/zh/advanced/任务分布式执行.md',
           '/zh/advanced/集成代码分析工具.md',
         ],
       },

doc/.vuepress/configs/sidebar/en.ts

@@ -93,6 +93,16 @@ export const en: SidebarConfig = {
         '/en/advanced/任务分布式执行.md',
         '/en/advanced/集成代码分析工具.md',
       ],
+    },
+    {
+      text: '依赖安装参考',
+      children: [
+        '/zh/advanced/install_python37_on_centos.md',
+        '/zh/advanced/install_python37_on_ubuntu.md',
+        '/zh/advanced/install_mysql_on_centos.md',
+        '/zh/advanced/install_redis_from_source.md',
+        '/zh/advanced/install_redis_on_centos.md',
+      ],
     }
   ],
   '/en/community/': [

doc/.vuepress/configs/sidebar/zh.ts

@@ -93,6 +93,16 @@ export const zh: SidebarConfig = {
         '/zh/advanced/任务分布式执行.md',
         '/zh/advanced/集成代码分析工具.md',
       ],
+    },
+    {
+      text: '依赖安装参考',
+      children: [
+        '/zh/advanced/install_python37_on_centos.md',
+        '/zh/advanced/install_python37_on_ubuntu.md',
+        '/zh/advanced/install_mysql_on_centos.md',
+        '/zh/advanced/install_redis_from_source.md',
+        '/zh/advanced/install_redis_on_centos.md',
+      ],
     }
   ],
   '/zh/community/': [

doc/en/advanced/任务分布式执行.md

@@ -17,55 +17,8 @@
 - 配套任务状态监控能力，及时重置初始化超时或机器掉线的任务。
 
 :::tip
-TCA客户端除了通过localscan命令启动单次的代码分析，也可以作为一个分布式分析节点启动，作为常驻进程，多个节点可以分布式并行执行服务端下发的任务，提高扫描效率。和本地分析一样，需要先安装环境和必要的工具，并配置好服务端地址。
+TCA 客户端除了通过 localscan 命令启动单次的代码分析，也可以作为一个分布式分析节点启动，作为常驻进程，多个节点可以分布式并行执行服务端下发的任务，提高扫描效率。和本地分析一样，需要先安装环境和必要的工具，并配置好服务端地址。
 :::
 
 ## 常驻节点配置
-
-**前置步骤**：公共/专有机器上已具备客户端。
-
-开源版客户端，需要配置相关环境和依赖，可查阅帮助文档中的开源版客户端使用说明（如下图）
-
-   ![helpopensource](https://tencent.github.io/CodeAnalysis/media/helpopensource.png)
-  （界面右上角图标点击-帮助文档-Client 客户端）
-
-**1.配置 config.ini 文件**
-
-将`<Server IP地址>`替换成实际的serve ip（可包含端口号）。
-
-**2.启动代码分析常驻节点**
-
-1. 从TCA前端页面中获取 `token`，前往 个人中心-个人令牌-复制`Token` 。
-   - **作为公共节点**：`token`需要具有超级管理员权限（界面右上角图标点-管理入口-用户管理），如使用CodeDog账户的`token`。
-
-   - **作为专机节点**：该节点仅能分析该token具有权限的项目。
-
-2. 进入到client目录下，执行命令：
- `python3 codepuppy.py -l codepuppy.log start -t <token>`
-
-  ![order](https://tencent.github.io/CodeAnalysis/media/order.png)
-
-3. 启动后，可以在命令行输出或codepuppy.log中查看运行日志，如果未报异常，且输出`task loop is started.`，表示节点已经正常启动。
-
-**3.配置节点**
-
-:::tip
-常驻节点首次启动后，需要到节点管理页面设置节点状态（默认为不可用），将其设置为活跃，用于接收和执行任务。
-:::
-
-1. 进入TCA节点管理页面。可以看到当前在线的节点，可以修改节点名称、标签、负责人等信息。
-
-  ![NodeManagement](https://tencent.github.io/CodeAnalysis/media/Nodemanagement.png)
- （界面右上角图标点击-管理入口-节点管理）
-
-- 常驻节点首次启动后，需将节点状态从不可用（失效）状态切换到活跃（在线）状态。
-
-   ![StateSwitch](https://tencent.github.io/CodeAnalysis/media/StateSwitch.png)
-
-- 可以进入工具进程配置页面，对节点支持的工具进程进行管理（默认会全部勾选），未勾选的工具进程，将不会在该节点上执行。
-
-    ![ProcessConfiguration](https://tencent.github.io/CodeAnalysis/media/ProcessConfiguration.png)
-
-- 节点所属标签会与分析方案中的运行环境标签进行匹配，只有相同标签的任务才会下发到该机器节点上。
-
-本功能代码已提交开源版，欢迎使用！ :+1:
+请参考[客户端-常驻节点分析](../guide/客户端/常驻节点分析.md)

doc/en/advanced/集成代码分析工具.md

@@ -1,4 +1,4 @@
-# 在TCA源码中集成代码分析工具
+# 源码集成代码分析工具
 
 ## 初识TCA任务执行机制
 

doc/zh/advanced/任务分布式执行.md

@@ -20,52 +20,6 @@
 TCA客户端除了通过localscan命令启动单次的代码分析，也可以作为一个分布式分析节点启动，作为常驻进程，多个节点可以分布式并行执行服务端下发的任务，提高扫描效率。和本地分析一样，需要先安装环境和必要的工具，并配置好服务端地址。
 :::
 
-## 常驻节点配置
-
-**前置步骤**：公共/专有机器上已具备客户端。
-
-开源版客户端，需要配置相关环境和依赖，可查阅帮助文档中的开源版客户端使用说明（如下图）
-
-   ![helpopensource](https://tencent.github.io/CodeAnalysis/media/helpopensource.png)
-  （界面右上角图标点击-帮助文档-Client 客户端）
-
-**1.配置 config.ini 文件**
-
-将`<Server IP地址>`替换成实际的serve ip（可包含端口号）。
-
-**2.启动代码分析常驻节点**
-
-1. 从TCA前端页面中获取 `token`，前往 个人中心-个人令牌-复制`Token` 。
-   - **作为公共节点**：`token`需要具有超级管理员权限（界面右上角图标点-管理入口-用户管理），如使用CodeDog账户的`token`。
-
-   - **作为专机节点**：该节点仅能分析该token具有权限的项目。
-
-2. 进入到client目录下，执行命令：
- `python3 codepuppy.py -l codepuppy.log start -t <token>`
-
-  ![order](https://tencent.github.io/CodeAnalysis/media/order.png)
-
-3. 启动后，可以在命令行输出或codepuppy.log中查看运行日志，如果未报异常，且输出`task loop is started.`，表示节点已经正常启动。
-
-**3.配置节点**
 
-:::tip
-常驻节点首次启动后，需要到节点管理页面设置节点状态（默认为不可用），将其设置为活跃，用于接收和执行任务。
-:::
-
-1. 进入TCA节点管理页面。可以看到当前在线的节点，可以修改节点名称、标签、负责人等信息。
-
-  ![NodeManagement](https://tencent.github.io/CodeAnalysis/media/Nodemanagement.png)
- （界面右上角图标点击-管理入口-节点管理）
-
-- 常驻节点首次启动后，需将节点状态从不可用（失效）状态切换到活跃（在线）状态。
-
-   ![StateSwitch](https://tencent.github.io/CodeAnalysis/media/StateSwitch.png)
-
-- 可以进入工具进程配置页面，对节点支持的工具进程进行管理（默认会全部勾选），未勾选的工具进程，将不会在该节点上执行。
-
-    ![ProcessConfiguration](https://tencent.github.io/CodeAnalysis/media/ProcessConfiguration.png)
-
-- 节点所属标签会与分析方案中的运行环境标签进行匹配，只有相同标签的任务才会下发到该机器节点上。
-
-本功能代码已提交开源版，欢迎使用！ :+1:
+## 常驻节点配置
+请参考[客户端-常驻节点分析](../guide/客户端/常驻节点分析.md)

doc/zh/advanced/集成代码分析工具.md

@@ -1,4 +1,4 @@
-# 在TCA源码中集成代码分析工具
+# 源码集成代码分析工具
 
 ## 初识TCA任务执行机制