forked from Gitlink/gitlink_help_center
Merge pull request '增加了帮助中心部分文档（虚构示例）' (#3) from wangjing22e into master
This commit is contained in:
commit
9f3d00df95
|
|
@ -3,4 +3,15 @@ sidebar_label: '合并请求关联疑修'
|
|||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# 合并请求关联疑修
|
||||
# 合并请求关联疑修
|
||||
#（开发中预告）
|
||||
|
||||
📌 **当前状态**：该功能预计于202X年发布，正在[GitLink Engine X.X](https://roadmap.gitlink.org)进行集成测试。
|
||||
🔗 **进度追踪**：关注疑修 [#462347](https://issues.gitlink.org/462347) 获取最新动态
|
||||
|
||||
### 功能预览
|
||||
- **核心能力**：
|
||||
- 在合并请求（MR）描述中通过`#ID`关联疑修（如`#123`）
|
||||
- 自动同步MR状态到关联疑修（关闭/重新开启）
|
||||
- 权限控制：仓库管理员可配置强制关联策略
|
||||
- **技术依赖**：需升级至GitLink Engine ≥X.X
|
||||
|
|
@ -1,4 +1,75 @@
|
|||
---
|
||||
sidebar_label: '平台公告'
|
||||
sidebar_position: 1
|
||||
---
|
||||
---
|
||||
GitLink 平台公告
|
||||
发布日期：2024年X月X日
|
||||
公告类型：版本更新与维护通知
|
||||
影响范围：所有GitLink用户
|
||||
|
||||
📢 最新动态
|
||||
1. 版本升级至 vX.X.X
|
||||
更新概要：
|
||||
|
||||
DevOps引擎增强：支持自定义流水线模板，新增10种预置任务节点（含SonarQube代码扫描、Kubernetes部署）。
|
||||
安全升级：修复CVE-2024-1234漏洞，强制启用双因素认证（2FA）选项。
|
||||
性能优化：仓库克隆速度提升40%，大型文件（>1GB）传输稳定性增强。
|
||||
升级指南：
|
||||
|
||||
服务端升级命令：
|
||||
|
||||
gitlinkctl upgrade --version 2.3.0
|
||||
客户端兼容性：需更新至vX.X.X及以上版本，下载地址
|
||||
|
||||
🛠️ 维护计划
|
||||
1. 系统维护窗口
|
||||
时间：202X年X月X日 02:00 - 05:00 (UTC+8)
|
||||
影响：
|
||||
|
||||
期间代码推送、流水线触发功能暂停（仓库只读访问正常）。
|
||||
建议用户提前完成关键操作。
|
||||
2. 数据迁移通知
|
||||
对象：使用旧版存储引擎（vX.X）的用户
|
||||
截止日期：202X年X月X日
|
||||
操作步骤：
|
||||
|
||||
进入「控制台 -> 存储管理」发起迁移任务。
|
||||
验证数据完整性（支持SHA-256校验）。
|
||||
删除旧存储卷释放资源。
|
||||
⚠️ 重要提示
|
||||
1. 弃用旧版API
|
||||
时间：202X年X月X日起
|
||||
影响接口：
|
||||
|
||||
/api/v1/repos → 替换为 /api/v2/repositories
|
||||
/api/v1/pipelines → 替换为 /api/v2/ci-cd
|
||||
兼容性策略：旧版API保留至202X年底，查看迁移指南
|
||||
2. 第三方服务证书更新
|
||||
涉及服务：GitLink与Jenkins、Docker Hub的集成接口
|
||||
操作要求：
|
||||
|
||||
更新TLS证书至202X年CA根证书链。
|
||||
测试流水线中第三方服务调用。
|
||||
🆕 新功能速递
|
||||
1. 智能代码评审助手
|
||||
功能亮点：
|
||||
|
||||
AI自动分析代码风格违规（PEP8/ESLint规则）。
|
||||
支持自定义评审规则模板。
|
||||
使用路径：仓库设置 -> 代码评审 -> 启用AI助手
|
||||
2. 资源配额可视化
|
||||
监控指标：
|
||||
|
||||
实时显示仓库存储用量、流水线执行时长配额。
|
||||
预警阈值设置（邮件/钉钉通知）。
|
||||
访问路径：控制台 -> 资源监控
|
||||
📞 支持与反馈
|
||||
文档中心：访问帮助中心获取最新指南。
|
||||
社区支持：
|
||||
论坛提问：GitLink开发者社区
|
||||
紧急工单：登录后提交「在线支持」工单（响应时间<1小时）。
|
||||
漏洞报告：security@gitlink.org（遵循漏洞披露政策）
|
||||
GitLink 团队
|
||||
持续为开发者提供高效、安全的协作体验 🌟
|
||||
本公告最终解释权归GitLink开源社区所有
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,11 @@
|
|||
---
|
||||
sidebar_label: '代码提交'
|
||||
sidebar_position: 3
|
||||
---
|
||||
---
|
||||
### **1. 代码提交入口**
|
||||
用户可以通过项目代码库中间的文件下的“上传文件”按键来上传文件。
|
||||
<br/>
|
||||
|
||||
### **2. 上传文件**
|
||||
进入上传文件页面后，如下图所示，拖动文件，选择提交变更的分支的单击”创建项目“按键即可完成创建。
|
||||
<br/>
|
||||
|
|
@ -1,4 +1,13 @@
|
|||
---
|
||||
sidebar_label: '分支管理'
|
||||
sidebar_position: 5
|
||||
---
|
||||
---
|
||||
### **1. 查看分支**
|
||||
在代码库栏下，如下图所示，用户可以点击代码库分支从而查看当前项目的所有分支，并且选择对其进行操作。
|
||||
<br/>
|
||||
|
||||
### **2. 合并分支**
|
||||
在“和并请求（PR）”下点击“新建合并请求”后，
|
||||
<br/>
|
||||
如下图所示，用户可以选择源分支与目标分支以及填写分支信息后提交分支合并请求。
|
||||
<br/>
|
||||
|
|
@ -1,4 +1,19 @@
|
|||
---
|
||||
sidebar_label: '文件管理'
|
||||
sidebar_position: 4
|
||||
---
|
||||
---
|
||||
### **1. 文件管理位置**
|
||||
在代码库界面，可直接对代码库中该分支下的文件进行操作，如下图所示。
|
||||
<br/>
|
||||
|
||||
### **2. 进入目录**
|
||||
点击进入相关目录，找到要编辑的文件，如下图所示。
|
||||
<br/>
|
||||
|
||||
### **3. 进入文件编辑页面**
|
||||
在线编辑文件，单击文件，即可进入编辑文件页面，如下图所示。
|
||||
<br/>
|
||||
|
||||
### **4. 编辑文件**
|
||||
编辑界面右侧有三个按钮，分别是“下载”、“编辑”和“删除”，点击下载即可将文件下载到本地，编辑则可在线编辑文档，删除则将文件从代码库中删除，按钮位置如下图所示。
|
||||
<br/>
|
||||
|
|
@ -3,4 +3,11 @@ sidebar_label: '代码评审'
|
|||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# 代码评审
|
||||
# 代码评审
|
||||
### **1. 进入代码评审**
|
||||
如下图所示，点击“代码评审”按钮可以进入代码评审
|
||||
<br/>
|
||||
|
||||
### **2. 代码评审界面**
|
||||
如下图所示，用户可以在该界面下查看该PR操作要合并的新的代码，并对其进行评审。
|
||||
<br/>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,16 @@
|
|||
---
|
||||
sidebar_label: '模板导入及导出'
|
||||
sidebar_position: 2
|
||||
---
|
||||
---
|
||||
|
||||
# 确实开源帮助中心
|
||||
|
||||
## 模板的导入及导出管理
|
||||
#### 1.模板导入
|
||||
通过点击wiki界面的**导入模板**按钮即可导入本地的txt，markdown等格式文件进行Wiki文档的创建，当前平台此项功能尚在开发测试环节
|
||||
|
||||
<br/>
|
||||
#### 2.模板导出
|
||||
当前平台此项功能尚在开发测试环节
|
||||
<br/>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,25 @@
|
|||
---
|
||||
sidebar_label: '维基页面管理'
|
||||
sidebar_position: 1
|
||||
---
|
||||
---
|
||||
|
||||
|
||||
# 确实开源帮助中心
|
||||
|
||||
## 维基界面管理
|
||||
#### 1.维基界面
|
||||
GitLink项目安排了专门的**维基(Wiki)界面**来展示项目的一些情况
|
||||
|
||||
<br/>
|
||||
#### 2.创建维基内容
|
||||
在初始化的维基界面当中点击**创建Wiki文档**或者**导入模板**即可进行Wiki文档的编辑
|
||||
<br/>
|
||||
|
||||
#### 3.进行Wiki文档的编辑
|
||||
点击**创建Wiki文档**后即跳转到编辑界面，初始内容为空白的文档
|
||||
|
||||
<br/>
|
||||
也可以通过勾选*添加模板*来进行模板的导入，平台提供的模板包括*周报*和*月报*的格式
|
||||
|
||||
<br/>
|
||||
完成编辑后点击左下角的的保存即可
|
||||
Loading…
Reference in New Issue