Skip to content

Commit

Permalink
[Style Guide] Link to Cloudflare dashboard convention (#17362)
Browse files Browse the repository at this point in the history
* Placeholder PR for using deep links

* Adding in agreed convention for linking to Cloudflare dashboard.
  • Loading branch information
Oxyjun authored Oct 7, 2024
1 parent 07f253b commit 81acb51
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions src/content/docs/style-guide/formatting/structure/links.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Follow these guidelines for link 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).`
- `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.`
- `Learn more about...`
- `To read more....`
- `For more information, refer the [Merge requests](LINK) page.`
- `For more information, refer the [Merge requests](LINK) documentation.`

## Descriptive link text

Expand All @@ -28,9 +28,19 @@ Practically, this means you should avoid link text like `here`, `this page`, or

For example, instead of:

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

Use:

* `For more information, refer to [set up Cloudflare](LINK).`
- `For more information, refer to [set up Cloudflare](LINK).`

## Dashboard link text

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

```text
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
2. Go to **DNS** > **Records**.
```

0 comments on commit 81acb51

Please sign in to comment.