From a134f85b10aeb21f050c608b4cc1682400204de5 Mon Sep 17 00:00:00 2001 From: pfqgauxfb <3521106529@qq.com> Date: Mon, 2 Jun 2025 22:24:04 +0800 Subject: [PATCH] feng --- docs/合并请求/合并请求关联疑修.md | 54 ++++++++++++++++++- docs/平台公告/平台公告.md | 50 ++++++++++++++++- docusaurus.config.js | 17 ++++-- src/components/Comments/index.js | 39 ++++++++++++++ src/components/Comments/styles.module.css | 1 + src/components/Rating/index.js | 1 + src/components/Rating/styles.module.css | 1 + src/theme/DocItem/index.js | 37 +++++++++++++ src/theme/DocItem/styles.module.css | 1 + 9 files changed, 194 insertions(+), 7 deletions(-) create mode 100644 src/components/Comments/index.js create mode 100644 src/components/Comments/styles.module.css create mode 100644 src/components/Rating/index.js create mode 100644 src/components/Rating/styles.module.css create mode 100644 src/theme/DocItem/index.js create mode 100644 src/theme/DocItem/styles.module.css diff --git a/docs/合并请求/合并请求关联疑修.md b/docs/合并请求/合并请求关联疑修.md index ac29313..5aa679d 100644 --- a/docs/合并请求/合并请求关联疑修.md +++ b/docs/合并请求/合并请求关联疑修.md @@ -3,4 +3,56 @@ sidebar_label: '合并请求关联疑修' sidebar_position: 5 --- -# 合并请求关联疑修 \ No newline at end of file +# 合并请求关联疑修 + +合并请求（Merge Request）与疑修（Issue）的关联是 GitLink 平台的重要功能，它可以帮助团队更好地追踪代码变更与问题解决的关系。 + +## 关联方式 + +1. **创建合并请求时关联** + - 在创建合并请求时，可以在描述中使用 `#` 符号引用疑修编号 + - 例如：`修复 #123 中提到的登录问题` + +2. **在合并请求描述中关联** + - 使用 `Fixes #123` 或 `Closes #123` 等关键词 + - 当合并请求被合并时，关联的疑修将自动关闭 + +3. **手动关联** + - 在合并请求页面点击"关联疑修"按钮 + - 在弹出的搜索框中输入疑修编号或标题进行搜索 + - 选择需要关联的疑修 + +## 关联效果 + +1. **自动追踪** + - 在疑修页面可以看到所有相关的合并请求 + - 在合并请求页面可以看到所有关联的疑修 + +2. **状态联动** + - 当合并请求被合并时，关联的疑修可以自动关闭 + - 当疑修被关闭时，相关的合并请求状态会更新 + +3. **通知提醒** + - 当合并请求状态变更时，相关疑修的参与者会收到通知 + - 当疑修状态变更时，相关合并请求的参与者会收到通知 + +## 最佳实践 + +1. **及时关联** + - 在创建合并请求时就建立关联 + - 确保每个合并请求都有明确的问题追踪 + +2. **清晰描述** + - 在合并请求描述中说明解决了哪些问题 + - 使用标准的关联语法，便于系统识别 + +3. **定期检查** + - 定期检查未关联的合并请求 + - 确保所有代码变更都有对应的问题追踪 + +## 注意事项 + +1. 一个合并请求可以关联多个疑修 +2. 一个疑修可以被多个合并请求关联 +3. 关联关系可以随时添加或解除 +4. 建议在合并请求描述中详细说明修改内容 \ No newline at end of file diff --git a/docs/平台公告/平台公告.md b/docs/平台公告/平台公告.md index 3b451a8..fc8bf6c 100644 --- a/docs/平台公告/平台公告.md +++ b/docs/平台公告/平台公告.md @@ -1,4 +1,52 @@ --- sidebar_label: '平台公告' sidebar_position: 1 ---- \ No newline at end of file +--- + +# 平台公告 + +平台公告是 GitLink 平台向用户传达重要信息、更新和变更的主要渠道。通过平台公告，用户可以及时了解平台的最新动态、功能更新、维护通知等重要信息。 + +## 公告类型 + +1. **功能更新公告** + - 新功能发布 + - 功能优化改进 + - 界面更新 + +2. **系统维护公告** + - 定期维护通知 + - 紧急维护通知 + - 维护完成通知 + +3. **安全更新公告** + - 安全漏洞修复 + - 安全策略更新 + - 安全建议 + +4. **活动通知** + - 平台活动 + - 社区活动 + - 培训活动 + +## 查看公告 + +1. 在平台首页的公告栏中查看最新公告 +2. 在个人中心的消息通知中查看历史公告 +3. 关注平台官方社交媒体账号获取公告推送 + +## 公告订阅 + +用户可以通过以下方式订阅平台公告： + +1. 在个人设置中开启邮件通知 +2. 关注平台官方微信公众号 +3. 加入平台用户交流群 + +## 公告反馈 + +如果您对平台公告有任何疑问或建议，可以通过以下方式反馈： + +1. 在公告评论区留言 +2. 发送邮件至 support@gitlink.org +3. 联系在线客服 \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index a809001..85a0e51 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -22,6 +22,18 @@ module.exports = { hideable:true, }, }, + giscus: { + repo: 'luffyZh/gitlink_help_center', // 您的 GitHub 仓库 + repoId: 'R_kgDOJQYwXg', // 仓库 ID + category: 'Comments', // 讨论分类 + categoryId: 'DIC_kwDOJQYwXs4CQYwX', // 分类 ID + mapping: 'pathname', // 使用路径作为标识 + reactionsEnabled: '1', // 启用表情反应 + emitMetadata: '0', + inputPosition: 'bottom', + lang: 'zh-CN', + loading: 'lazy', + }, metadata:[ {name:"Keywords",content:"Gitlink,forgeplus,GitLink,gitLink,GitLink,gitlink,帮助中心"}, {name:"hostname",content:"gitlink.org.cn"}, @@ -70,11 +82,6 @@ module.exports = { position: 'left', dropdownActiveClassDisabled: true }, - // { - // href: 'https://github.com/boxyhq', - // position: 'right', - // className: 'header-github-link', - // }, ], }, footer: { diff --git a/src/components/Comments/index.js b/src/components/Comments/index.js new file mode 100644 index 0000000..62cba95 --- /dev/null +++ b/src/components/Comments/index.js @@ -0,0 +1,39 @@ +import React from 'react'; +import Giscus from '@giscus/react'; +import Rating from '../Rating'; +import styles from './styles.module.css'; + +const Comments = () => { + const handleRating = (rating) => { + // 这里可以添加评分提交逻辑 + console.log('Rating submitted:', rating); + }; + + return ( +
+
+

