Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ sidebar:

---

We follow several formatting conventions for cURL commands.

## Components

To automatically incorporate our conventions into your examples, use:

- [`APIRequest`](/style-guide/components/api-request/): For examples hitting endpoints in the Cloudflare API schema.
- [`CURL`](/style-guide/components/curl/): For other cURL commands.

## Paramter names

Use long parameter names for clarity:

* `--header` (instead of `-H`)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ styleGuide:
component: DirectoryListing
---

Use `<DirectoryListing />` to display the directory of a specific folder, which appears as a list of links.
import { Render } from "~/components";

<Render file="directory-listing-definition" />

We also have an optional `descriptions` parameter which - if present - adds in the text from the [front matter `description`](/style-guide/frontmatter/) field.

Expand All @@ -13,3 +15,7 @@ import { DirectoryListing } from "~/components";

<DirectoryListing folder="workers/wrangler" descriptions />
```

## Associated content types

- [Navigation](/style-guide/documentation-content-strategy/content-types/navigation/)
6 changes: 5 additions & 1 deletion src/content/docs/style-guide/components/github-code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,8 @@ This should be represented as starting `<docs-tag name="no-logging">` and closin

**type**: `object`

Props to pass to the [Expressive Code component](https://expressive-code.com/key-features/code-component/).
Props to pass to the [Expressive Code component](https://expressive-code.com/key-features/code-component/).

## Associated content types

- [Tutorial](/style-guide/documentation-content-strategy/content-types/tutorial/)
6 changes: 5 additions & 1 deletion src/content/docs/style-guide/components/last-reviewed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,8 @@ import { LastReviewed } from "~/components"
title: My Tutorial
updated: 2024-07-01
---
```
```

## Associated content types

- [Tutorial](/style-guide/documentation-content-strategy/content-types/tutorial/)
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,8 @@ styleGuide:
import { ListTutorials } from "~/components";

<ListTutorials />
```
```

## Associated content types

- [Tutorial](/style-guide/documentation-content-strategy/content-types/tutorial/)
12 changes: 11 additions & 1 deletion src/content/docs/style-guide/components/public-stats.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ styleGuide:
component: PublicStats
---

The `PublicStats` component allows you to reference specific values about Cloudflare's network without maintaining those values in multiple files.
import { Render } from "~/components";

<Render file="public-stats-definition" />

Refer to the examples below for more information.

Expand All @@ -23,3 +25,11 @@ Cloudflare also has <PublicStats id="network_peers" />.
If you need more stats or to update these stats, submit a pull request to update [PublicStats.astro](https://github.com/cloudflare/cloudflare-docs/blob/production/src/components/PublicStats.astro)

:::

## Associated content types

The `PublicStats` component is commonly used on the following type of pages:

- [Overview](/style-guide/documentation-content-strategy/content-types/overview/)
- [Reference Architecture](/style-guide/documentation-content-strategy/content-types/reference-architecture/)
- [Reference Architecture Diagrams](/style-guide/documentation-content-strategy/content-types/reference-architecture-diagram/)
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ instructional, straightforward

## content_type

`integration-guide`
```yaml
pcx_content_type: integration-guide
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## Structure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ instructional, straightforward

## content_type

`changelog`
```yaml
pcx_content_type: changelog
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## Ownership

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ instructional, descriptive, approachable, supportive

## content_type

`concept`
```yaml
pcx_content_type: concept
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## Structure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ plain, descriptive, straightforward

## content\_type

`configuration`
```yaml
pcx_content_type: configuration
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## When to use

Expand All @@ -39,46 +43,46 @@ Configurations are useful for parts of the product that are very configuration-i
```

---
weight: xx
weight: xx
pcx_content_type: configuration
---

# Title

Write an overview of the high-level feature here, not more than 2-3 sentences. Outline what users can achieve with it, and if necessary, link to other parts of the docs.

* [Feature 1](/feature-1)
* [Feature 2](/feature-2)
* [Feature 3](/feature-3)

## Feature 1

(Feature 1) allows you to (placeholder). For example, the following configuration (placeholder).

| Setting 1 | Setting 2 | Setting 3 |
| - | - | - |

| - | - | - |

| Value 1 | Value 2 | Value 3 |

## Feature 2

(Feature 2) allows you to (placeholder). For example, the following configuration (placeholder).

| Setting 1 | Setting 2 | Setting 3 |
| - | - | - |

| - | - | - |

| Value 1 | Value 2 | Value 3 |

## Feature 3

(Feature 3) allows you to (placeholder). For example, the following configuration (placeholder).

| Setting 1 | Setting 2 | Setting 3 |
| - | - | - |

| - | - | - |

| Value 1 | Value 2 | Value 3 |
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ instructional, straightforward

## content\_type

`design-guide`
```yaml
pcx_content_type: design-guide
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## Examples

Expand Down Expand Up @@ -57,7 +61,7 @@ meta:
# Design guide title

## Introduction
Provide context to what this guide is going to cover. Ensure you describe the end state of the solution this guide will detail.
Provide context to what this guide is going to cover. Ensure you describe the end state of the solution this guide will detail.

### Who is this for?
This reference architecture is designed for IT or security professionals with some responsibility over or familiarity with their organization’s existing infrastructure. It is useful to have some experience with technologies important to securing hybrid work, including identity providers (IdPs), user directories, single sign on (SSO), endpoint security or management (EPP, XDR, UEM, MDM), firewalls, routers, and point solutions like packet or content inspection hardware, threat prevention, and data loss prevention technologies.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ Guiding, straightforward, educational, authoritative

## content_type

`faq`
```yaml
pcx_content_type: faq
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## Overview

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
pcx_content_type: concept
title: Get started page template
title: Get started

---

Expand All @@ -10,7 +10,11 @@ The purpose of Get started content is to help users go from not using a product

## content\_type

`get-started`
```yaml
pcx_content_type: get-started
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## Structure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ instructional, straightforward

## content\_type

`how-to`
```yaml
pcx_content_type: how-to
```

For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-properties/#pcx_content_type).

## Structure

Expand Down Expand Up @@ -60,11 +64,11 @@ Single procedure how-to
weight: xx
pcx_content_type: how-to
---

# Second-person imperative verb phrase

Context for procedure (optional)

1. Step one
1. Step two
1. Step three
Expand All @@ -81,22 +85,22 @@ How-to with multiple procedures
weight: xx
pcx_content_type: how-to
---

# Second-person imperative verb phrase

Context for procedures on page (optional)

## Second-person imperative verb phrase

1. Step one
1. Step two
1. Step three
1. ...

Next steps sentence - what users should see as the end result and/or actionable next steps.

## Second-person imperative verb phrase

1. Step one
1. Step two
1. Step three
Expand All @@ -113,35 +117,35 @@ How-to with multiple procedures that must be completed in order
weight: xx
pcx_content_type: how-to
---

# Second-person imperative verb phrase

Context for procedures on page (optional)

## 1. Second-person imperative verb phrase

1. Step one
1. Step two
1. Step three
1. ...

Next steps sentence - what users should see as the end result and/or actionable next steps.

## 2. Second-person imperative verb phrase

1. Step one
1. Step two
1. Step three
1. ...

Next steps sentence - what users should see as the end result and/or actionable next steps.

## 3. Second-person imperative verb phrase

1. Step one
1. Step two
1. Step three
1. ...

Next steps sentence - what users should see as the end result and/or actionable next steps.
```
Loading