diff --git a/docs/合并请求/合并请求简介.md b/docs/合并请求/合并请求简介.md index c0ac142..9bb4295 100644 --- a/docs/合并请求/合并请求简介.md +++ b/docs/合并请求/合并请求简介.md @@ -5,11 +5,13 @@ sidebar_position: 1 # 合并请求简介 -**合并请求(PR)** 模块提供合并请求创建和管理两方面的功能: +**Pull Request**,即**合并请求**,是现代分布式软件开发中两个软件仓库间合并代码变更的一种方式,通常用于 fork 仓库向被 fork 仓库(源仓库)提交代码变更,同时也是为团队项目或开源项目做贡献的一种非常好的团队协作方式。当你拉取并修改了他人的仓库代码后,将你的修改告知给原仓库的管理者,请求其合并你的修改,这个过程就被称为 **合并请求**。 -- 一方面支持向源项目或者同一个项目其他分支创建(发起)代码合并请求(Pull Request,PR); +GitLink中的 **合并请求(PR)** 模块提供合并请求创建和管理两方面的功能: -- 另一方面也为项目管理者对他人发送到本项目的合并请求进行管理、审阅并最终确定是否纳入项目。 +- 一方面支持向源仓库或者同一个仓库其他分支创建(发起)代码合并请求; + +- 另一方面也为仓库管理者对他人发送到本仓库的合并请求进行管理、审阅并最终确定是否纳入仓库。 如下图所示为合并请求(PR)管理模块: diff --git a/docs/快速开始/导入GitHub等第三方Git项目.md b/docs/快速开始/导入GitHub等第三方Git项目.md index 20be5ce..5a94b2e 100644 --- a/docs/快速开始/导入GitHub等第三方Git项目.md +++ b/docs/快速开始/导入GitHub等第三方Git项目.md @@ -13,11 +13,75 @@ sidebar_position: 5 ## 2. 填写信息 -填写完需要导入的第三方Git项目地址后和项目信息后,点击导入项目 +填写需要导入的第三方Git项目地址和项目信息,如果导入项目为私有仓库,则需输入目标平台用户token进行授权。 ![](/img/quickstart/import_info.png) -## 3. 导入成功 +## 3. 授权验证 + +在使用GitLink平台导入其他平台(如GitHub、Gitee)的开源项目时,如果项目为私有,则无法通过正常途径导入,需要输入对应平台有权限的token值进行校验。 + +![](/img/quickstart/import_verify.png) + +下面将列举一些典型开源平台的token获取方式。 + +### GitHub token获取方式 + +1. 登录GitHub账号 + +2. 访问用户头像下的settings菜单 + + ![img](https://forum.gitlink.org.cn/api/attachments/422328) + +3. 访问最下方的Developer settings + + ![img](https://forum.gitlink.org.cn/api/attachments/422329) + +4. 在跳转页访问Token(classic),新建一个classic token(若已保存token) + + ![img](https://forum.gitlink.org.cn/api/attachments/422362) + +5. 在token配置页面,输入token用途,并确保该token已勾选“repo”选项,否则将导入失败 + + ![img](https://forum.gitlink.org.cn/api/attachments/422364) + + 点击创建按钮 + + ![img](https://forum.gitlink.org.cn/api/attachments/422366) + +6. 复制该token + + ![img](https://forum.gitlink.org.cn/api/attachments/422368) + + 并将该token输入至GitLink导入项目认证填写框 + + ![img](https://forum.gitlink.org.cn/api/attachments/422376) + +### Gitee token获取方式 + +1. 登录Gitee账号 + +2. 访问用户头像下的设置菜单 + + ![img](https://forum.gitlink.org.cn/api/attachments/422333) + +3. 访问“安全设置”栏下方“私人令牌”菜单 + + ![img](https://forum.gitlink.org.cn/api/attachments/422334) + +4. 点击生成新令牌,并在令牌生成页面配置令牌名称,并确保令牌已勾选“project”权限选项,并保存该令牌 + + ![img](https://forum.gitlink.org.cn/api/attachments/422371) + + ![img](https://forum.gitlink.org.cn/api/attachments/422370) + +5. 在令牌生成成功的弹窗,复制该令牌,并将该token输入至GitLink导入项目认证填写框 + + ![img](https://forum.gitlink.org.cn/api/attachments/422374) + + ![img](https://forum.gitlink.org.cn/api/attachments/422375) + +## 4. 导入成功 提示正在从第三方Git项目地址迁移 diff --git a/docs/疑修/标记管理.md b/docs/疑修/标记管理.md index 3217988..062fc3c 100644 --- a/docs/疑修/标记管理.md +++ b/docs/疑修/标记管理.md @@ -18,5 +18,7 @@ GitLink默认疑修共有缺陷、功能、疑问、支持、任务、协助、 - **文档:** 表示文档材料补充; - **测试:** 表示需要测试的需求; - **重复:** 表示已存在类似的疑修。 +![](/img/Issue/imageIssue14.png) -另外,**项目成员**可以根据需求或习惯,进行标记含义或颜色标志的修改、新建标记和删除标记操作。 \ No newline at end of file +另外,**项目成员**可以根据需求或习惯,进行标记含义或颜色标志的修改、新建标记和删除标记操作。 +![](/img/Issue/imageIssue15.png) \ No newline at end of file diff --git a/docs/疑修/疑修创建.md b/docs/疑修/疑修创建.md index 69e3423..0c2d9fe 100644 --- a/docs/疑修/疑修创建.md +++ b/docs/疑修/疑修创建.md @@ -10,4 +10,12 @@ sidebar_position: 2 2. 开始创建疑修,包括疑修标题、内容,输入疑修内容时既可以采用简单灵活的[Markdown语法](https://markdown.com.cn/),同时可以点击上方的功能按钮;然后上传需要的附件内容;最后点击“**创建**”按钮提交你的第一个疑修🎉🎉🎉 -![](/img/Issue/imageIssue3.png) \ No newline at end of file +![](/img/Issue/imageIssue3.png) + +3. 此外,在创建疑修时,可以通过符号 **`#`** 快速添加需要引用的疑修,进而为当前疑修提供辅助的信息;如下图所示,键入 **`#`** 后会弹出可引用的疑修列表,通过鼠标下滑或者键盘输入疑修编号选择需要引用的疑修后,会自动添加引用疑修的链接🔗 + +![](/img/Issue/imageIssue6.png) + +![](/img/Issue/imageIssue7.png) + + diff --git a/docs/疑修/评论及操作记录.md b/docs/疑修/评论及操作记录.md index 36f3054..80548e2 100644 --- a/docs/疑修/评论及操作记录.md +++ b/docs/疑修/评论及操作记录.md @@ -6,6 +6,13 @@ sidebar_position: 5 # 评论及操作记录 ### 评论 每个疑修都相当于一个可以进度追踪的帖子,因此支持评论和回复,不仅仅是项目成员,所有人都可以在某个疑修下进行评论和回复,发表疑问或是见解,进行交流。 +![](/img/Issue/imageIssue11.png) + +### 疑修声明 +用户可以对任意疑修发布“疑修声明”,留言自己对于该疑修的解决思路。点击疑修详情右侧的“声明”后,可以编辑留言,编辑完成后点击“确认”即可发布声明,如下图所示: +![](/img/Issue/imageIssue12.png) + ### 操作记录 所有人都可以创建疑修,但是要注意,非项目成员仅可以修改自己创建的疑修,而项目成员有权限修改所有的疑修。 -对于某个疑修的所有编辑操作,包括**创建疑修、添加负责人、移除负责人、更改状态、更改优先级、添加标记、移除标记、添加里程碑、移除里程碑、设置关联分支、移除关联分支、设置开始日期和设置结束日期**,均被记录在操作记录中。 \ No newline at end of file +对于某个疑修的所有编辑操作,包括**创建疑修、添加负责人、移除负责人、更改状态、更改优先级、添加标记、移除标记、添加里程碑、移除里程碑、设置关联分支、移除关联分支、设置开始日期和设置结束日期**,均被记录在操作记录中。 +![](/img/Issue/imageIssue13.png) \ No newline at end of file diff --git a/docs/疑修/里程碑管理.md b/docs/疑修/里程碑管理.md index 9790e35..68e37c7 100644 --- a/docs/疑修/里程碑管理.md +++ b/docs/疑修/里程碑管理.md @@ -12,13 +12,16 @@ sidebar_position: 7 项目成员可以基于以下步骤创建里程碑: 1. 进入目标项目的 **“里程碑”** 界面,此时界面所示为已创建的里程碑的列表,所有已创建里程碑分为 **“已关闭”** 和 **“开启中”** 两类; 2. 点击上方的 **“+创建里程碑”** 按钮即可进入里程碑创建界面; +![](/img/Issue/imageIssue16.png) + 3. 填写标题(必填)、描述(必填)、截止日期(选填)后,点击右下角的 **“创建里程碑”** 即可以完成一个新的里程碑的创建。 +![](/img/Issue/imageIssue17.png) ### 关联里程碑 项目成员可以将疑修关联到里程碑,从而使里程碑包含明确的疑修列表,主要步骤如下: 1. 在疑修列表中点击目标疑修; 2. 编辑“里程碑”属性,选择需要关联的里程碑。 - +![](/img/Issue/imageIssue18.png) ### 其他操作 - **开启里程碑** @@ -26,4 +29,6 @@ sidebar_position: 7 - **编辑里程碑** - **删除里程碑** -上述操作均可以在里程碑列表中,对目标里程碑进行处理实现。 \ No newline at end of file +上述操作均可以在里程碑列表中,对目标里程碑进行处理实现,如下图所示: +![](/img/Issue/imageIssue19.png) +![](/img/Issue/imageIssue20.png) \ No newline at end of file diff --git a/docs/第三方服务/跨平台代码同步.md b/docs/第三方服务/跨平台代码同步.md deleted file mode 100644 index 3330e5b..0000000 --- a/docs/第三方服务/跨平台代码同步.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -sidebar_label: '跨平台代码同步' -sidebar_position: 2 ---- \ No newline at end of file diff --git a/docs/第三方服务/重睛鸟代码溯源.md b/docs/第三方服务/重睛鸟代码溯源.md index 420351b..5cd1639 100644 --- a/docs/第三方服务/重睛鸟代码溯源.md +++ b/docs/第三方服务/重睛鸟代码溯源.md @@ -1,71 +1,67 @@ --- -sidebar_label: '重睛鸟代码溯源' -sidebar_position: 1 +sidebar_label: "重睛鸟代码溯源" +sidebar_position: 1 --- ## 代码分析入口 -![](/img/di_san_fang/重晴鸟代码溯源/代码分析入口.png) -
代码分析入口
+![](../../static/img/di_san_fang/重晴鸟代码溯源/代码分析入口.png)
-页面说明: -- 1、在"维基"与"动态"之间加入"服务"菜单,并设计前置icon。 -- 2、用户可点击"服务"菜单 tab 进入服务页面。 -- 3、仓库管理员可在"仓库设置" tab 中项目导航处开启/关闭代码分析菜单可见性,如下图: +
代码分析入口

