分区中的变更请求
了解如何在分区中协作处理单个变更请求——包括如何审阅、解决冲突和合并
当你处于一个 部分中时,你可以通过打开新的变更请求来进行修改,或者浏览现有的变更请求,查看其他人正在处理什么。
创建变更请求
点击 编辑 中的按钮 章节标题 以开始一个新的变更请求。
这将打开一个新的变更请求,你可以根据需要编辑或删除内容。你的更改会自动保存,其他人也可以加入你的变更请求,与您实时协作。
在创建变更请求时,你可以添加标题和描述,以提供更多关于所做更改的上下文。
你还可以将变更请求链接到来源,包括:
Linear 问题
GitHub 拉取请求或问题
Jira 工单
通用 URL
这些链接会显示在变更请求中,因此审阅者可以追溯这些工作的来源。
使用 GitBook Agent 创建变更请求
GitBook Agent 是一个 AI 队友,可以 规划并实现变更请求 基于你提供的任何指令。
要使用 GitBook Agent 打开一个新的变更请求,请点击右上角“编辑”按钮旁边的 GitBook Agent 图标,并告诉 GitBook 实现你想要的任何更改。
你可以让它做的事情包括:
添加使用示例
改进页面 SEO
提升清晰度
检查一致性
修复拼写和错别字
链接相关内容
以及更多
前往 使用 GitBook Agent 写作 了解更多。
预览变更请求
你可以通过点击 预览 中的 章节标题选项来预览你在变更请求中所做的更改。这将切换到已发布文档的预览,其中包含提议的更改,因此你可以在整个已发布文档的上下文中查看这些更改。
按钮下方是一个 预览 站点预览 URL。点击此处,你的站点预览将在新标签页中完整打开。
当你在新标签页中打开预览 URL 时,你还会看到 预览工具栏 位于浏览器窗口底部。该工具栏可让你快速返回 GitBook,以查看、编辑或评论变更请求,或打开你站点的实时版本。
如果你的内容是通过分享链接或已认证访问发布的,预览功能将不会出现。
请求审阅变更请求
当你想在将更改合并到主分支之前,请求团队成员检查你的内容时,请对你的变更请求发起审阅请求。
点击 概述 章节标题栏中的标签页,可打开你的变更请求概览——包括你在差异视图中所做的所有更改。
使用 概述 标签页以添加上下文和审阅者。要在编辑器中检查差异,请切换到 更改 标签页。在该视图中,带有差异的页面会显示指示器,浮动的差异导航控件可帮助你更快地在变更块之间跳转。
你可以在此为变更请求添加描述,为审阅者提供一些上下文,并标记你希望检查工作的特定人员。
当你点击 请求审核时,变更请求的状态将变为 审阅中,并且你在审阅请求中标记的任何人都会收到通知。
如果你没有在审阅请求中标记任何人,则该章节中拥有审阅者权限的每个人都会收到通知。如果该章节没有审阅者,则审阅者之上的下一个角色会收到通知。
差异视图
如果页面包含差异,GitBook 还会显示一个悬浮的居中指示器。点击它可滚动到第一个已更改的块或元素。
当你打开 更改 章节标题中的标签页时,GitBook 会显示在变更请求中编辑过的每个页面和块。GitBook 左侧显示上一版本,右侧显示更新后的版本。这样可以更轻松地并排比较编辑内容。
包含差异的页面也会在目录中显示指示器,这使大型变更请求更容易浏览。
当你在编辑器的 更改 标签页中审阅页面时,浮动的差异导航控件可帮助你更快地在变更块之间跳转,而无需滚动整页。
使用差异视图时有两个选项:
显示所有页面 —— 这会在目录中显示已更改和未更改的页面,因此你可以在整个章节的上下文中审阅编辑内容。
仅显示已更改的页面 —— 这只会显示已修改的页面,因此你可以专注于已编辑的内容。
你可以切换到 更改 标签页,以在任何变更请求中查看差异视图。

合并变更请求
合并变更请求会将该变更请求的更改添加到内容的主分支中,创建更新后的版本以及该章节中的一个新条目 版本历史记录.
更新变更请求
当你在变更请求中工作时,其他贡献者可能正在修改该章节的主分支。发生这种情况时,你的变更请求会被视为“已过期”——主分支上有你在变更请求中看不到的内容。
你可能希望将这些新内容拉入你的变更请求中。如果出现以下情况,这会很有用:
你想看看你的更改和主分支上的内容合在一起后会是什么样子。
你需要将拉取的内容作为变更请求的一部分进行修改。
你可以通过按下 更新 在变更请求屏幕标题中。
一旦你按下 更新,主分支中的所有内容都会被拉入你的变更请求中。更新时你可能会遇到冲突——你可以在变更请求中解决这些冲突。冲突解决后,变更请求会被视为已更新,更新按钮会消失。
如果主分支再次发生更改,你的变更请求又会变成过期状态,更新按钮将再次出现。
要求编辑者在合并前使其变更请求保持最新,是一种很好的质量控制措施——它帮助作者确认变更请求合并后将进入主分支的确切内容。你可以通过一个 合并规则.
解决合并冲突
有时,当你想要合并变更请求时,可能会发现主内容与你试图合并的内容之间存在冲突。最简单地说,冲突就是一段无法自动合并的内容。
如果发生这种情况,你会看到一个冲突警报,以及在继续合并之前需要解决的冲突列表。
在解决合并冲突时,你有两个选项—— 选择要合并的版本 或 手动 编辑内容.
选择要合并的版本
你可以通过选择要合并的版本来解决合并冲突——可以是传入的内容,也可以是之前已有的内容。这样你就可以在一个更改和另一个更改之间进行选择——要么是你最近的工作,要么是原始内容。
如果你处理的是可以通过这种方式解决的合并冲突,你可以选择要保留的版本,另一个版本将被删除。
手动编辑
如果你不想在版本之间做选择,你可以通过手动编辑冲突来解决合并冲突。你可以删除不需要的块,甚至完全重写它们。处理完这些更改后,你可以继续处理下一个冲突,直到全部解决。
归档变更请求
你不能在 GitBook 中删除变更请求,但可以将其归档。
要归档变更请求:
打开 变更请求 选项卡。
点击你要归档的变更请求。
点击 操作 菜单
旁边的变更请求标题,然后选择 归档.
要查找并重新打开已归档的变更请求,请打开 变更请求 菜单并点击 已归档 选项卡。
最后更新于
这有帮助吗?