Skip to content

Commit 1590890

Browse files
committed
structure
1 parent 7bcbfce commit 1590890

File tree

7 files changed

+64
-23
lines changed

7 files changed

+64
-23
lines changed

src/content/docs/style-guide/api-content-strategy/index.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
---
22
pcx_content_type: concept
3-
title: API content strategy
3+
title: API docs content strategy
44
sidebar:
55
order: 5
6-
76
---
87

9-
import { DirectoryListing } from "~/components"
8+
import { DirectoryListing } from "~/components";
109

11-
The API content strategy aims to:
10+
The API docs content strategy aims to:
1211

13-
* Reduce internal and external user frustration
14-
* Align with industry standards in terms of naming conventions and descriptions
15-
* Create world-class content that is just as good, or better, than very popular API documentation
12+
- Reduce internal and external user frustration
13+
- Align with industry standards in terms of naming conventions and descriptions
14+
- Create world-class content that is just as good, or better, than very popular API documentation
1615

1716
By ensuring Cloudflare's API content is straightforward, easy to navigate, and consistent, we can create world-class API content that eliminates user frustration and serves as an example of good API documentation.
1817

src/content/docs/style-guide/documentation-content-strategy/index.mdx

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
11
---
22
pcx_content_type: concept
3-
title: Developer documentation content strategy
3+
title: Product docs content strategy
44
sidebar:
55
order: 3
6-
76
---
87

9-
import { DirectoryListing } from "~/components"
8+
import { DirectoryListing } from "~/components";
109

1110
The purpose of Cloudflare's developer documentation content strategy is to:
1211

13-
* Create and document standard templates to streamline content creation
14-
* Document specific content types to help identify customers' specific needs
15-
* Enable life cycle management to maintain and optimize a smaller set of pages
16-
* Suggest easier navigation paths
12+
- Create and document standard templates to streamline content creation
13+
- Document specific content types to help identify customers' specific needs
14+
- Enable life cycle management to maintain and optimize a smaller set of pages
15+
- Suggest easier navigation paths
1716

1817
Strategically speaking, the mission and guiding principles translate into the following initiatives:
1918

20-
* Improve the entire ecosystem of customer-facing product content, placing major emphasis on consistency, quality, accuracy, and timeliness
21-
* Create a cohesive and compelling story around our products and their functionality
22-
* Develop content that increases product adoption, deflects support, and makes customers successful
23-
* Partner with various internal departments and stakeholders in creating and sustaining a rich, consistent content experience across all Cloudflare products
24-
* Devise new and better ways to give users the information they need, when and where they need it
19+
- Improve the entire ecosystem of customer-facing product content, placing major emphasis on consistency, quality, accuracy, and timeliness
20+
- Create a cohesive and compelling story around our products and their functionality
21+
- Develop content that increases product adoption, deflects support, and makes customers successful
22+
- Partner with various internal departments and stakeholders in creating and sustaining a rich, consistent content experience across all Cloudflare products
23+
- Devise new and better ways to give users the information they need, when and where they need it
2524

2625
Adoption of this content strategy will be impacted by product releases, resourcing, and company goals.
2726

@@ -33,13 +32,13 @@ This approach includes:
3332

3433
### Information architecture
3534

36-
* Where content should live on the site
37-
* Linking strategy
35+
- Where content should live on the site
36+
- Linking strategy
3837

3938
### Content
4039

41-
* What content is included and what is optional
42-
* How the content is written
40+
- What content is included and what is optional
41+
- How the content is written
4342

4443
## Content requirements
4544

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Image maintenance
4+
meta:
5+
title: Image maintenance | How we docs
6+
---
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
pcx_content_type: navigation
3+
title: How we docs
4+
sidebar:
5+
order: 10
6+
---
7+
8+
import { DirectoryListing } from "~/components";
9+
10+
This section shares how Cloudflare approaches docs strategically, covering topics like `how we built our site` and `how we think about redirects`.
11+
12+
The goal is twofold, because it:
13+
14+
- Encourages deep thinking about how we approach things (and if they could be better).
15+
- Contributes back to the open-source ecosystem. We get a lot of benefits from being open source and we want to give back.
16+
17+
We hope you learn from the topics below. As always, [submit an issue](https://github.com/cloudflare/cloudflare-docs/issues/new) if you find something inaccurate or unclear.
18+
19+
<DirectoryListing />
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Links
4+
meta:
5+
title: Links | How we docs
6+
---
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Metadata
4+
meta:
5+
title: Metadata | How we docs
6+
---
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Redirects
4+
meta:
5+
title: Redirects | How we docs
6+
---

0 commit comments

Comments
 (0)