+页面说明:
+1、用户可点击"服务"菜单 tab 进入服务页面。
+2、仓库管理员可在"仓库设置" tab 中项目导航处开启/关闭代码分析菜单可见性,如下图:
-![](/img/di_san_fang/重晴鸟代码溯源/项目导航.png) -
项目导航
+![](../../static/img/di_san_fang/重晴鸟代码溯源/项目导航.png)
+ +
项目导航

## 代码分析检测 -![](/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png) -
代码分析检测
-页面说明: -- 1、此页面为暂无历史分析记录时页面展示。 -- 2、"新建分析"按钮仅对仓库管理员可见。仓库开发者、观察者、游客访问此页面时,"新建分析"按钮不可见。 -- 3、点击"新建分析"按钮,需判断该仓库是否已签订协议(是否开启代码分析功能)。 +![](../../static/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png)
-## 代码分析协议签订 -![](/img/di_san_fang/重晴鸟代码溯源/代码分析协议签订.png) -
代码分析协议签订
+
代码分析检测

-页面说明: -- 1、用户点击"新建分析"按钮,需判断该仓库是否已签订协议(是否开启代码分析功能),若未签订协议,则弹出签订协议弹窗。 -- 2、签订协议流程: -①用户将垂直滚动条拉至最底部。 -②勾选阅读并同意协议条款。 -③点击同意协议(若未勾选"我已阅读并同意《用户协议及声明条款》",则"同意协议"按钮置灰)。 -- 3、用户勾选 CheckBox ,并点击"同意协议"按钮,逻辑上等同于代码溯源系统中新建一个账户。在页面交互上,相当于点击"新建分析"按钮弹出分支选择弹窗。 +![](../../static/img/di_san_fang/重晴鸟代码溯源/新建分析.png)
+ +
新建分析

