Skip to content

Commit b3fe8e2

Browse files
committed
Updating style guide as well
1 parent 109650a commit b3fe8e2

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/content/docs/style-guide/components/dash-button.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ import AvailableDashRoutes from "~/components/AvailableDashRoutes.astro";
88

99
This component creates a [LinkButton](/style-guide/components/buttons/) that links to a Cloudflare dashboard deeplink.
1010

11+
While we recommend the use of `DashButton`, you can continue to use deeplinks (as a link, without the component), if necessary.
12+
13+
:::note[Where routes are stored]
14+
The list of available routes are generated by running a script that we manually trigger periodically. The script outputs the available paths in [`src/content/dash-routes/index.json`](https://github.com/cloudflare/cloudflare-docs/blob/production/src/content/dash-routes/index.json).
15+
16+
The `DashButton` component then uses those routes to automatically generate the list of buttons on this page. The `DashButton` will fail to build if you edit the `url` prop to a route that is not listed in the `index.json` file.
17+
18+
Additionally, each run of the script overwrites the previous `/dash-routes/index.json` file. If you edit the this file manually, it will be overwritten in the next run of the script.
19+
20+
Therefore, only make manual changes to this file if both of the following are true:
21+
22+
- The link is already live in the dashboard.
23+
- The name-change is confirmed, and there's no (or little) chance of rollback.
24+
:::
25+
1126
## Import
1227

1328
```mdx live

0 commit comments

Comments
 (0)