Skip to content

Commit 371e900

Browse files
committed
提交英文版相关修改,对齐中文版文档
1 parent ef422bb commit 371e900

34 files changed

Lines changed: 550 additions & 380 deletions

doc/.vuepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export default defineUserConfig({
4343
},
4444
'/en': {
4545
lang: 'en-US',
46-
title: 'Tencent Code Analysis',
46+
title: 'Tencent Cloud Code Analysis',
4747
description: '用心关注每行代码迭代、助力传承卓越代码文化!',
4848
},
4949
},

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import type { NavbarConfig } from '@vuepress/theme-default'
22

33
export const en: NavbarConfig = [
44
{
5-
text: '快速入门',
6-
link: '/en/quickStarted/deploySever.md',
5+
text: '快速部署',
6+
link: '/en/quickStarted/',
77
},
88
{
99
text: '帮助文档',
@@ -24,9 +24,13 @@ export const en: NavbarConfig = [
2424
],
2525
},
2626
{
27-
text: '文章',
27+
text: '依赖安装参考',
2828
children: [
29-
29+
'/en/advanced/install_python37_on_centos.md',
30+
'/en/advanced/install_python37_on_ubuntu.md',
31+
'/en/advanced/install_mysql_on_centos.md',
32+
'/en/advanced/install_redis_from_source.md',
33+
'/en/advanced/install_redis_on_centos.md',
3034
],
3135
},
3236
]

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ export const zh: NavbarConfig = [
2525
{
2626
text: '依赖安装参考',
2727
children: [
28-
'/zh/quickStarted/references/install_python37_on_centos.md',
29-
'/zh/quickStarted/references/install_python37_on_ubuntu.md',
30-
'/zh/quickStarted/references/install_mysql_on_centos.md',
31-
'/zh/quickStarted/references/install_redis_from_source.md',
32-
'/zh/quickStarted/references/install_redis_on_centos.md',
28+
'/zh/advanced/install_python37_on_centos.md',
29+
'/zh/advanced/install_python37_on_ubuntu.md',
30+
'/zh/advanced/install_mysql_on_centos.md',
31+
'/zh/advanced/install_redis_from_source.md',
32+
'/zh/advanced/install_redis_on_centos.md',
3333
],
3434
},
3535
]

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

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ export const en: SidebarConfig = {
6666
{
6767
text: '客户端',
6868
children: [
69-
'/en/guide/客户端/配置说明.md',
7069
'/en/guide/客户端/本地分析.md',
7170
'/en/guide/客户端/常驻节点分析.md',
71+
'/en/guide/客户端/其他配置.md',
7272
]
7373
},
7474
{
@@ -124,35 +124,20 @@ export const en: SidebarConfig = {
124124
{
125125
text: '快速入门',
126126
link: '/en/quickStarted/deploySever.md',
127-
// children: [
128-
// {
129-
// text: '快速入门',
130-
// link: '/en/quickStarted/deploySever.md',
131-
// },
132-
// ],
133-
},
134-
{
135-
text: '依赖安装参考',
136-
// collapsible: true,
137-
children: [
138-
'/en/quickStarted/references/install_python37_on_centos.md',
139-
'/en/quickStarted/references/install_python37_on_ubuntu.md',
140-
'/en/quickStarted/references/install_mysql_on_centos.md',
141-
'/en/quickStarted/references/install_redis_on_centos.md',
142-
'/en/quickStarted/references/install_redis_from_source.md',
143-
'/en/quickStarted/references/install_nginx_from_source.md',
144-
],
127+
children:
128+
[
129+
'/en/quickStarted/README.md',
130+
'/en/quickStarted/dockerDeploy.md',
131+
'/en/quickStarted/dockercomposeDeploy.md',
132+
'/en/quickStarted/codeDeploy.md',
133+
],
145134
},
146135
{
147136
text: '其他',
148137
// collapsible: true,
149138
children: [
150-
'/en/quickStarted/intro.md',
151-
'/en/quickStarted/tools.md',
152-
'/en/quickStarted/FAQ.md',
153-
'/en/quickStarted/codeDeploy.md',
154-
'/en/quickStarted/dockercomposeDeploy.md',
155139
'/en/quickStarted/enhanceDeploy.md',
140+
'/en/quickStarted/FAQ.md',
156141
],
157142
},
158143
],

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const zh: SidebarConfig = {
1818
]
1919
},
2020
{
21-
text: '分析结果',
21+
text: '代码检查',
2222
children: [
2323
'/zh/guide/代码检查/分析结果查看.md',
2424
'/zh/guide/代码检查/添加规则配置.md',
@@ -135,7 +135,6 @@ export const zh: SidebarConfig = {
135135
// collapsible: true,
136136
children: [
137137
'/zh/quickStarted/enhanceDeploy.md',
138-
'/zh/quickStarted/tools.md',
139138
'/zh/quickStarted/FAQ.md',
140139
],
141140
},

doc/en/README.md

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ home: true
33
title: 腾讯云代码分析文档
44
heroImage: /images/Logo.svg
55
actions:
6-
- text: 快速入门
7-
link: /zh/quickStarted/deploySever.html
6+
- text: 快速部署
7+
link: /en/quickStarted/
88
type: primary
99
- text: 帮助文档
1010
link: /zh/guide/
@@ -34,49 +34,3 @@ footer: MIT Licensed | Copyright © 1998-present Tencent. All Rights Reserved.
3434
### Repo Mirror
3535

3636
[https://git.code.tencent.com/Tencent_Open_Source/CodeAnalysis.git](https://git.code.tencent.com/Tencent_Open_Source/CodeAnalysis.git)
37-
38-
### What is TCA
39-
40-
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.
41-
42-
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.
43-
44-
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.
45-
46-
![组件图](https://tencent.github.io/CodeAnalysis/media/Components.png)
47-
48-
![流程图](https://tencent.github.io/CodeAnalysis/media/Flow.png)
49-
50-
### Experience
51-
52-
[Experience Link](http://tca.tencent.com)
53-
54-
### Getting Started
55-
56-
- [How to get start](./quickStarted/intro.md)
57-
- [How to deploy server and web](./quickStarted/deploySever.md#通过源代码)
58-
- [How to deploy server and web with docker-compose](./quickStarted/deploySever.md#通过docker-compose)
59-
- [How to use client](./quickStarted/deployClient.md)
60-
- [Deploy Q&A](./quickStarted/FAQ.md)
61-
62-
### Community
63-
64-
- WeChat official account:腾讯云静态分析
65-
- QQ Group: 361791391
66-
- [Discussion](https://github.com/Tencent/CodeAnalysis/discussions)
67-
- [Wiki](https://github.com/Tencent/CodeAnalysis/wiki)
68-
- [White Paper](https://github.com/Tencent/CodeAnalysis/tree/main/腾讯云代码分析白皮书.pdf)
69-
70-
### Changelogs
71-
72-
- Check our [Changelog](https://github.com/Tencent/CodeAnalysis/tree/main/CHANGELOG.md)
73-
74-
### Contributing
75-
76-
- Check out [CONTRIBUTING](https://github.com/Tencent/CodeAnalysis/tree/main/CONTRIBUTING.md) to see how to develop with TCA.
77-
- [Tencent WeOpen Star Project](https://github.com/weopenprojects/WeOpen-Star/issues/19#issue-1228583868)(From May 2022 to September 2022)
78-
- [Tencent Open Source Incentive Program](https://opensource.tencent.com/contribution) encourages the participation and contribution of developers. We look forward to your active participation.
79-
80-
### License
81-
82-
TCA is [MIT licensed](https://github.com/Tencent/CodeAnalysis/tree/main/LICENSE)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)