Skip to main content
将 Document360 项目导出为 ZIP,然后将其工作区、语言、分类和文章转换为 Mintlify 项目。使用 Document360 API 和已发布的站点来审计导出可能未完整表示的内容。
Mintlify 抓取工具目前不支持 Document360。

创建迁移快照

在导出之前,在 Document360 中创建一个已命名的手动备份。导航到 Settings > Knowledge base portal > Backup & Restore。为迁移本身下载一份项目导出。 在 Document360 中,导航到 Content tools > Import and export > Import and export project
分别有意识地导出每个工作区和语言。单语言导出可以包含在 Markdown 编辑器中创建的文章的 Markdown,以及 WYSIWYG 文章的 HTML。多语言导出无论编辑器类型如何,都使用 JSON。
  1. 点击 Export project
  2. 选择导出格式。选择 JSON 以进行完整的项目导出。
  3. Include new or modified articles in 中,选择 All,这样导出就不会限于最近修改过的文章。
  4. 选择每个维护的工作区、语言、分类和子分类。
  5. 选择 Include media files
  6. 点击 Export。导出在后台运行,完成后会通知你。
  7. 一旦准备就绪,就从 Recent files 下载 ZIP。每次新导出都会覆盖之前的 ZIP。
  8. All articles 列表导出为 CSV。这份元数据列表有助于核对标题、发布状态、日期、分类和 URL。
保持导出的 ZIP 和 CSV 不变,作为源快照。在迁移期间的任何转换工作,都请在副本上进行。

清点导出之外的内容

记录需要单独迁移工作的项目功能。
  • Homepage Builder 内容和导航
  • 从页眉、页脚或侧边栏链接的自定义页面
  • Snippet、变量、词汇表术语和模板
  • 自定义 CSS、JavaScript 和集成
  • Reader group、角色、SSO 和私有内容规则
  • 重定向规则和自定义域名
  • 分析、反馈、表单和搜索配置
  • API 参考的源规范
  • Drive 文件、决策树和嵌入的内容
使用已发布的 sitemap 和 Document360 Customer API 将导出与公开及私有内容进行比较。当你需要遍历分类元数据,或恢复难以从导出文件推断的字段时,API 尤其有用。

重建导航

将 Document360 的层级映射到 docs.json 根据读者如何使用工作区来选择映射方式。名为 v1 的工作区通常是一个版本,而独立的产品知识库可能更适合映射到 products 或 tabs。有关 Mintlify 导航元素的更多信息,请参见 导航 Document360 分类 API 的响应只包含直接子项。如果你使用 API 建立清单,请递归请求每个子分类,并分别为 index 和 page 分类获取内容。

转换文章内容

将 Markdown 文章复制到 .mdx 文件中,并将导出的 HTML 或 JSON 转换为 MDX。添加至少包含 title 的 frontmatter,并在有用的场景下保留描述、关键词、发布元数据和 canonical 路由。 检查每种编辑器的平台特定输出: Document360 和 Mintlify 都将 title frontmatter 渲染为页面 H1,因此页面正文从 H2 开始。转换过程中不要添加重复的 H1。

转换可复用内容

在替换之前,先清点变量、snippet、词汇表术语及其每一处使用。
  • 将可复用内容块转换为 Mintlify snippet
  • 用显式文本、生成的内容或其他可维护的真实来源替换变量。
  • 用链接或受支持的 tooltip 组件替换词汇表 tooltip。
  • 保留特定语言的变体,而不要合并那些只在某一种语言下看起来相同的文本。
同时检查渲染的源站点和导出,以判断每个可复用项呈现为展开的内容,还是平台特定的引用。

迁移 API 参考

从每个 Document360 API 参考分类下载原始 OpenAPI 文件,或从同步该规范的系统中获取它。
  1. 将原始规范添加到 Mintlify 仓库。
  2. 配置 OpenAPI 生成的页面
  3. 保留编辑者在导入后添加的自定义端点描述或示例。
  4. 比较标签层级、端点顺序、servers、认证、示例和代码示例。
  5. 用 Mintlify 的部署工作流替换任何 Document360 重同步自动化。
当源规范可用时,不要转换生成的端点文章。

迁移媒体和文件

在项目导出中包含媒体,并将你拥有的文件复制到 Mintlify 项目仓库中。检查 Document360 Drive 链接、缩略图、SVG、可下载文件、CSS 背景图片以及从外部服务嵌入的内容。 在重新组织页面后更新资源路径。除非你打算继续保留旧的托管环境,否则不要将必需的生产资源留在 Document360 的域名上。

保留 URL 和访问规则

Document360 的路由可以包含工作区和语言 slug,以及分类和文章 slug。根据已发布的 sitemap 和导出的文章 CSV 建立 URL 映射,然后为每个变更的路由添加 redirects 使用 认证和访问控制 重建私有文档。创建与你之前访问控制设置相对应的 reader group 和基于角色的限制。在发布站点之前,以每个分组的身份进行测试。

检查你的迁移

检查导出的 ZIP、文章 CSV、API 清单和已发布的 sitemap 是否一致,然后测试语言切换和每个工作区选择器。 在你转换后的文件中搜索未转换的 Document360 内容:原始 HTML、snippet 和变量引用、私有笔记以及小部件嵌入。

启动你的新站点

  • 在旧站点上执行内容冻结,并跟踪迁移快照之后对其所做的每项更改。
  • 在仪表板的 Git 设置 页面确认生产分支和仓库。
  • 记录你现有的 DNS 记录,并在验证 Mintlify 部署已上线之前保持旧站点继续运行。
  • 检查导航栏、页脚、favicon、logo、颜色和字体。
  • 检查站点和页面的元数据、canonical URL 以及索引偏好设置。参见 SEO 和搜索设置
  • 安装所需的 分析集成,并可选择添加一个 自定义 404 页面
  • 如果你迁移了 API 参考,请将端点页面、导航结构、服务器 URL、认证方案和示例与旧站点进行比较。
  • 预览部署 中预览你确切的启动提交。检查桌面和移动端布局、来自每个导航区段的页面、搜索以及重定向。
  • 检查使用自定义组件或脚本的页面在浏览器控制台和网络标签页中是否有任何错误。
  • 使用 自定义域名指南 切换你的域名,该指南涵盖了对已提供文档服务的域名的零停机切换。
  • 启动后,监控 404 错误、重定向失败和构建失败。

Document360 参考资料