完善 Readme 文档 #16

Merged
yuysh merged 13 commits from Readme into master 2025-09-05 04:08:08 +00:00
4 changed files with 23 additions and 5 deletions
Showing only changes of commit 3865ed0c94 - Show all commits
+23 -5
View File
@@ -15,11 +15,10 @@ Manlink Knowledge Base
### 前期准备 ### 前期准备
1. 在[这里](http://mkb.local:3000/user/sign_up)注册账号 1. 在[这里](http://mkb.local:3000/user/sign_up)注册账号
2. 通知管理员将账户加入`Manlink_Doc` 仓库 2. 通知管理员将账户加入`Manlink_Doc` 仓库
3. 确保连接`manlink_internal`网络 3. 确保连接`manlink_internal`网络
4. 确保可以访问公共盘
### 环境部署 ### 环境部署
1. <a href = "http://mkb.local/_static/deploy/deploy.zip"> 点我下载环境 </a> 1. <a href = "http://mkb.local/_static/deploy/deploy.exe"> 点我下载环境 </a>
2. 解压压缩文件后运行`deploy.bat`,并根据提示输入必要信息(仅限英文字符) 2. 解压压缩文件后运行`deploy.bat`,并根据提示输入必要信息(仅限英文字符)
3. 若批处理正确运行完成,则应在解压目录下生成RUNME.bat 3. 若批处理正确运行完成,则应在解压目录下生成RUNME.bat
4. 双击RUNME.bat,应打开`vscode`环境并自动打开仓库目录 4. 双击RUNME.bat,应打开`vscode`环境并自动打开仓库目录
@@ -74,6 +73,25 @@ Manlink Knowledge Base
> [!WARNING] > [!WARNING]
> 您仅应对您编辑的分支发起合并请求 > 您仅应对您编辑的分支发起合并请求
2. 在创建合并请求界面,需清晰明了的创建标题及合并请求正文,同时在评审人一栏加入管理员进行审核,如需合作,也可在指派成员一栏邀请成员进行合作 2. 在创建合并请求界面,需清晰明了的创建标题及合并请求正文,如需合作,也可在指派成员一栏邀请成员进行合作
![PR_Create](./Readme/img/PR_Create.png) ![PR_Create](./Readme/img/PR_Create.png)
3. 创建合并分支后会默认触发自动化部署,如下图所示
![Pr_Action](./Readme/img/Pr_Action.png)
在正常情况下,自动化部署应顺利完成(理论运行时间<5min),运行完成后可在[http://mkb.local:880](http://mkb.local:880)查看及调试网页
>[!NOTE]
>此时如有问题,仍可以通过commit进行提交,提交后会触发自动化部署
>[!WARNING]
>服务器性能有限,且已人为将自动化部署并发数设为1,请尽可能避免在Pr后提交Commit
4. 在检查完测试网页后可添加管理员作为评审人,之后须有管理员评审并在通过审核后将分支合并至主分支
![PR_Review](./Readme/img/PR_Review.png)
![PR_Review_Judge](./Readme/img/PR_Review_Judge.png)
5. 最后需管理员手动合并测试网页至正式版网页
Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB