Reference

Purpose

The purpose of reference content is to provide supplemental information for further learning on settings, values, or options. While reference information is helpful for users, reference information should not block or prevent users from completing tasks.

Tone

plain, straightforward

content_type

pcx_content_type: reference

For more details, refer to pcx_content_type.

Structure

Required components

Title: For a single Reference page, use "Reference" as the title. For a reference section with child pages, use nouns in the title. For example, Common Cf-Polished statuses ↗.

Context: Provide an introductory paragraph to explain how and why a user might utilize the information on this page.

Optional components

Code snippets: Examples of API responses or commands to run certain tasks.

Dynamic Lists: Long lists of fields (more than 20).

Examples: Code samples that reference a specific configuration or API call.

Notes/tips/warnings: Relevant information that can help or simplify concepts or warn users of potential impacts.

Screenshots: Images of a completed configuration for complicated tasks.

Tables: Longer lists of features and an associated number value or terms and their definitions.

Examples

Cache: Common Cf-Polished statuses

Logpush: Logpush API configuration

Template

Single reference page

---
weight: xx
pcx_content_type: reference
---

# Reference

Write an overview of the reference information on this page. If this section has child pages, add navigation links below using the DirectoryListing snippet to add links for each child page in a bulleted list.

<DirectoryListing path="/reference"/>

## Concise noun title

Brief description of content in this section.

## Concise noun title

Brief description of content in this section.