管理员配置手册优化

doc/管理员手册.MD

@@ -1,59 +1,51 @@
 ## 管理员操作手册
 
-### 一、Git服务器的Webhook配置(Gitlab为例)
+本文档描述了配置 GitLab Webhook 的标准流程，重点操作如下：
 
-1. 在Git服务器（例如 GitHub、GitLab 等）中配置 Webhook，确保当代码提交或分支更新时，能够及时向 PR 管理系统发送通知。
+---
 
-> 个人访问令牌配置(配置Git服务需要用到)
+### 1. 在 GitLab 中创建用户令牌
-![个人令牌配置](../static/md_image/gitlab_access.png)
+- 登录 GitLab 后，进入`用户设置`。
+- 新建个人访问令牌（User Token）。
+- 保存该令牌，后续在 PR 系统中配置 Git 服务时需要使用。
+![用户令牌](../static/md_image/gitlab_access.png)
 
-> 项目访问令牌配置(配置项目服务需要用到)
+---
-![项目令牌](../static/md_image/令牌1.png)
-![项目令牌](../static/md_image/Webhook配置.png)
 
-2. 配置时，请确认 URL 指向 PR 管理系统，并设置合适的触发条件，如 push 事件和合并请求事件。
+### 2. 在 PR 系统中创建 Git 服务配置
+- 登录 PR 管理系统后台，进入`Git服务器配置`模块。
+- 填写 GitLab 服务器的地址及`步骤1`中创建的用户令牌等必要信息。
+![Git服务配置](../static/md_image/Git服务配置.png)
 
-> Webhook 配置
+---
+
+### 3. 在 GitLab 中创建项目访问令牌
+- 进入对应项目，生成项目访问令牌（Project Token）。
+- 将此令牌保存好，后续将用于项目配置及 Webhook 秘钥设置。
+![项目令牌](../static/md_image/项目Secret.png)
+
+---
+
+### 4. 在 PR 系统中创建项目配置
+- 在 PR 管理系统中进入`项目配置`模块。
+- 添加新项目，选择Git服务器、填写项目名称、仓库地址，并输入步骤3中创建的项目访问令牌。
+- 配置完成后，测试项目连接是否正常。
+![项目配置](../static/md_image/项目配置.png)
+
+---
+
+### 5. 在 GitLab 中配置 Webhook
+- 打开 GitLab 项目的 Webhook 配置页面。
+- 设置 Webhook URL 指向 PR 管理系统的webhook地址，暂时配置为：http://{{host}}/api/v1/pr/webhook/
+- 将 Webhook 的Secret令牌设置为步骤3中创建的项目访问令牌。
+- 由于目前只处理合并请求，所以触发来源选择`合并请求事件`即可。
+- 关闭SSL验证。
 ![Webhook配置](../static/md_image/w1.png)
 ![Webhook配置](../static/md_image/w2.png)
 
-### 二、PR管理系统中Git服务器的配置
+---
 
-> 【示例：当前配置以 GitLab 为例，后续可能支持 Gitea 等其他 Git 服务】
+### 注意事项
-
+- 每一步配置完成后都务必测试，确保各配置项工作正常。
-
+- 请妥善保管令牌信息，避免泄露引发安全风险。
-1. 登录 PR 管理系统后台，进入“Git服务器配置”模块。
+- 配置过程中遇到问题，请参考相应系统的详细文档进行排查。
-> Git服务器配置(Git地址跟秘钥地址参考个人令牌)
-![Git服务器配置](../static/md_image/Git服务配置.png)
-
-2. 填写 Git 服务器的地址、访问令牌以及其他必要参数。
-3. 测试连接，确保 PR 管理系统能够正常访问并与 Git 服务器进行数据交互。
-> 在Git服务器配置中测试，测试无误Pr系统会看到日志
-
-### 三、PR管理系统中AI服务器的配置
-1. 在 PR 管理系统中找到“AI服务器配置”入口。
-> AI服务器配置(填写AI代理地址跟秘钥)
-![AI服务器配置](../static/md_image/AI配置.png)
-
-2. 配置 AI 服务器的地址、API 密钥和认证信息，确保系统可以调用 AI 服务进行代码评审或自动合并等操作。
-3. 完成配置后，执行测试以确认 AI 服务器已正确响应请求。
-
-### 四、PR管理系统中项目配置
-1. 在 PR 管理系统中添加和配置项目，填写项目名称、代码仓库地址、分支信息等基本信息。
-> 要通过PR管理系统管理项目，需要在PR管理系统中添加项目，填写项目名称、代码仓库地址、分支信息等基本信息。
-![项目配置](../static/md_image/项目配置.png)
-
-2. 确认项目配置与实际仓库设置一致，确保后续的代码同步和合并操作不会出错。
-3. 定期更新项目配置，以反映任何仓库地址或分支结构的变动。
-
-### 五、PR管理系统中指令配置
-1. 配置自动化操作指令，例如代码审查、自动合并、单元测试的触发指令等。
-> 目前默认仅支持PR操作
-
-2. 每条指令应明确触发条件和执行步骤，以保障自动化流程的高效执行。
-3. 对常用指令编写详细的操作说明，并进行充分测试以确保其可靠性。
-
-### 六、注意事项
-1. 配置过程中，请仔细阅读各系统的相关文档，避免因配置错误造成系统故障。
-2. 完成每项配置后，建议逐个功能进行测试，确保各项服务（Webhook、Git服务器、AI服务器及指令）均能正常工作。
-3. 定期检查配置状态，及时更新和修复配置问题，保障系统持续稳定运行。