跳转到内容
搜索文档

第三方集成指南

最后更新 查看 MarkdownAgent 设置

目的

第三方集成指南的目的是解释如何将第三方产品与 Cloudflare 配合使用。虽然我们希望帮助客户,因为不同产品之间的集成可能是一个痛点,但与特定类型的第三方资源相关的风险和维护成本很高。

语气

指导性、直截了当

内容类型 (content_type)

pcx_content_type: integration-guide
products:
  - product-a
  - product-b
  - product-c

欲了解更多详情,请参考 pcx_content_type

结构

必要组件

标题:包含第三方名称的第二人称命令式短动词短语。请勿使用动名词短语。

如果第三方集成指南是与特定的 Cloudflare 技术合作伙伴相关的,请在标题后添加指示 <partner> 的 Markdown 组件。

上下文:针对后续步骤以及这些步骤将实现什么目标的引导段落。

为读者提供章节标题中未包含的上下文。

以冒号或句号结尾。如果其后紧跟步骤,请使用冒号。如果在上下文和程序之间还有其他内容(例如注释),请使用句号。

请勿使用由编号步骤来补全的残缺句子来为步骤提供上下文。

提及第三方与 Cloudflare 之间的任何独特注意事项。

先决条件:在用户可以完成一系列步骤之前必须完成的任务或必须满足的条件。

对于第三方集成指南,请在其中包含有关后续步骤中需要与第三方进行哪些交互的信息。

步骤:完成任务的编号步骤。

对于基本概念(正则表达式、JavaScript、Web 服务器维护等),请提供外部链接。

链接:可以是引用第三方产品的无序列表,或是指向第三方流程文档的文本内链接。

在合理的范围内链接到有信誉的来源。

可选组件

注释/警告

示例

屏幕截图

表格

步骤验证

模板

单一程序的第三方集成指南


---
weight: xx
pcx_content_type: integration-guide
description: Integrate <3rd-party name> with <Cloudflare product> to <what the integration accomplishes>. Requires <key prerequisites>.
products:
  - product-a
  - product-b
  - product-c
---

# Second-person imperative verb phrase with 3rd-party name included

Context for procedure

Prerequisites

1. Step one
2. Step two
3. Step three
4. ...

包含必须按顺序完成的多个程序的第三方集成指南


---
weight: xx
pcx_content_type: integration-guide
description: Integrate <3rd-party name> with <Cloudflare product> to <what the integration accomplishes>. Requires <key prerequisites>.
products:
  - product-a
  - product-b
  - product-c
---

# Second-person imperative verb phrase with 3rd-party name included

Context for procedure

Prerequisites

## 1. Second-person imperative verb phrase

1. Step one
2. Step two
3. Step three
4. ...

## 2. Second-person imperative verb phrase

1. Step one
2. Step two
3. Step three
4. ...

## 3. Second-person imperative verb phrase

1. Step one
2. Step two
3. Step three
4. ...

示例

Cloudflare 仪表板中的第三方集成

链接到外部文档

(不鼓励但可接受的情况)包含第三方环境中说明和 Cloudflare 仪表板中说明的操作指南

其他信息

外部集成指南的维护成本更高,因为我们无法控制外部 UI,而且我们通常无法像对内部产品那样对变更保持可见性。

我们发布的是售后内容。它可能会在售前被参考,但我们发布的是使用阶段的内容。

我们发布文档时就做好了维护的预期。如果您想发布不打算维护的内容,请撰写博客。

我们经常能看到第三方信息的产品

这篇文档对您有帮助吗?