Merge pull request #569 from aaaa-j/main

提交文档修改,主要修改部署相关和首次分析相关

doc/.vuepress/config.ts

@@ -43,7 +43,7 @@ export default defineUserConfig({
     },
     '/en': {
       lang: 'en-US',
-      title: 'Tencent Code Analysis',
+      title: 'Tencent Cloud Code Analysis',
       description: '用心关注每行代码迭代、助力传承卓越代码文化！',
     },
   },

doc/.vuepress/configs/navbar/en.ts

@@ -2,8 +2,8 @@ import type { NavbarConfig } from '@vuepress/theme-default'
 
 export const en: NavbarConfig = [
   {
-    text: '快速入门',
-    link: '/en/quickStarted/deploySever.md',
+    text: '快速部署',
+    link: '/en/quickStarted/',
   },
   {
     text: '帮助文档',
@@ -24,9 +24,13 @@ export const en: NavbarConfig = [
         ],
       },
       {
-        text: '文章',
+        text: '依赖安装参考',
         children: [
-
+          '/en/advanced/install_python37_on_centos.md',
+          '/en/advanced/install_python37_on_ubuntu.md',
+          '/en/advanced/install_mysql_on_centos.md',
+          '/en/advanced/install_redis_from_source.md',
+          '/en/advanced/install_redis_on_centos.md',
         ],
       },
     ]

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