文档评分

+ +
+ +
+

评论区

+ +
+
+ ); +}; + +export default Comments; \ No newline at end of file diff --git a/src/components/Comments/styles.module.css b/src/components/Comments/styles.module.css new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/src/components/Comments/styles.module.css @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/components/Rating/index.js b/src/components/Rating/index.js new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/src/components/Rating/index.js @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/components/Rating/styles.module.css b/src/components/Rating/styles.module.css new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/src/components/Rating/styles.module.css @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/theme/DocItem/index.js b/src/theme/DocItem/index.js new file mode 100644 index 0000000..b866867 --- /dev/null +++ b/src/theme/DocItem/index.js @@ -0,0 +1,37 @@ +import React from 'react'; +import {useDoc} from '@docusaurus/theme-common/internal'; +import DocItemContent from '@theme-original/DocItem/Content'; +import DocItemFooter from '@theme-original/DocItem/Footer'; +import DocItemPaginator from '@theme-original/DocItem/Paginator'; +import DocItemTOCMobile from '@theme-original/DocItem/TOC/Mobile'; +import DocItemTOCDesktop from '@theme-original/DocItem/TOC/Desktop'; +import DocVersionBadge from '@theme-original/DocVersionBadge'; +import DocVersionBanner from '@theme-original/DocVersionBanner'; +import DocItemLayout from '@theme-original/DocItem/Layout'; +import Comments from '@site/src/components/Comments'; + +export default function DocItem(props) { + const doc = useDoc(); + return ( + + +
+
+
+ + + {doc.content} + + + +
+ +
+
+ + + ); +} \ No newline at end of file diff --git a/src/theme/DocItem/styles.module.css b/src/theme/DocItem/styles.module.css new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/src/theme/DocItem/styles.module.css @@ -0,0 +1 @@ + \ No newline at end of file