空间中的变更请求

了解在单个空间中对单个变更请求进行协作的方式 — 包括如何审查、解决冲突和合并

当您位于 空间时,您可以通过开启新的变更请求来进行更改,或浏览现有的变更请求以查看其他人在处理什么内容。

创建变更请求

在已禁用实时编辑的空间内,点击 编辑 按钮位于 空间标题 以开始新的变更请求。

这将打开一个新的变更请求,您可以根据需要编辑或删除内容。您的更改会自动保存,其他人也可以加入您的变更请求以进行实时协作。

创建变更请求时,您可以添加标题和描述,以提供有关所做更改的更多上下文信息。

当您对更改满意后,可以使用标题栏中的按钮来 请求审查 您的变更请求,或 合并 将其直接合并到主分支中。

使用 GitBook Agent 创建变更请求

GitBook 代理 是一个 AI 团队成员,可以 根据您提供的任何指示规划并执行变更请求

要使用 GitBook Agent 打开新的变更请求,请点击位于右上角“编辑”按钮旁的 GitBook Agent 图标,然后请求 GitBook 实施您想要的任何更改。

您可以让它做的一些事情包括:

  • 添加使用示例

  • 改善页面 SEO

  • 提升内容清晰度

  • 检查一致性

  • 修正拼写和打字错误

  • 关联相关内容链接

  • 以及更多

前往 使用 GitBook Agent 撰写 了解更多。

预览变更请求

您可以通过点击 预览 中的选项来预览您在变更请求中所做的更改。 空间标题这将切换到包含所提议更改的已发布文档的预览视图,以便您在已发布文档的整体语境中查看更改内容。

预览 按钮下方是您站点预览的 URL。点击此链接,站点预览会在新标签页中完整打开。

当您在新标签页中打开预览 URL 时,您还会看到 预览工具栏 出现在浏览器窗口底部。该工具栏可让您快速返回 GitBook 以查看、编辑或评论变更请求,或打开站点的实时版本。

circle-info

您只能预览已添加到 已发布文档站点.

circle-exclamation

请求对变更请求进行审查

当您希望团队成员在将更改合并到主分支之前检查您的内容时,请请求对您的变更请求进行审查。

选择 概览 在空间标题栏中点击选项卡以打开变更请求概览 —— 包括以差异视图显示的所有更改。

在这里,您可以为变更请求添加描述以向审阅者提供一些上下文,并标注您希望检查您工作的特定人员。

当您点击 请求审查时,变更请求的状态将更改为 审核中,且您在审阅请求中标注的任何人都会收到通知。

如果您的更改不需要审查,您拥有适当的 权限,且没有任何阻止性的 合并规则,您也可以直接将更改合并到主版本。

circle-info

将 GitBook Agent 添加为审阅者 到您的变更请求中,它可以检查您的内容中的拼写、语法和风格指南错误,建议改进等。

circle-exclamation

差异视图

当您打开空间标题中的 更改 选项卡时,将出现差异视图。差异视图会突出显示变更请求中每个被编辑的页面和区块。它会在目录中突出显示任何被编辑的页面,并在页面上显示已添加、编辑或删除的具体区块。

在使用差异视图时有两个选项:

  1. 显示所有页面 – 这是差异视图的默认模式,它会在目录中同时显示已修改和未修改的页面。这有助于在整个空间的上下文中查看哪些页面被编辑过。

  2. 仅显示已更改页面 – 此模式将在目录中仅显示已修改的页面,有助于您专注于已更改的内容。对于具有许多页面和子页面的大型空间,这尤其有用。

您可以切换到 更改 选项卡以检查任何变更请求中的差异视图。

合并变更请求

合并变更请求会将变更请求中的更改添加到内容的主分支,创建一个更新版本并在空间的 版本历史.

中生成新条目。 权限如果您没有合适的 合并规则.

,或者您的变更请求尚未通过您所在组织或空间的

,您可能无法合并变更请求。

解决合并冲突

有时,当您尝试合并变更请求时,可能会发现主内容与您尝试合并的内容之间存在冲突。最简单的形式,冲突是指无法自动合并的一段内容。 如果发生这种情况,系统会向您显示冲突警报,以及在继续合并之前需要解决的冲突列表。在解决合并冲突时,您有两个选项—— 选择一个要合并的版本.

手动

编辑内容

选择要合并的版本

您可以通过选择要合并的版本来解决合并冲突——要么是您要合并进来的内容,要么是之前存在的内容。这允许您在两者之间进行选择——要么保留您最近的更改,要么保留原始内容。

如果您正在处理可以通过这种方式解决的合并冲突,您可以选择要保留的版本,另一个版本将被删除。

手动编辑

如果您不想在版本之间进行选择,可以通过手动编辑冲突来解决合并冲突。您可以删除不需要的区块,甚至完全重写它们。确认更改满意后,您可以继续处理下一个冲突,直到全部解决。

存档变更请求 操作菜单 The Actions menu icon in GitBook 如果您决定不合并某个变更请求并希望将其从队列中移除,您可以将其存档。 要存档变更请求,首先打开它。然后点击变更请求标题旁的并选择 存档 。您可以稍后通过打开 变更请求(Change Requests)菜单并选择“已存档”来查找并重新打开已存档的变更请求。 选项卡来查看这些评分的结果。

最后更新于

这有帮助吗?