@@ -2,8 +2,8 @@ import type { NavbarConfig } from '@vuepress/theme-default'
 
 export const zh: NavbarConfig = [
   {
-    text: '快速入门',
-    link: '/zh/quickStarted/deploySever.md',
+    text: '快速部署',
+    link: '/zh/quickStarted/',
   },
   {
     text: '帮助文档',
@@ -19,14 +19,17 @@ export const zh: NavbarConfig = [
       {
         text: '深入',
         children: [
-          '/zh/advanced/任务分布式执行.md',
           '/zh/advanced/集成代码分析工具.md',
         ],
       },
       {
-        text: '文章',
+        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',
         ],
       },
     ]

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

@@ -66,9 +66,9 @@ export const en: SidebarConfig = {
     {
       text: '客户端',
       children: [
-        '/en/guide/客户端/配置说明.md',
         '/en/guide/客户端/本地分析.md',
         '/en/guide/客户端/常驻节点分析.md',
+        '/en/guide/客户端/其他配置.md',
       ]
     },
     {
@@ -124,35 +124,20 @@ export const en: SidebarConfig = {
     {
       text: '快速入门',
       link: '/en/quickStarted/deploySever.md',
-      // children: [
-      //   {
-      //     text: '快速入门',
-      //     link: '/en/quickStarted/deploySever.md',
-      //   },
-      // ],
-    },
-    {
-      text: '依赖安装参考',
-      // collapsible: true,
-      children: [
-        '/en/quickStarted/references/install_python37_on_centos.md',
-        '/en/quickStarted/references/install_python37_on_ubuntu.md',
-        '/en/quickStarted/references/install_mysql_on_centos.md',
-        '/en/quickStarted/references/install_redis_on_centos.md',
-        '/en/quickStarted/references/install_redis_from_source.md',
-        '/en/quickStarted/references/install_nginx_from_source.md',
-      ],
+      children: 
+         [
+          '/en/quickStarted/README.md',
+          '/en/quickStarted/dockerDeploy.md',
+          '/en/quickStarted/dockercomposeDeploy.md',
+          '/en/quickStarted/codeDeploy.md',
+         ],
     },
     {
       text: '其他',
       // collapsible: true,
       children: [
-        '/en/quickStarted/intro.md',
-        '/en/quickStarted/tools.md',
-        '/en/quickStarted/FAQ.md',
-        '/en/quickStarted/codeDeploy.md',
-        '/en/quickStarted/dockercomposeDeploy.md',
         '/en/quickStarted/enhanceDeploy.md',
+        '/en/quickStarted/FAQ.md',
       ],
     },
   ],

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

@@ -66,9 +66,9 @@ export const zh: SidebarConfig = {
     {
       text: '客户端',
       children: [
-        '/zh/guide/客户端/配置说明.md',
         '/zh/guide/客户端/本地分析.md',
         '/zh/guide/客户端/常驻节点分析.md',
+        '/zh/guide/客户端/其他配置.md',
       ]
     },
     {
@@ -123,36 +123,19 @@ export const zh: SidebarConfig = {
   '/zh/quickStarted/': [
     {
       text: '快速入门',
-      link: '/zh/quickStarted/deploySever.md',
-      // children: [
-      //   {
-      //     text: '快速入门',
-      //     link: '/zh/quickStarted/deploySever.md',
-      //   },
-      // ],
-    },
-    {
-      text: '依赖安装参考',
-      // collapsible: true,
       children: [
-        '/zh/quickStarted/references/install_python37_on_centos.md',
-        '/zh/quickStarted/references/install_python37_on_ubuntu.md',
-        '/zh/quickStarted/references/install_mysql_on_centos.md',
-        '/zh/quickStarted/references/install_redis_on_centos.md',
-        '/zh/quickStarted/references/install_redis_from_source.md',
-        '/zh/quickStarted/references/install_nginx_from_source.md',
-      ],
+        '/zh/quickStarted/README.md',
+        '/zh/quickStarted/dockerDeploy.md',
+        '/zh/quickStarted/dockercomposeDeploy.md',
+        '/zh/quickStarted/codeDeploy.md',
+      ]
     },
     {
       text: '其他',
       // collapsible: true,
       children: [
-        '/zh/quickStarted/intro.md',
-        '/zh/quickStarted/tools.md',
-        '/zh/quickStarted/FAQ.md',
-        '/zh/quickStarted/codeDeploy.md',
-        '/zh/quickStarted/dockercomposeDeploy.md',
         '/zh/quickStarted/enhanceDeploy.md',
+        '/zh/quickStarted/FAQ.md',
       ],
     },
   ],

doc/README.md

@@ -3,8 +3,8 @@ home: true
 title: 腾讯云代码分析文档
 heroImage: /images/Logo.svg
 actions:
-  - text: 快速入门
-    link: /zh/quickStarted/deploySever.html
+  - text: 快速部署
+    link: /zh/quickStarted/
     type: primary
   - text: 帮助文档
     link: /zh/guide/
@@ -35,48 +35,3 @@ footer: MIT Licensed | Copyright © 1998-present Tencent. All Rights Reserved.
 
 [https://git.code.tencent.com/Tencent_Open_Source/CodeAnalysis.git](https://git.code.tencent.com/Tencent_Open_Source/CodeAnalysis.git)
 
-### 腾讯云代码分析简介
-
-腾讯云代码分析（Tencent Cloud Code Analysis，简称TCA，内部曾用研发代号 **CodeDog** ）是集众多分析工具的云原生、分布式、高性能的代码综合分析跟踪平台，包含服务端、Web端和客户端三个组件，已集成一批自研工具，同时也支持动态集成业界各编程语言的分析工具。
-
-代码分析是通过词法分析、语法分析、控制流、数据流分析等技术对程序代码进行扫描，对代码进行综合分析，验证代码是否满足规范性、安全性、可靠性、可维护性等指标的一种代码分析技术。
-
-使用TCA可以帮助团队用代码分析技术查找代码中的规范性、结构性、安全漏洞等问题，持续监控项目代码质量并进行告警。同时TCA开放API，支持与上下游系统对接，从而集成代码分析能力，为代码质量提供保障，更有益于传承优良的团队代码文化。  
-
-![组件图](https://tencent.github.io/CodeAnalysis/media/Components.png)
-
-![流程图](https://tencent.github.io/CodeAnalysis/media/Flow.png)
-
-### 体验
-
-[官方版本](http://tca.tencent.com)
-
-### 快速入门
-
-- [快速入门](./zh/quickStarted/intro.md)
-- [如何在本地部署Server与Web](./zh/quickStarted/deploySever.md#通过源代码)
-- [如何通过Docker-Compose部署Server与Web](./zh/quickStarted/deploySever.md#通过docker-compose)
-- [如何使用客户端](./zh/quickStarted/deployClient.md)
-- [部署常见问题与解决方式](./zh/quickStarted/FAQ.md)
-
-## 社区
-
-- 微信公众号：「腾讯云静态分析」，关注并发送“进群”即可加入官方开源交流微信群
-- QQ交流群：361791391  
-- [GitHub讨论区](https://github.com/Tencent/CodeAnalysis/discussions)
-- [Wiki](https://github.com/Tencent/CodeAnalysis/wiki)
-- [腾讯云代码分析白皮书](https://github.com/Tencent/CodeAnalysis/tree/main/腾讯云代码分析白皮书.pdf)
-
-## 更新日志
-
-[Changelog](https://github.com/Tencent/CodeAnalysis/tree/main/CHANGELOG.md)
-
-## 贡献
-
-- 查看我们的[贡献说明](https://github.com/Tencent/CodeAnalysis/tree/main/CONTRIBUTING.md)
-- [腾讯开源摘星计划2022](https://github.com/weopenprojects/WeOpen-Star/issues/19#issue-1228583868)（活动时间：2022年5月~12月）
-- [腾讯开源激励计划](https://opensource.tencent.com/contribution) 鼓励开发者的参与和贡献，期待你的加入
-
-### License
-
-[MIT licensed](https://github.com/Tencent/CodeAnalysis/tree/main/LICENSE)

doc/en/README.md

@@ -3,8 +3,8 @@ home: true
 title: 腾讯云代码分析文档
 heroImage: /images/Logo.svg
 actions:
-  - text: 快速入门
-    link: /zh/quickStarted/deploySever.html
+  - text: 快速部署
+    link: /en/quickStarted/
     type: primary
   - text: 帮助文档
     link: /zh/guide/
@@ -34,49 +34,3 @@ footer: MIT Licensed | Copyright © 1998-present Tencent. All Rights Reserved.
 ### Repo Mirror
 
 [https://git.code.tencent.com/Tencent_Open_Source/CodeAnalysis.git](https://git.code.tencent.com/Tencent_Open_Source/CodeAnalysis.git)
-
-### What is TCA
-
-Tencent Cloud Code Analysis (TCA for short, code-named **CodeDog** inside the company early) is a comprehensive platform for code analysis and issue tracking. TCA consist of three components, server, web and client. It integrates of a number of self-developed tools, and also supports dynamic integration of code analysis tools in various programming languages.
-
-Code analysis is a technology, using lexical analysis, syntax analysis, control-flow analysis, data-flow analysis to make a comprehensive analysis of the code, so as to verify whether the code meets the requirements of normative, security, reliability, maintainability and other indicators.
-
-Using TCA can help team find normative, structural, security vulnerabilities and other issues in the code, continuously monitor the quality of the project code and issue alerts. At the same time, TCA opens up APIs to support connection with upstream and downstream systems, so as to integrate code analysis capabilities, ensure code quality, and be more conducive to inheriting an excellent team code culture.
-
-![组件图](https://tencent.github.io/CodeAnalysis/media/Components.png)
-
-![流程图](https://tencent.github.io/CodeAnalysis/media/Flow.png)
-
-### Experience
-
-[Experience Link](http://tca.tencent.com)
-
-### Getting Started
-
-- [How to get start](./quickStarted/intro.md)
-- [How to deploy server and web](./quickStarted/deploySever.md#通过源代码)
-- [How to deploy server and web with docker-compose](./quickStarted/deploySever.md#通过docker-compose)
-- [How to use client](./quickStarted/deployClient.md)
-- [Deploy Q&A](./quickStarted/FAQ.md)
-
-### Community
-
-- WeChat official account:腾讯云静态分析
-- QQ Group: 361791391
-- [Discussion](https://github.com/Tencent/CodeAnalysis/discussions)
-- [Wiki](https://github.com/Tencent/CodeAnalysis/wiki)
-- [White Paper](https://github.com/Tencent/CodeAnalysis/tree/main/腾讯云代码分析白皮书.pdf)
-
-### Changelogs
-
-- Check our [Changelog](https://github.com/Tencent/CodeAnalysis/tree/main/CHANGELOG.md)
-
-### Contributing
-
-- Check out [CONTRIBUTING](https://github.com/Tencent/CodeAnalysis/tree/main/CONTRIBUTING.md) to see how to develop with TCA.
-- [Tencent WeOpen Star Project](https://github.com/weopenprojects/WeOpen-Star/issues/19#issue-1228583868)（From May 2022 to September 2022）
-- [Tencent Open Source Incentive Program](https://opensource.tencent.com/contribution) encourages the participation and contribution of developers. We look forward to your active participation.
-
-### License
-
-TCA is [MIT licensed](https://github.com/Tencent/CodeAnalysis/tree/main/LICENSE)

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

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