Skip to content

Commit 04e7ac2

Browse files
committed
Add disambiguation sections
1 parent 701b46f commit 04e7ac2

File tree

5 files changed

+30
-4
lines changed

5 files changed

+30
-4
lines changed

src/content/docs/style-guide/documentation-content-strategy/content-types/design-guide.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@ meta:
77

88
## Purpose
99

10-
Help users understand how to plan and design a solution using Cloudflare. Typically design guides are a subset of a reference architecture.
10+
Help users understand how to plan and design a solution using Cloudflare. Typically [design guides](/reference-architecture/design-guides/) are a subset of a [reference architecture](/reference-architecture/).
11+
12+
:::note[Disambiguation]
13+
14+
This page describes the content strategy for a design guide. For help with Cloudflare products, refer to [Design guides](/reference-architecture/design-guides/).
15+
16+
:::
1117

1218
## Tone
1319

src/content/docs/style-guide/documentation-content-strategy/content-types/implementation-guide.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@ meta:
77

88
## Purpose
99

10-
Walk the reader through best practices for the implementation of a solution using Cloudflare.
10+
Walk the reader through best practices for the [implementation](/reference-architecture/implementation-guides/) of a solution using Cloudflare.
11+
12+
:::note[Disambiguation]
13+
14+
This page describes the content strategy for an implementation guide. For help with Cloudflare products, refer to [Implementation guides](/reference-architecture/implementation-guides/).
15+
16+
:::
1117

1218
## Tone
1319

src/content/docs/style-guide/documentation-content-strategy/content-types/reference-architecture-diagram.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ import { Render } from "~/components";
1111

1212
To provide a visual reference and explanation of using Cloudflare for a specific solution.
1313

14+
:::note[Disambiguation]
15+
16+
This page describes the content strategy for a reference architecture diagram. For help with Cloudflare products, refer to [Reference archiectures diagrams](/reference-architecture/diagrams/).
17+
18+
:::
19+
1420
## Tone
1521

1622
instructional, straightforward

src/content/docs/style-guide/documentation-content-strategy/content-types/reference-architecture.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,16 @@ import { Render } from "~/components";
99

1010
## Purpose
1111

12-
The purpose of a reference architecture is to provide a high-level view of how all or part of the Cloudflare platform is built and how Cloudflare products would fit into a customer's existing infrastructure. Reference architectures are designed to show where our platform fits in with a customer's current environment and describe key aspects of a Cloudflare feature/service. Reference architectures should also map customer use cases to Cloudflare solutions.
12+
The purpose of a [reference architecture](/reference-architecture/) is to provide a high-level view of how all or part of the Cloudflare platform is built and how Cloudflare products would fit into a customer's existing infrastructure. Reference architectures are designed to show where our platform fits in with a customer's current environment and describe key aspects of a Cloudflare feature/service. Reference architectures should also map customer use cases to Cloudflare solutions.
1313

1414
Reference architectures are typically very detailed. To describe a single architecture without much written content, use a [Reference architecture diagram](/style-guide/documentation-content-strategy/content-types/reference-architecture-diagram/).
1515

16+
:::note[Disambiguation]
17+
18+
This page describes the content strategy for a reference architecture. For help with Cloudflare products, refer to [Reference archiectures](/reference-architecture/).
19+
20+
:::
21+
1622
## Tone
1723

1824
guiding, straightforward

src/content/docs/style-guide/documentation-content-strategy/content-types/tutorial.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
pcx_content_type: concept
3-
title: Content type - Tutorial
3+
title: Tutorial
4+
meta:
5+
title: Content type - Tutorial
46
---
57

68
import { GlossaryDefinition, Render } from "~/components";

0 commit comments

Comments
 (0)