mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
65c0d2ae25
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
103 lines
4.0 KiB
Plaintext
103 lines
4.0 KiB
Plaintext
---
|
||
title: "在 Web 编辑器中协作"
|
||
sidebarTitle: "协作"
|
||
description: "使用 branch、拉取请求、预览部署以及可分享的编辑器链接协作撰写文档。"
|
||
keywords: ["编辑器", "协作", "branch", "拉取请求", "预览部署", "可分享链接"]
|
||
---
|
||
|
||
使用基于 branch 的工作流、拉取请求和预览部署，与团队协作撰写文档。
|
||
|
||
如果你不熟悉 Git，请参阅 [Git 概念](/zh/guides/git-concepts)。
|
||
|
||
<div id="branch-based-collaboration">
|
||
## 基于 branch 的协作
|
||
</div>
|
||
|
||
使用 branch 并行更新文档，在不影响线上站点的前提下完成修改。
|
||
|
||
<div id="why-use-branches">
|
||
### 为什么要使用 branch
|
||
</div>
|
||
|
||
* **隔离更改**：在不影响线上文档的情况下进行更新。
|
||
* **发布前评审**：在更改上线之前先获取团队成员的反馈。
|
||
* **并行协作**：多个团队成员可以同时在不同的 branch 上工作。
|
||
|
||
<div id="recommended-workflow">
|
||
## 推荐工作流
|
||
</div>
|
||
|
||
建议使用拉取请求（PR；亦称“合并请求”/Merge Request）在合并到线上文档之前提出更改并与团队协作。此工作流可以确保团队在发布前完成审查，并保持清晰的更新历史记录。
|
||
|
||
<Steps>
|
||
<Step title="创建拉取请求">
|
||
当你准备好发布更改时，可以在编辑器中创建拉取请求。有关使用拉取请求的更多信息，请参阅 <a href="/zh/editor/publish">在网页编辑器中发布更改</a>。
|
||
</Step>
|
||
|
||
<Step title="审查拉取请求">
|
||
在你的 Git 托管平台（如 GitHub 或 GitLab）中审查拉取请求。
|
||
</Step>
|
||
|
||
<Step title="回应反馈">
|
||
当审查者请求更改时，根据要求进行修改并保存你的更改。后续的更改会自动推送到现有的拉取请求中。
|
||
</Step>
|
||
|
||
<Step title="合并拉取请求">
|
||
当所有请求的更改都已处理、拉取请求已通过必需审查者批准且所有自动检查均已通过时，合并你的拉取请求。
|
||
</Step>
|
||
</Steps>
|
||
|
||
<div id="preview-deployments">
|
||
## 预览部署
|
||
</div>
|
||
|
||
预览部署会创建临时 URL，你可以在更改正式上线之前先查看渲染效果。使用预览部署来收集关于更改的反馈。
|
||
|
||
<div id="access-preview-deployments">
|
||
### 访问预览部署
|
||
</div>
|
||
|
||
1. 在编辑器工具栏中点击 **Share**。
|
||
2. 点击 **Preview**，在新标签页中打开预览部署。
|
||
3. 预览 URL 会展示包含所有已保存更改的文档站点。
|
||
|
||
<Frame>
|
||
<img src="/images/editor/share-preview-light.png" className="block dark:hidden" alt="编辑器工具栏中的 Share 按钮" />
|
||
|
||
<img src="/images/editor/share-preview-dark.png" className="hidden dark:block" alt="编辑器工具栏中的 Share 按钮" />
|
||
</Frame>
|
||
|
||
<div id="share-previews">
|
||
### 分享预览
|
||
</div>
|
||
|
||
将预览部署的 URL 分享给团队成员以收集反馈。当你保存更多更改时，预览会自动更新。
|
||
|
||
<div id="preview-authentication">
|
||
### 预览认证
|
||
</div>
|
||
|
||
预览 URL 默认对所有人公开可访问。在控制台的 [附加组件（Add-ons）](https://dashboard.mintlify.com/products/addons) 页面启用预览认证，以将访问限制为已通过认证的组织成员。
|
||
|
||
<div id="share-editor-links">
|
||
## 分享编辑器链接
|
||
</div>
|
||
|
||
将编辑器中某个特定页面的直接链接分享给你的团队成员。使用编辑器链接来协作更新内容并对页面进行修改。
|
||
|
||
当你打开一个页面时，编辑器会将路径记录在 URL 中。从浏览器地址栏中复制该 URL，与有编辑器访问权限的团队成员分享。
|
||
|
||
URL 的格式是：
|
||
|
||
```
|
||
https://dashboard.mintlify.com/{org}/{project}/editor/{branch}?file={filepath}
|
||
```
|
||
|
||
例如，`https://dashboard.mintlify.com/acme/docs/editor/main?file=guides/quickstart.mdx` 会在 `main` branch 上打开 `quickstart.mdx` 文件。
|
||
|
||
任何有权访问你所在 Mintlify 组织的人都可以使用该链接直接在编辑器中打开该文件。
|
||
|
||
<Tip>
|
||
当你分享页面链接时，告诉对方你当前使用的是哪个 branch，这样他们就能确认自己查看的是正确的版本。
|
||
</Tip>
|