更新开源项目手册
Context testing / job3 (push) Successful in 1s Details
Context testing / dump_contexts_to_log (push) Successful in 2s Details

This commit is contained in:
unknown 2025-02-12 16:28:41 +08:00
parent 8d3f7a919a
commit ad1e9fd307
14 changed files with 70 additions and 31 deletions

101
git.md
View File

@ -18,56 +18,61 @@
### 1.2 项目创建
项目包括创建1、导入外站项目2、创建项目3、创建组织
项目创建包括1、导入外站项目2、创建项目。
1、导入外站项目 点击右上角“⊕”,选择“导入项目”,如下图所示: ![创建镜像项目](./static/img/00.png)
1、导入外站项目 点击右上角“⊕”,选择“导入项目”,如下图所示: ![创建镜像项目](./static/img/111.png)
填写项目基本信息,包括项目拥有者、镜像版本库地址、项目名称、项目简介等信息,并点击“创建项目”如下图所示:
![创建项目](./static/img/11.png)
2、创建托管项目 点击右上角“⊕”,选择“创建托管项目”,如下图所示: <img src="./static/img/3239.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 填写项目基本信息,包括项目拥有者、项目名称、项目简介等信息,并点击“创建项目”如下图所示: <img src="./static/img/22.png" alt="img" style="zoom:50%;display: block; margin: 0 auto;" />
2、创建托管项目 点击右上角“⊕”,选择“新建项目”,如下图所示:
3、创建组织 点击右上角“⊕”,选择“创建组织”,如下图所示: <img src="./static/img/3241.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 填写组织基本信息,包括组织名称、组织描述等,选择可见性,并上传头像后,点击“创建组织”如下图所示: <img src="./static/img/3242.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
![创建托管项目](./static/img/13.png)
### 1.3 项目配置
填写项目基本信息,包括项目拥有者、项目名称、项目简介等信息,并点击“创建项目”如下图所示: <img src="./static/img/22.png" alt="img" style="zoom:50%;display: block; margin: 0 auto;" />
项目的管理员可以对项目进行多种配置。 可配置的内容主要包括:
### 1.3 代码库
1. 项目基本信息:包括项目名称和简介,还包括项目是否公开、是否隐藏项目代码库以及删除项目
2. 成员管理:为项目添加各种角色的成员,点击“成员”标签页
3. 关联组织:将项目关联到相应的组织,点击“组织”标签页
4. 创建里程碑:为项目创建阶段性的产品版本,点击“里程碑”标签页
5. 创建版本库为项目创建版本库Git点击“版本库”标签页
代码库为开源项目的核心功能页面,通常作为项目的首页(默认页面)。
### 1.4 成员管理
用户可以在此页面进行项目代码及项目基本信息的浏览、查看项目不同分支、标签内容。以及创建PR、提交Issue、上传文件、获取项目下载地址等操作。
![代码库](./static/img/code-repo.png)
项目管理员可以在项目配置中管理项目的成员。
### 1.4 疑修Issue
1、点击“仓库设置”进入标签页选择左侧菜单栏的“协作者管理”将看到如下页面 <img src="./static/img/3243.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 2、在下图所示的搜索框内输入欲添加成员的用户名如下图所示 <img src="./static/img/3244.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 3、在搜索结果中选择想要添加的成员点击“添加成员”如下图所示 <img src="./static/img/3245.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 4、成员添加成功后可为其选择角色包括管理员、开发者、报告者三种如下图所示 <img src="./static/img/3246.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 注意:项目成员的不同角色具有不同权限。 管理员:可以对项目中的所有模块进行操作。 开发者:不能对项目进行配置。 报告者:不能对版本库进行操作。
#### 1.4.1 Issue简介
Issue主要用于团队成员或相关人员对项目中出现的问题、任务或需求等进行记录和跟踪。
### 1.5 删除项目
Issue 具有不同的状态,如 “新建”“进行中”“已解决”“已关闭” 等。通过这些状态,团队成员和管理者可以直观地了解问题或任务的当前进展情况,便于及时发现问题、调整计划。
![issue简介](./static/img/issue2.png)
管理员可以删除项目。步骤如下: 点击“仓库设置”,进入标签页,选择左侧菜单栏的“基本设置”,点击下方的“删除本仓库”,即可删除当前项目。 <img src="./static/img/3247.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
#### 1.4.2 Issue创建
1. 点击“疑修(Issue)”,进入标签页,点击页面右侧的`创建疑修`。 ![issue简介](./static/img/issue-new.png)
### 1.6 发布问题
2. 进入创建疑修页面后用户需要根据项目实际情况填写Issue标题及内容选择指派成员、状态、类型、优先度等。填写完毕后点击`创建`按钮即可完成Issue的创建。
![issue创建](./static/img/issue-create.png)
1、点击“易修(Issue)”,进入标签页,点击页面右侧的“创建任务”。 <img src="./static/img/3260.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
3. 出现如下图所示信息时,表明问题发布成功。
![issue创建成功](./static/img/issue-success.png)
2、填写任务标题及内容选择指派成员、状态、类型、优先度等点击“创建”。 <img src="./static/img/3251.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> <img src="./static/img/3252.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> <img src="./static/img/3253.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> <img src="./static/img/3254.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> <img src="./static/img/3255.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
#### 1.4.3 Issue互动
> 注意: 每个问题都相当于一个可以进度追踪的帖子。因此支持回复、点赞、@等。 在问题截止日期的前一天,系统将对问题的发布人和被指派人发送提示消息。
>
点击已发布的问题,进入问题详情页面,点击下图所示的评论区输入栏。
![issue评论](./static/img/issue-discuss.png)
3、出现如下图所示信息时表明问题发布成功。 <img src="./static/img/3256.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
点开输入栏后出现下图所示输入界面,输入想要评论的内容后,点击“评论”。
![issue评论](./static/img/issue-discuss2.png)
4、点击已发布的问题进入问题详情页面点击下图所示的评论区输入栏。 <img src="./static/img/3257.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
出现如下图所示信息时,表明评论成功。
![issue评论成功](./static/img/issue-discuss3.png)
5、点开输入栏后出现下图所示输入界面输入想要评论的内容后点击“评论”。 <img src="./static/img/3258.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
### 1.5 合并请求PR
6、出现如下图所示信息时表明评论成功。 <img src="./static/img/3259.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
注意: 每个问题都相当于一个可以进度追踪的帖子。因此支持回复、点赞、@等。 在问题截止日期的前一天,系统将对问题的发布人和被指派人发送提示消息。
### 1.7 新建里程碑
### 1.6 里程碑
#### 1.6.1 新建里程碑
管理员可以新建里程碑。步骤如下:
@ -79,11 +84,11 @@
注意:项目成员在发布问题时。将在“目标版本”属性中看到新建的版本。
### 1.8 关联里程碑
#### 1.6.2 关联里程碑
项目成员可以将项目问题关联到里程碑,从而使里程碑包含明确的任务列表。 步骤如下: 1、进入某个问题的页面编辑“里程碑”属性从“里程碑”下拉框中选择适当的里程碑点击“提交”。 <img src="./static/img/3264.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />2、出现如下图所示信息时表明里程碑关联成功。 <img src="./static/img/3265.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
### 1.9 维基Wiki
### 1.7 维基Wiki
Wiki 是一种协作式的知识管理系统,通常用于存储和共享项目相关的设计、文档和注释,允许多个用户共同创建、编辑、更新和分享内容,用户无需特殊技能即可编辑页面通常使用所见即所得各个页面之间通过超链接相互连接形成网络状的知识结构。进入项目详情选择维基Wiki菜单可选择创建新的文档或导入已有的模板。 <img src="./static/img/image15.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
@ -113,9 +118,19 @@ Wiki 是一种协作式的知识管理系统,通常用于存储和共享项目
<img src="./static/img/image24.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
### 1.10 Reposyncer仓库同步New🆕
### 1.8 Reposyncer仓库同步New🆕
支持不同开源托管平台自动同步推送/拉取相关代码实现多平台项目同步开发功能跨平台仓库代码同步服务用于不同代码托管平台之间的仓库代码双向同步。用户将不同平台的仓库分支进行绑定当任意仓库分支有push事件被webhook监听时代码推送将实时自动同步至另一个仓库以实现不同平台之间分支、提交信息的自动同步。进入需要同步代码的项目内选择服务输入平台信息 <img src="./static/img/image1.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
#### 1.8.1 功能简介
红山开源平台支持不同开源托管平台自动同步推送/拉取相关代码,实现多平台项目同步开发功能。
跨平台仓库代码同步服务用于不同代码托管平台之间的仓库代码双向同步。用户将不同平台的仓库分支进行绑定当任意仓库分支有push事件被webhook监听时代码推送将实时自动同步至另一个仓库以实现不同平台之间分支、提交信息的自动同步。
![仓库同步](./static/img/rs-1.png)
#### 1.8.2 仓库同步配置
> 如果项目列表未出现`服务`按钮,请先移步至`仓库设置`=>`项目导航`=> `勾选开启服务`后重新刷新进入该仓库
进入需要同步代码的项目内,选择服务,输入平台信息: <img src="./static/img/image1.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
<img src="./static/img/image2.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
点击开始体验选择开源托管平台后根据提示输入相关信息以Github为例
<img src="./static/img/image3.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
@ -145,6 +160,30 @@ Wiki 是一种协作式的知识管理系统,通常用于存储和共享项目
<img src="./static/img/image14.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
### 1.9 项目配置
项目的管理员可以对项目进行多种配置。 可配置的内容主要包括:
1. 项目基本设置:包括项目名称、简介、可见性、标识、类别、语言等基本项目信息,以及转移仓库及删除仓库等操作。
2. 成员管理:为项目添加各种角色的成员,点击“成员”标签页。
3. 网络钩子WebHook支持设置自定义的WebHook来实现自动化推送等操作。
4. 分支设置:为项目设置`默认分支`及`分支保护`。
5. Bot管理用于管理新增、删除当前项目所配置的Bot。
#### 1.9.1 成员管理
项目管理员可以在项目配置中管理项目的成员。
1、点击“仓库设置”进入标签页选择左侧菜单栏的“协作者管理”将看到如下页面 <img src="./static/img/3243.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 2、在下图所示的搜索框内输入欲添加成员的用户名如下图所示 <img src="./static/img/3244.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 3、在搜索结果中选择想要添加的成员点击“添加成员”如下图所示 <img src="./static/img/3245.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 4、成员添加成功后可为其选择角色包括管理员、开发者、报告者三种如下图所示 <img src="./static/img/3246.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" /> 注意:项目成员的不同角色具有不同权限。 管理员:可以对项目中的所有模块进行操作。 开发者:不能对项目进行配置。 报告者:不能对版本库进行操作。
#### 1.9.2 删除项目
管理员可以删除项目。步骤如下: 点击“仓库设置”,进入标签页,选择左侧菜单栏的“基本设置”,点击下方的“删除本仓库”,即可删除当前项目。 <img src="./static/img/3247.png" alt="img" style="zoom:80%;display: block; margin: 0 auto;" />
## 2. 开源项目:组织管理
为了满足团队开发、协作、宣传和管理需要,红山开源提供了组织功能。

BIN
static/img/111.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 630 KiB

BIN
static/img/12.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 890 KiB

BIN
static/img/13.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 859 KiB

BIN
static/img/code-repo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 KiB

BIN
static/img/issue-create.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 150 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

BIN
static/img/issue-new.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 155 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

BIN
static/img/issue.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 143 KiB

BIN
static/img/issue2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

BIN
static/img/rs-1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 194 KiB