第三方集成指南说明如何将第三方产品与 Cloudflare 配合使用。由于 Cloudflare 无法控制第三方界面,这类指南存在实际维护风险,因此更倾向于链接到外部维护的文档,而不是复述另一款产品的步骤。语气为指导性、直截了当。
当读者需要将某一特定外部产品与 Cloudflare 连接,并且该集成值得以持续维护为前提发布时,请编写第三方集成指南。它不是:
- 如何操作。 如何操作记录完全发生在 Cloudflare 内的任务,而集成指南会进入 Cloudflare 无法控制的第三方产品。
- 博客文章。 只有在预期会维护时才发布集成指南。如果不打算维护,请改写博客文章。
完整比较请参阅内容类型。
- 标题:包含第三方产品名称的第二人称命令式短动词短语,不要使用动名词。如果集成对象是 Cloudflare 技术合作伙伴,请在标题后添加 partner 组件。
- 描述:同时点出第三方产品和 Cloudflare 产品,说明集成要达成什么,并注明关键先决条件。
复制此骨架并按你的集成进行改写:
---
title: <Verb phrase naming the third-party product>
description: Connect <third-party product> with <Cloudflare product> to <what the integration accomplishes>.
pcx_content_type: integration-guide
sidebar:
order: 10
products:
- product-a
---
介绍该集成要达成什么,以及第三方特有的注意事项。
## Prerequisites
列出读者开始前在第三方侧需要具备的条件。
## Set up the integration
给出完成集成的步骤,链接到第三方自己的文档,而不是复述其流程。
## Related links
指向第三方维护的文档以及相关的 Cloudflare 产品文档。- 上下文介绍这些步骤要达成什么,以及第三方特有的注意事项。
- 先决条件列出读者开始前在第三方侧需要具备的条件。
- 步骤完成集成,对基本概念提供外链而不是在此教学。
- 链接指向第三方自己的文档(优先于复述其流程),且只链接到有信誉的来源。
- 不适合放入的内容: 第三方产品的分步说明,因为第三方一旦改动就会过时。第三方产品的屏幕截图最为脆弱,因此应避免使用,改为链接到外部维护的来源。
pcx_content_type: integration-guide
products:
- product-a
- product-b欲了解更多详情,请参考 pcx_content_type。
将第三方集成指南作为售后、使用阶段的内容发布,并预期有人会维护它。外部指南的维护成本更高,因为 Cloudflare 无法控制第三方界面,也无法获得对变更同等的可见性。如果想发布但不做维护承诺,请改写博客文章。这类内容最常见于 Workers、Zero Trust 和 Analytics 集成。
在 Cloudflare 仪表板中完成的集成:
链接到外部文档:
同时包含第三方环境和 Cloudflare 仪表板中的说明(不鼓励但有时可以接受):
- 链接,不要复述。 将步骤指向第三方自己的文档,因为复述的说明和屏幕截图会在外部产品变更后立刻过时。
- 写全先决条件。 准确说明读者开始前在第三方侧需要具备的条件,因为智能体无法完成它尚未准备好进入的集成。
- 同时点出两款产品。 在标题和上下文中同时写出第三方产品和 Cloudflare 产品,以便读者或智能体将指南与所需集成对应起来。