跳转到主要内容

​
发布工作流

编辑器支持两种发布文档更新的工作流程。你使用的工作流程取决于存储库的 branch 保护规则以及你正在使用的 branch。 如果你的存储库具有需要审核的 branch 保护规则，编辑器会创建一个拉取请求（PR；亦称“合并请求”/Merge Request）。团队成员可以在更改上线之前审核你的更改。有关协作工作流和团队审核流程，请参阅 Collaborate。 如果没有保护规则，你的更改会合并到部署用分支并立即部署。
branch 类型branch 保护发布时会发生什么
无提交并部署更改
部署用分支需要拉取请求创建一个拉取请求
无将更改合并到部署用分支并部署
功能分支需要拉取请求创建一个拉取请求
在你的 Git 服务提供商中配置 branch 保护规则以要求拉取请求。请参阅 GitHub 文档中的 About protected branches 或 GitLab 文档中的 Protected branches。

​
保存更改

在编辑过程中，编辑器会跟踪你的更改。
  • 新建或删除的文件。
  • 页面内容的修改。
  • 导航结构的更改。
  • 媒体文件的上传和整理。
  • 配置更新。
网页编辑器工具栏，显示一个待处理的更改。
当你在部署用分支上工作时，更改会自动保存。 当你在功能分支上工作时，可以将更改以的形式保存到该分支。
网页编辑器工具栏，显示一个待处理的更改，以及功能分支上的 Save as commit 按钮。
若要放弃更改，请在 Changes 下拉菜单中文件名旁单击 Undo changes。

​
发布你的更改

如果你当前位于部署用分支，在工具栏中点击 Publish。根据你的工作流，要么在站点重新部署后你的更改会立即生效，要么你需要在 Git 提供商中创建一个拉取请求（PR；亦称“合并请求”/Merge Request）并将其合并。 如果你当前位于功能 branch，先保存你的更改，然后在工具栏中点击 Publish。根据你的工作流，要么在站点重新部署后你的更改会立即生效，要么你需要在 Git 提供商中创建一个拉取请求（PR；亦称“合并请求”/Merge Request）并将其合并。

​
解决冲突

当你的 branch 和部署用分支对同一文件做了互不兼容的更改时，就会发生冲突。

​
冲突产生的原因

冲突会在以下情况下发生：
  • 你和另一位团队成员编辑了同一文件中的相同行。
  • 在一个 branch 中，文件被移动或删除，但在另一个 branch 中被修改。

​
解决冲突

当冲突导致无法执行发布或切换 branch 等操作时，编辑器会显示 Warning。要解决冲突，请按照编辑器中的提示选择要保留的更改。

​
提交签名

在你的 账户设置 中授权你的 GitHub 账号，即可用该账号对提交进行签名。若未完成授权，则由 Mintlify GitHub 应用为在网页编辑器中完成的提交进行签名。 将提交归属到你的账号有助于准确记录是谁对你的文档进行了更改。