跳转到主要内容

Links

import { Render } from "~/components";

Use the path to the product when creating a link.

Also not supported:

  • Relative links: A link to [`DurableObjectNamespace::get`](./namespace)
  • Using the file extension in links: This is a link for Cloudflare WAN's [Get started](/cloudflare-wan/get-started.mdx/)

Standard text

As much as possible, use text that follows one of these patterns:

  • For more information, refer to [<PAGE_TITLE>](LINK).
  • To <DO_SOMETHING>, refer to [<SECTION_TITLE>](LINK).

Do not use the following constructions:

  • Learn more about...
  • To read more....
  • For more information, refer the [Merge requests](LINK) page.
  • For more information, refer the [Merge requests](LINK) documentation.

The more descriptive your link text, the easier it is for people to navigate your site and for Google to understand what you are linking to.

Practically, this means you should avoid link text like here, this page, or read more.

For example, instead of:

  • For more information, refer to [this page](LINK).
  • For more information, go [here](LINK).

Use:

  • For more information, refer to [set up Cloudflare](LINK).

Follow these additional guidelines for inline paragraph links:

  • Use the actual title of the target page, or an abbreviated version of that title. This helps readers confirm they reached the page they intended to visit.
  • Use unique link text. Speech recognition software does not handle duplicated link text well.
  • Use in-paragraph links only when they are internal to Cloudflare's websites and the material relates directly to what is being described. Consider whether the linked content helps the reader make a decision or accomplish something before continuing to read.
  • Avoid directional language.

Dashboard link text

When directing users to the Cloudflare dashboard, use the following convention:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
2. Go to **DNS** > **Records**.
  • Internal links that loosely relate to the topic or offer a chance for deeper learning
  • All external links (not residing in Cloudflare's websites)
  • Internal and external links that represent the next logical steps to follow

Cross-linking requirements

Cross-links between related pages create a navigable knowledge graph. When an AI system encounters a concept page, it can follow links to find step-by-step instructions, troubleshooting guidance, or reference data and cite the most relevant page for a user's query. Search engines use the same link structure to understand topic relationships.

Every page with a pcx_content_type should include links to related pages in its Related resources section. Use the following table to determine which content types to link to from each page.

Content type Must link to
Concept Related how-to or get-started page; related reference page
How-to Prerequisite concept page; relevant configuration page; troubleshooting page
Get started Next-level how-to pages; product overview page
Troubleshooting Related how-to page; relevant configuration page
Configuration Parent how-to or get-started page; relevant concept page
Reference Related concept page; how-to pages that use the reference
Tutorial Related product overview; prerequisite get-started page

Example

A concept page about DNS records should link to related how-to, troubleshooting, and reference pages:

The corresponding how-to page should link back:

Not every content type will have a matching page for every row in the table. Link to what exists. If a related page does not exist yet, do not create a placeholder link. Instead, consider whether the missing page represents a gap in the doc set that should be addressed.

Use placeholders in links with account- or user-specific information, and explain what to replace the referential text with.

  • For example, for the link "https://api.cloudflare.com/client/v4/accounts/a0b1c2d3/rulesets" use "https://api.cloudflare.com/client/v4/accounts/<ACCOUNTID>/rulesets" and add text to say "replace <ACCOUNTID> with your Account ID" or similar.

Refer to angle brackets in Code conventions and formatting.

Maintenance

For more details on how we handle link maintenance, refer to Link maintenance.

这篇文档对你有帮助吗？
想留言或继续讨论？请到 Cyberforums 赛博论坛参与。 参与讨论 / 回复