+页面说明:
+1、此页面为暂无历史分析记录时页面展示。
+2、"新建分析"按钮仅对仓库管理员可见。仓库开发者、观察者、游客访问此页面时,"新建分析"按钮不可见。
+3、点击"新建分析"按钮,需判断是否开启代码分析功能。
## 分支选择 -![](/img/di_san_fang/重晴鸟代码溯源/分支选择.png) -
分支选择
-页面说明: -- 1、用户点击“新建分析”按钮,弹出新建分析需要选择填写分支。 -- 2、图中检测类型、检测参数均为默认值,不允许用户修改,此处展示在界面上,仅起到提示用户,让用户知晓作用。 -- 3、点击此处“开始检测”即开启基于选中分支的检测,新建一个检测列表。 +![](../../static/img/di_san_fang/重晴鸟代码溯源/分支选择.png)
+ +
分支选择

+页面说明:
+1、用户点击“新建分析”按钮,弹出新建分析需要选择填写分支。
+2、图中检测类型、检测参数均为默认值,不允许用户修改,此处展示在界面上,仅起到提示用户,让用户知晓作用。
+3、点击此处“开始检测”即开启基于选中分支的检测,新建一个检测列表。
## 列表展示 -![](/img/di_san_fang/重晴鸟代码溯源/列表展示.png) -
列表展示
-页面说明: -- 1、当检测列表行数超过一行时,“新建分析”按钮左侧提供分支名称的筛选下拉框,下拉框内选项为列表中分支的集合。若本仓库有分支1、2、3、4、5,此列表中有分支3、4,则此处下拉框中分支类型仅为3、4。 -- 2、当新建分析任务正在检测中时,检测状态处有百分比进度条展示现有进度。 -- 3、点击“重新扫描”按钮,将弹出一条新建分析的弹窗,此弹窗保存所有上次已配置的分支信息,检测分支不可修改(分支下拉选中框置灰)。确认新建后,将新增一条检测数据。 -- 4、点击删除将出现二次确认弹框:“此操作将永久删除该检测记录,是否继续?”,用户点击确认后,此条检测记录将从列表中移除。 +![](../../static/img/di_san_fang/重晴鸟代码溯源/列表展示.png)
+ +
列表展示

