Merge pull request #211 from RussGan/feature/optimize_guideline

🎨优化指引文档

Author: tommy

GettingStart(快速入门).md

@@ -4,19 +4,21 @@
 
 详见服务部署文档：[doc/deploy.md](doc/deploy.md)
 
-## 2. 配置项目
-
+## 2. 配置项目  
+###- Step 1：在浏览器输入http://<部署机IP>/，进入TCA主页，开始项目配置。
 ![homepage](https://tencent.github.io/CodeAnalysis/media/homepage.png)
 
-### a. 创建团队，创建项目
+###- Step 2：创建团队及项目。
 
 <img src="https://tencent.github.io/CodeAnalysis/media/createTeam.png" width = "50%" /><img src="https://tencent.github.io/CodeAnalysis/media/createProject.png" width = "45%" />
 
-### b. 登记代码库
+###- Step 3：登记代码库。输入代码库地址及配置凭证信息。
+
+<img src="https://tencent.github.io/CodeAnalysis/media/registerCodeRepo.png" width = "90%" />   
 
-<img src="https://tencent.github.io/CodeAnalysis/media/registerCodeRepo.png" width = "90%" />
+    注：在本地扫描模式下，待扫描的代码库需在客户端配置文件中配置本地路径，步骤3中登记的代码库并非最终实际扫描的代码库，详见客户端使用文档。
 
-### c. 创建分析方案，配置代码检查规则包
+###- Step 4：创建分析方案，配置代码检查规则包。首次扫描可勾选「普通创建」，根据待分析的语言及问题类型勾选「分析语言」及「功能」。
 
 <img src="https://tencent.github.io/CodeAnalysis/media/creataAnalysePlan.png" width = "50%" />
 <img src="https://tencent.github.io/CodeAnalysis/media/planPage.png"/>

doc/client.md

@@ -2,12 +2,12 @@
 
 ## 1. 安装Python环境和第三方库
 
-a. 预装Python3.7、pip，支持 `python3` 和 `pip3` 命令
-b. 在本地源码目录下安装依赖：`pip3 install -r client/requirements/app_reqs.pip`
+a. 预装Python3.7、pip，支持 `python3` 和 `pip3` 命令  
+b. 在本地源码目录下安装依赖：`pip3 install -r client/requirements/app_reqs.pip`  
 
 ## 2. 安装第三方工具
 
-a. 进入到`client/requirements`目录
+a. 进入到`client/requirements`目录  
 b. 在命令行中执行安装脚本`install.sh`(linux/mac环境)或`install.bat`(windows环境)
 
 ## 3. 配置client/config.ini文件
@@ -46,5 +46,7 @@ b. 在命令行中执行安装脚本`install.sh`(linux/mac环境)或`install.bat
 ## 5. 启动一次代码分析
 
 进入到`client`目录下，执行命令：`python3 codepuppy.py localscan`  
-注：步骤4中codedog.ini各项参数可由命令行传入，获取详细参数说明可运行`python3 codepuppy.py localscan -h`。  
-使用`localscan`命令启动本地单次的代码分析，如需启动分布式并行分析任务，请参考[使用分布式节点模式](../client/README.md#五使用分布式节点模式执行客户端)进行配置。
+>说明：
+>- 步骤4中codedog.ini各项参数可由命令行传入，获取详细参数说明可运行`python3 codepuppy.py localscan -h`。  
+>- client的实现及启动脚本均依赖Python3版本为3.7，可执行``python3 --version``查看版本。若版本有误，可安装版本为3.7的python并软链接到python3命令。  
+>- 使用`localscan`命令启动本地单次的代码分析，如需启动分布式并行分析任务，请参考[使用分布式节点模式](../client/README.md#五使用分布式节点模式执行客户端)进行配置。

doc/references/install_redis_on_centos.md

@@ -9,6 +9,7 @@ CentOS 7.3 版本
 ```bash
 $ yum install redis
 ```
+注：安装redis可能会出现"no package redis available"的错误提示，请执行``yum install epel-release``后重试redis安装命令。
 
 ## 修改redis密码
 ```bash

server/dockerconfs/.env.local

@@ -17,7 +17,7 @@ MAIN_SECRET_KEY=lh+6y8pyf16bbor*)p=kp=p(cg615+y+5nnin$l(n%os$8z^v%
 ## 服务DB配置
 MAIN_DB_NAME=codedog_main
 MAIN_DB_USER=root
-MAIN_DB_PASSWORD=TCA!@#2021
+MAIN_DB_PASSWORD='TCA!@#2021'
 MAIN_DB_HOST=mysql
 MAIN_DB_PORT=3306
 
@@ -44,7 +44,7 @@ ANALYSIS_SECRET_KEY=25n=e*_e=4q!ert$4u#9v&^2n+)_#mi7&7ll@x29@j=w=k^q@^
 ## 服务DB配置
 ANALYSIS_DB_NAME=codedog_analysis
 ANALYSIS_DB_USER=root
-ANALYSIS_DB_PASSWORD=TCA!@#2021
+ANALYSIS_DB_PASSWORD='TCA!@#2021'
 ANALYSIS_DB_HOST=mysql
 ANALYSIS_DB_PORT=3306
 
@@ -73,7 +73,7 @@ TCA_DEFAULT_PASSWORD=admin
 ## 服务DB配置
 LOGIN_DB_NAME=codedog_login
 LOGIN_DB_USER=root
-LOGIN_DB_PASSWORD=TCA!@#2021
+LOGIN_DB_PASSWORD='TCA!@#2021'
 LOGIN_DB_HOST=mysql
 LOGIN_DB_PORT=3306
 
@@ -90,7 +90,7 @@ FILE_SECRET_KEY=8b_!6t@kb=63c)4#e^0wub=x8%xd9624jm@#eiv3y#%b_%4!n=
 ## 服务DB配置
 FILE_DB_NAME=codedog_file
 FILE_DB_USER=root
-FILE_DB_PASSWORD=TCA!@#2021
+FILE_DB_PASSWORD='TCA!@#2021'
 FILE_DB_HOST=mysql
 FILE_DB_PORT=3306