diff --git a/doc/.vuepress/configs/sidebar/en.ts b/doc/.vuepress/configs/sidebar/en.ts index b8520bcf2..08a0b8734 100644 --- a/doc/.vuepress/configs/sidebar/en.ts +++ b/doc/.vuepress/configs/sidebar/en.ts @@ -30,7 +30,6 @@ export const en: SidebarConfig = { '/en/guide/代码检查/工具/TCA-Armory-R.md', '/en/guide/代码检查/工具/TCA-Armory-C1.md', '/en/guide/代码检查/工具/TCA-Armory-Q1.md', - '/en/guide/代码检查/工具/cppcheck.md', '/en/guide/代码检查/工具/Error-Prone.md', ], }, diff --git a/doc/.vuepress/configs/sidebar/zh.ts b/doc/.vuepress/configs/sidebar/zh.ts index 0fdcfe31e..f756113c3 100644 --- a/doc/.vuepress/configs/sidebar/zh.ts +++ b/doc/.vuepress/configs/sidebar/zh.ts @@ -30,7 +30,6 @@ export const zh: SidebarConfig = { '/zh/guide/代码检查/工具/TCA-Armory-R.md', '/zh/guide/代码检查/工具/TCA-Armory-C1.md', '/zh/guide/代码检查/工具/TCA-Armory-Q1.md', - '/zh/guide/代码检查/工具/cppcheck.md', '/zh/guide/代码检查/工具/Error-Prone.md', ], }, diff --git "a/doc/en/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" "b/doc/en/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" index 51e10ecdd..33032537f 100644 --- "a/doc/en/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" +++ "b/doc/en/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" @@ -28,6 +28,10 @@ - 安装依赖：`pip3 install -r CodeAnalysis/client/requirements/app_reqs.pip` **4. 安装第三方工具（docker下启动分析可跳过）** +- 在命令行(windows环境下可以启动`git bash`)中执行以下命令： +```bash +bash ./scripts/base/install_bin.sh +``` - 进入到`client/requirements`目录 - 在命令行中执行安装脚本`install.sh`(linux/mac环境)或`install.bat`(windows环境) diff --git a/doc/en/quickStarted/enhanceDeploy.md b/doc/en/quickStarted/enhanceDeploy.md index caa874e6d..68169eb66 100644 --- a/doc/en/quickStarted/enhanceDeploy.md +++ b/doc/en/quickStarted/enhanceDeploy.md @@ -85,35 +85,19 @@ Different deployment methods can modify the `config.ini` configuration according - Restart the container method: `docker-compose restart client` ::: -3. Apply for a License by email to the TCA team - -- Recipient email: -``` -v_cocohwang@tencent.com -v_xiohuang@tencent.com -yalechen@tencent.com -tommyzhang@tencent.com -``` - -- The application email format is as follows: - -Subject: **TCA Independent Tool License Application** - -Content: -| | | -| :----: | :----: | -| Applicant's Name | xxx | -| Name of the Organization the Applicant Belongs to | xxx | -| Type of Organization the Applicant Belongs to | Optional: Company/School/Individual | -| Applicant's Email | xxx | -| Applicant's Mobile Number | xxx | -| Is it Privately Deployed | Yes | -| First Registered Machine Code | xxx | -| Purpose of Experience Application | xxx | -| Client License | xxx | - -- `First Registered Machine Code`: The `Server ID` output in step one -- `Client License`: The `Client License` output in step one +3. Submit a private cloud license application on the TCA Cloud official website +- (1) Register or log in to an account on the [TCA Cloud official website](https://tca.tencent.com/); +- (2) Enter the team that needs to apply for a private cloud license (if there is no team, you need to create a corresponding team); +- (3) On the team page, enter the [Node Management]->[Private Cloud License Configuration] page in turn, then click the [Apply for License] button in the upper right corner, fill in the relevant information and submit the application. The specific information is as follows: + - Applicant name + - Applicant's organization name + - Applicant's organization type: company/university/individual + - Applicant's email address + - Applicant's mobile phone number + - Server ID: `Server ID` output in step 1, the machine code for the first registration + - Client License: `Client License` output in step 1 + - Application scenario +- (4) Then wait for the application license to be reviewed and approved, you can copy the private cloud license and continue with the following step 4. 4. After receiving the reply email from the TCA team, fill in the License in the `config.yaml` file in the CLS directory diff --git "a/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" "b/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" index 51e10ecdd..33032537f 100644 --- "a/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" +++ "b/doc/zh/guide/\345\256\242\346\210\267\347\253\257/\346\234\254\345\234\260\345\210\206\346\236\220.md" @@ -28,6 +28,10 @@ - 安装依赖：`pip3 install -r CodeAnalysis/client/requirements/app_reqs.pip` **4. 安装第三方工具（docker下启动分析可跳过）** +- 在命令行(windows环境下可以启动`git bash`)中执行以下命令： +```bash +bash ./scripts/base/install_bin.sh +``` - 进入到`client/requirements`目录 - 在命令行中执行安装脚本`install.sh`(linux/mac环境)或`install.bat`(windows环境) diff --git a/doc/zh/quickStarted/enhanceDeploy.md b/doc/zh/quickStarted/enhanceDeploy.md index c4524619b..18c8707ab 100644 --- a/doc/zh/quickStarted/enhanceDeploy.md +++ b/doc/zh/quickStarted/enhanceDeploy.md @@ -85,35 +85,19 @@ LICENSE= - 重启容器方式：`docker-compose restart client` ::: -3. 向 TCA 团队邮件申请 License - -- 收件邮箱： -``` -v_cocohwang@tencent.com -v_xiohuang@tencent.com -yalechen@tencent.com -tommyzhang@tencent.com -``` - -- 申请邮件格式如下： - -主题：**TCA 独立工具 License 申请** - -正文： -| | | -| :----: | :----: | -| 申请人名称 | xxx | -| 申请人所在组织名称 | xxx | -| 申请人所在组织类型 | 可选选项：公司/学校/个人 | -| 申请人邮箱 | xxx | -| 申请人手机号码 | xxx | -| 是否私有化部署 | 是 | -| 首次登记的机器码 | xxx | -| 体验申请用途 | xxx | -| Client License | xxx | - -- `首次登记的机器码`: 步骤一中输出的`Server ID` -- `Client License`: 步骤一中输出的`Client License` +3. 在 TCA 云官网上提交私有云 License 申请 +- (1) 在 [TCA 云官网](https://tca.tencent.com/)上注册或登录账号; +- (2) 进入需要申请私有云 License 申请的团队（如果没有的话需要创建对应团队）； +- (3) 在团队页面上，依次进入【节点管理】->【私有云 License 配置】页面，然后点击右上角的【申请License】按钮，填写相关信息即可提交申请。具体的信息内容如下： + - 申请人名称 + - 申请人所在组织名称 + - 申请人所在组织类型：公司/高校/个人 + - 申请人邮箱 + - 申请人手机号码 + - Server ID：步骤一中输出的`Server ID`，首次登记的机器码 + - Client License：步骤一中输出的`Client License` + - 应用场景 +- (4) 然后等待申请License审核通过，即可拷贝出该私有云 License 继续进行下面第4步的操作。 4. 收到 TCA 团队回复邮件之后，在 CLS 目录下的 [`config.yaml`](https://github.com/Tencent/CodeAnalysis/blob/main/server/cls/config.yaml) 文件中填写License