+页面说明:
+1、当检测列表行数超过一行时,“新建分析”按钮左侧提供分支名称的筛选下拉框,下拉框内选项为列表中分支的集合。若本仓库有分支1、2、3、4、5,此列表中有分支3、4,则此处下拉框中分支类型仅为3、4。
+2、当新建分析任务正在检测中时,检测状态处有百分比进度条展示现有进度。
+3、点击“重新扫描”按钮,将弹出一条新建分析的弹窗,此弹窗保存所有上次已配置的分支信息,检测分支不可修改(分支下拉选中框置灰)。确认新建后,将新增一条检测数据。
## 结果展示 -![](/img/di_san_fang/重晴鸟代码溯源/结果展示.png) -
结果展示
-页面说明: -- 1、用户在代码检测"操作"列表点击"查看"按钮,将在当前页面展开结果展示页面。当用户再次点击"查看"按钮后,结果展示页面收回;当用户点击其他检测记录"查看"按钮后,将展开其他检测记录的结果页,收回当前已展开的结果展示页; -- 2、当检测状态为"失败"状态,或当前处于"正在检测"状态时,"查看"按钮将置灰,处于无法点击状态; -- 3、结果展示页取代码溯源已有页面,嵌入至 GitLink 即可,无需再次设计。 + +![](../../static/img/di_san_fang/重晴鸟代码溯源/结果展示.png)
+ +
结果展示

+页面说明:
+1、用户在代码检测"操作"列表点击"查看"按钮,将在当前页面展开结果展示页面。当用户再次点击"查看"按钮后,结果展示页面收回;当用户点击其他检测记录"查看"按钮后,将展开其他检测记录的结果页,收回当前已展开的结果展示页;
+2、当检测状态为"失败"状态,或当前处于"正在检测"状态时,"查看"按钮将置灰,处于无法点击状态;
+3、结果展示页取代码溯源已有页面,嵌入至 GitLink 即可,无需再次设计。
## 用户操作流程 -![](/img/di_san_fang/重晴鸟代码溯源/用户操作流程.png) -
用户操作流程
+![](../../static/img/di_san_fang/重晴鸟代码溯源/用户操作流程.png)
+
用户操作流程

