Skip to content

Commit dacd0c5

Browse files
Oxyjunmaheshwarip
authored andcommitted
[Style Guide] Link to Cloudflare dashboard convention (#17362)
* Placeholder PR for using deep links * Adding in agreed convention for linking to Cloudflare dashboard.
1 parent dfbbc57 commit dacd0c5

File tree

1 file changed

+19
-9
lines changed
  • src/content/docs/style-guide/formatting/structure

1 file changed

+19
-9
lines changed

src/content/docs/style-guide/formatting/structure/links.mdx

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ Follow these guidelines for link text.
1010

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

13-
* `For more information, refer to [<PAGE_TITLE>](LINK).`
14-
* `To <DO_SOMETHING>, refer to [<SECTION_TITLE>](LINK).`
13+
- `For more information, refer to [<PAGE_TITLE>](LINK).`
14+
- `To <DO_SOMETHING>, refer to [<SECTION_TITLE>](LINK).`
1515

1616
Do not use the following constructions:
1717

18-
* `Learn more about...`
19-
* `To read more....`
20-
* `For more information, refer the [Merge requests](LINK) page.`
21-
* `For more information, refer the [Merge requests](LINK) documentation.`
18+
- `Learn more about...`
19+
- `To read more....`
20+
- `For more information, refer the [Merge requests](LINK) page.`
21+
- `For more information, refer the [Merge requests](LINK) documentation.`
2222

2323
## Descriptive link text
2424

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

2929
For example, instead of:
3030

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

3434
Use:
3535

36-
* `For more information, refer to [set up Cloudflare](LINK).`
36+
- `For more information, refer to [set up Cloudflare](LINK).`
37+
38+
## Dashboard link text
39+
40+
When directing users to the Cloudflare dashboard, use the following convention:
41+
42+
```text
43+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
44+
2. Go to **DNS** > **Records**.
45+
```
46+

0 commit comments

Comments
 (0)