mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f072caaf92
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
132 lines
5.9 KiB
Plaintext
132 lines
5.9 KiB
Plaintext
---
|
||
title: "审阅更改"
|
||
sidebarTitle: "审阅"
|
||
description: "在更改上线前进行预览，与团队共享，并在编辑器中批准和合并 pull request。"
|
||
keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"]
|
||
---
|
||
|
||
在更改进入已发布的站点之前先进行预览，然后无需离开编辑器即可审阅并合并 pull request。
|
||
|
||
<div id="live-preview">
|
||
|
||
## 实时预览
|
||
|
||
</div>
|
||
|
||
实时预览会在你编辑时渲染站点，无需构建步骤。点击顶部栏中的 <Icon icon="play" /> 实时预览按钮。
|
||
|
||
若要编辑站点设置并查看其对内容的影响，请点击预览工具栏中的 **Site settings**，然后选择一个配置分区。如果你启用了 [Open live preview in new tab](/zh/editor/settings#appearance)，则无法使用该菜单。
|
||
|
||
若要在预览旁边打开[智能体](/zh/editor/agent)，请点击预览工具栏中的 **Ask agent**。只有 editors 和 admins 才能在实时预览中使用智能体。
|
||
|
||
<Note>
|
||
实时预览适用于公开站点，以及受 Mintlify 认证保护的站点。
|
||
</Note>
|
||
|
||
<div id="preview-deployments">
|
||
|
||
## 预览部署
|
||
|
||
</div>
|
||
|
||
当你从 feature branch 打开 pull request 时，Mintlify 会构建一个预览部署：一个临时 URL，其中你的更改会完全按照发布后的样子呈现。每当你向该分支保存新的更改，预览都会重新构建。
|
||
|
||
若要查找并共享该 URL，请点击工具栏中的 **Publish**。URL 格式为 `organization-branch-name.mintlify.site`。
|
||
|
||
<Frame>
|
||
<img src="/images/editor/share-preview-light.png" alt="发布菜单中突出显示的预览 URL。" className="dark:hidden" />
|
||
<img src="/images/editor/share-preview-dark.png" alt="发布菜单中突出显示的预览 URL。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
预览 URL 默认可公开访问。若要将访问权限限制为你的 Mintlify 组织成员，请在仪表板的 [Add-ons](https://app.mintlify.com/settings/deployment/addons) 页面的 **Previews** 部分中启用预览认证。更多信息请参阅[限制预览部署的访问权限](/zh/deploy/preview-deployments#restrict-access-to-preview-deployments)。
|
||
|
||
<div id="which-preview-to-use">
|
||
|
||
## 该使用哪种预览
|
||
|
||
</div>
|
||
|
||
| | 实时预览 | 预览部署 |
|
||
|---|---|---|
|
||
| **速度** | 即时 | 需要构建 |
|
||
| **访问方式** | 本地 URL | 可共享的 URL |
|
||
| **适用场景** | 编辑过程中查看更改 | 与团队共享以供审阅 |
|
||
| **可用时长** | 编辑器打开期间 | 只要该分支存在 |
|
||
|
||
<div id="share-an-editor-link">
|
||
|
||
## 共享编辑器链接
|
||
|
||
</div>
|
||
|
||
若要把同事引导到某个分支上的特定页面，请从浏览器地址栏复制 URL。任何有权访问你的 Mintlify 组织的人都可以在自己的编辑器会话中打开它。
|
||
|
||
```text
|
||
https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}
|
||
```
|
||
|
||
例如：`https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx`
|
||
|
||
<div id="review-and-merge-pull-requests">
|
||
|
||
## 审阅并合并 pull request
|
||
|
||
</div>
|
||
|
||
当前分支存在打开的 pull request 时，发布菜单会显示一个审阅面板，其中包含：
|
||
|
||
- pull request 的标题和描述
|
||
- 源分支和目标分支
|
||
- 已更改文件的数量
|
||
- deployment branch 上的审批要求
|
||
- 当前的审阅状态
|
||
|
||
审阅者批准后，点击 **Merge and publish** 即可在编辑器中完成合并和部署。合并后，编辑器会把你切换回 deployment branch。
|
||
|
||
<div id="approve-from-the-editor">
|
||
|
||
### 在编辑器中批准
|
||
|
||
</div>
|
||
|
||
对于 GitHub 仓库，审阅者无需离开编辑器即可批准打开的 pull request。如果你的账户有审阅权限，审阅面板中会出现 **Approve pull request** 按钮。状态会更新为 **Approved**，并且 **Merge and publish** 变为可用。
|
||
|
||
如果你使用 GitLab 或 Bitbucket，请在对应的 Git 提供方中打开该 pull request 进行批准。
|
||
|
||
<Tip>
|
||
在 Git 提供方中配置分支保护规则，以强制要求使用 pull request。请参阅 GitHub 帮助中的 [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)，或 GitLab 帮助中的 [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/)。
|
||
</Tip>
|
||
|
||
<div id="compare-changes-before-merging">
|
||
|
||
### 合并前比较更改
|
||
|
||
</div>
|
||
|
||
在发布菜单中点击任意已更改的文件，即可在 diff 视图中将其与已发布版本进行比较。可视化模式显示可视化 diff，source 模式显示文本 diff。无法显示 diff 的文件（例如图片或已删除的文件）会出现在列表中，但无法点击。
|
||
|
||
出现在分支 diff 中的[隐藏页面](/zh/organize/hidden-pages)也可以从发布菜单中打开，即使它们并未出现在站点导航中。
|
||
|
||
<div id="pull-request-titles-and-descriptions">
|
||
|
||
### pull request 的标题和描述
|
||
|
||
</div>
|
||
|
||
如果你的组织要求使用 pull request，你可以在发布时输入标题和描述。如果其中任一项留空，编辑器会生成一个，列出你创建、更新、移动或删除的文件。若要控制其撰写方式，请设置 [PR 说明](/zh/editor/settings#pr-instructions)。
|
||
|
||
如果你的分支存在未解决的评论线程，Mintlify 会把这些线程的摘要添加到 pull request 描述中。请参阅[协作](/zh/editor/collaborate#comments)。
|
||
|
||
<div id="review-an-automation-run">
|
||
|
||
## 审阅自动化运行
|
||
|
||
</div>
|
||
|
||
当[自动化](/zh/automations)打开 pull request 时，你可以在该自动化的分支上打开编辑器：
|
||
|
||
- 在仪表板的 **Automation Runs** 页面中，点击已完成运行上的 **Open in editor**。
|
||
- 在 Slack 通知中，点击 **View changes** 链接。
|
||
|
||
这两种入口都会在自动化所在的分支上打开编辑器，并在发布菜单中预先选中被修改的页面，让你无需离开编辑器即可审阅 diff 并进行合并或请求修改。[智能体](/zh/editor/agent#continue-an-automation-run)会在旁边打开，并带有该自动化所做工作的上下文。
|