diff --git a/static/img/Issue/imageIssue11.png b/static/img/Issue/imageIssue11.png new file mode 100644 index 0000000..f2332a4 Binary files /dev/null and b/static/img/Issue/imageIssue11.png differ diff --git a/static/img/Issue/imageIssue12.png b/static/img/Issue/imageIssue12.png new file mode 100644 index 0000000..7a7bde3 Binary files /dev/null and b/static/img/Issue/imageIssue12.png differ diff --git a/static/img/Issue/imageIssue13.png b/static/img/Issue/imageIssue13.png new file mode 100644 index 0000000..5cc6013 Binary files /dev/null and b/static/img/Issue/imageIssue13.png differ diff --git a/static/img/Issue/imageIssue14.png b/static/img/Issue/imageIssue14.png new file mode 100644 index 0000000..8f9510f Binary files /dev/null and b/static/img/Issue/imageIssue14.png differ diff --git a/static/img/Issue/imageIssue15.png b/static/img/Issue/imageIssue15.png new file mode 100644 index 0000000..d8fc494 Binary files /dev/null and b/static/img/Issue/imageIssue15.png differ diff --git a/static/img/Issue/imageIssue16.png b/static/img/Issue/imageIssue16.png new file mode 100644 index 0000000..f1bcccf Binary files /dev/null and b/static/img/Issue/imageIssue16.png differ diff --git a/static/img/Issue/imageIssue17.png b/static/img/Issue/imageIssue17.png new file mode 100644 index 0000000..0aea317 Binary files /dev/null and b/static/img/Issue/imageIssue17.png differ diff --git a/static/img/Issue/imageIssue18.png b/static/img/Issue/imageIssue18.png new file mode 100644 index 0000000..5fa9e12 Binary files /dev/null and b/static/img/Issue/imageIssue18.png differ diff --git a/static/img/Issue/imageIssue19.png b/static/img/Issue/imageIssue19.png new file mode 100644 index 0000000..5255e5e Binary files /dev/null and b/static/img/Issue/imageIssue19.png differ diff --git a/static/img/Issue/imageIssue20.png b/static/img/Issue/imageIssue20.png new file mode 100644 index 0000000..9afd959 Binary files /dev/null and b/static/img/Issue/imageIssue20.png differ diff --git a/static/img/Issue/imageIssue6.png b/static/img/Issue/imageIssue6.png new file mode 100644 index 0000000..aaf357e Binary files /dev/null and b/static/img/Issue/imageIssue6.png differ diff --git a/static/img/Issue/imageIssue7.png b/static/img/Issue/imageIssue7.png new file mode 100644 index 0000000..12c0b55 Binary files /dev/null and b/static/img/Issue/imageIssue7.png differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/代码分析协议签订.png b/static/img/di_san_fang/重晴鸟代码溯源/代码分析协议签订.png deleted file mode 100644 index 09c3459..0000000 Binary files a/static/img/di_san_fang/重晴鸟代码溯源/代码分析协议签订.png and /dev/null differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png b/static/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png index b312af9..5dfe100 100644 Binary files a/static/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png and b/static/img/di_san_fang/重晴鸟代码溯源/代码分析检测.png differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/分支选择.png b/static/img/di_san_fang/重晴鸟代码溯源/分支选择.png index 59ae393..63e8740 100644 Binary files a/static/img/di_san_fang/重晴鸟代码溯源/分支选择.png and b/static/img/di_san_fang/重晴鸟代码溯源/分支选择.png differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/列表展示.png b/static/img/di_san_fang/重晴鸟代码溯源/列表展示.png index c6d83d7..8471d7d 100644 Binary files a/static/img/di_san_fang/重晴鸟代码溯源/列表展示.png and b/static/img/di_san_fang/重晴鸟代码溯源/列表展示.png differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/新建分析.png b/static/img/di_san_fang/重晴鸟代码溯源/新建分析.png new file mode 100644 index 0000000..1804720 Binary files /dev/null and b/static/img/di_san_fang/重晴鸟代码溯源/新建分析.png differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/用户操作流程.png b/static/img/di_san_fang/重晴鸟代码溯源/用户操作流程.png index 406a255..7182eb5 100644 Binary files a/static/img/di_san_fang/重晴鸟代码溯源/用户操作流程.png and b/static/img/di_san_fang/重晴鸟代码溯源/用户操作流程.png differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/结果展示.png b/static/img/di_san_fang/重晴鸟代码溯源/结果展示.png index 45246da..2d81afd 100644 Binary files a/static/img/di_san_fang/重晴鸟代码溯源/结果展示.png and b/static/img/di_san_fang/重晴鸟代码溯源/结果展示.png differ diff --git a/static/img/di_san_fang/重晴鸟代码溯源/项目导航.png b/static/img/di_san_fang/重晴鸟代码溯源/项目导航.png index c8264ea..e2dd910 100644 Binary files a/static/img/di_san_fang/重晴鸟代码溯源/项目导航.png and b/static/img/di_san_fang/重晴鸟代码溯源/项目导航.png differ diff --git a/static/img/quickstart/import_info.png b/static/img/quickstart/import_info.png index dcbdf6a..910da5a 100644 Binary files a/static/img/quickstart/import_info.png and b/static/img/quickstart/import_info.png differ diff --git a/static/img/quickstart/import_verify.png b/static/img/quickstart/import_verify.png new file mode 100644 index 0000000..47c59b7 Binary files /dev/null and b/static/img/quickstart/import_verify.png differ