Skip to content

Commit

Permalink
[Docs Site] Fix-up TabItem labels and icons (#16099)
Browse files Browse the repository at this point in the history
  • Loading branch information
KianNH authored Aug 13, 2024
1 parent 8beee50 commit 825149d
Show file tree
Hide file tree
Showing 198 changed files with 637 additions and 637 deletions.
4 changes: 2 additions & 2 deletions src/content/docs/ai-gateway/configuration/caching.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ We plan on adding semantic search for caching in the future to improve cache hit

## Default configuration

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

To set the default caching configuration in the dashboard:

Expand All @@ -33,7 +33,7 @@ To set the default caching configuration in the dashboard:
4. Enable **Cache Responses**.
5. Change the default caching to whatever value you prefer.

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

To set the default caching configuration using the API:

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/ai-gateway/configuration/rate-limiting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To illustrate this, let us say you had a limit of ten requests per ten minutes,

## Default configuration

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

To set the default rate limiting configuration in the dashboard:

Expand All @@ -30,7 +30,7 @@ To set the default rate limiting configuration in the dashboard:
4. Enable **Rate-limiting**.
5. Adjust the rate, time period, and rate limiting method as desired.

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

To set the default rate limiting configuration using the API:

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/ai-gateway/observability/analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Render, TabItem, Tabs } from "~/components"

## View analytics

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

<Render file="analytics-dashboard" />

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/argo-smart-routing/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { Render, TabItem, Tabs } from "~/components"

Argo Smart Routing is a one-click solution to speed up your global traffic.

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

To enable [Argo Smart Routing](https://dash.cloudflare.com/?to=/:account/:zone/traffic) in the dashboard:

Expand All @@ -25,7 +25,7 @@ To enable [Argo Smart Routing](https://dash.cloudflare.com/?to=/:account/:zone/t

* If you have a billing profile, confirm your billing information.

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

To enable or disable Argo Smart Routing with the API, send a [`PATCH`](/api/operations/argo-smart-routing-patch-argo-smart-routing-setting) request with the `value` parameter set to your desired setting (`"on"` or `"off"`).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ kv_namespaces = [

## 5. Code

<Tabs> <TabItem label="js">
<Tabs> <TabItem label="JavaScript" icon="seti:javascript">
Update `src/index.js` with your Worker code:

```js
Expand Down Expand Up @@ -103,7 +103,7 @@ export default {
};
```

</TabItem> <TabItem label="ts">
</TabItem> <TabItem label="TypeScript" icon="seti:typescript">
Update `src/worker.ts` with your Worker code:

```ts
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/browser-rendering/platform/puppeteer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ npm install @cloudflare/puppeteer --save-dev

Once the [browser binding](/browser-rendering/platform/wrangler/#bindings) is configured and the `@cloudflare/puppeteer` library is installed, Puppeteer can be used in a Worker:

<Tabs> <TabItem label="js">
<Tabs> <TabItem label="JavaScript" icon="seti:javascript">

```js
import puppeteer from "@cloudflare/puppeteer";
Expand All @@ -41,7 +41,7 @@ export default {
};
```

</TabItem> <TabItem label="ts">
</TabItem> <TabItem label="TypeScript" icon="seti:typescript">

```ts
import puppeteer from "@cloudflare/puppeteer";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,14 @@ Most dynamic advertisement operations require that you supply the Cloudflare ID

## Obtain prefix IDs

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
2. Go to **IP Addresses** > **IP Prefixes**.
3. Find the CIDR for which you want the prefix ID, and select the arrow next to it.
4. The prefix ID is the value under **API Tag**. Select **Copy** to add the value to your clipboard.

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

To obtain prefix IDs using the API, refer to the [list prefixes](/api/operations/ip-address-management-prefixes-list-prefixes) operation in the Cloudflare API.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Cache Reserve is a usage-based product and [pricing](#pricing) is detailed below

A paid Cache Reserve Plan is required for the enablement.

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select a domain.
2. Go to **Caching** > **Cache Reserve**.
3. Select **Enable storage sync**.

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

Refer to the [Change Cache Reserve setting API](/api/operations/zone-cache-settings-change-cache-reserve-setting) for more information.

Expand Down Expand Up @@ -195,13 +195,13 @@ You can remove all data stored in Cache Reserve through the dashboard or via API

Be aware that the deletion may take up to 24 hours to complete.

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select a domain.
2. Go to **Caching** > **Cache Reserve**.
3. In **Delete Cache Reserve Data**, select **Delete Storage**.

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

To delete Cache Reserve data via API use the following example requests. For more information, refer to the [API documentation](/api/operations/zone-cache-settings-start-cache-reserve-clear).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Multiple matching cache rules can be combined and applied to the same request. A

## Rule 1

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. Enter a rule name, for instance `bypass everything`.
2. In **When incoming requests match**, select **All incoming requests**.
Expand All @@ -35,7 +35,7 @@ Multiple matching cache rules can be combined and applied to the same request. A

## Rule 2

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. Enter a rule name, for instance `cache all default cacheable extensions`.
2. In **When incoming requests match**, select **Custom filter expression**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ There are several required steps before a custom hostname can become active. For

To create a custom hostname:

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

<Render file="create-custom-hostname" />

<Render file="create-custom-hostname-limitations" />

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

<Render file="create-custom-hostname-api" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ If your customer's domain is not using Cloudflare, you must remove a customer's

This is especially important if your end customers are using Cloudflare because if the custom hostname changes the DNS target to point away from your SaaS zone, the custom hostname will continue to route to your service. This is a result of the [custom hostname priority logic](/ssl/reference/certificate-and-hostname-priority/#hostname-priority-cloudflare-for-saas).

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

<Render file="delete-custom-hostname-dash" />

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

To delete a custom hostname and any issued certificates using the API, send a [`DELETE` request](/api/operations/custom-hostname-for-a-zone-delete-custom-hostname-\(-and-any-issued-ssl-certificates\)).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ Once you [create a new hostname](/cloudflare-for-platforms/cloudflare-for-saas/s

<Render file="txt-validation_preamble" />

<Tabs> <TabItem label="api">
<Tabs> <TabItem label="API">

<Render file="txt-validation_api" />

</TabItem>

<TabItem label="dashboard">
<TabItem label="Dashboard">

<Render file="txt-validation_dashboard" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ All devices you add to the proxy endpoint will be able to access your Cloudflare

<Tabs>

<TabItem label="dashboard">
<TabItem label="Dashboard">

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **Gateway** > **Proxy Endpoints**.

Expand Down Expand Up @@ -68,7 +68,7 @@ https://<SUBDOMAIN>.proxy.cloudflare-gateway.com

</TabItem>

<TabItem label="api">
<TabItem label="API">

1. [Create a proxy endpoint](/api/operations/zero-trust-gateway-proxy-endpoints-create-proxy-endpoint) with the following call:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { Render, TabItem, Tabs } from "~/components"

## Create a new profile

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. In [Zero Trust](https://one.dash.cloudflare.com), go to **Settings** > **WARP Client**.
2. In the **Profile settings** card, select **Create profile**. This will make a copy of the **Default** profile.
Expand All @@ -31,7 +31,7 @@ Your profile will appear in the **Profile settings** list. You can rearrange the

</TabItem>

<TabItem label="api">
<TabItem label="API">

Send a `POST` request to the [Devices endpoint](/api/operations/devices-create-device-settings-policy):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Here are a few scenarios where virtual networks may prove useful:
The following example demonstrates how to add two overlapping IP routes to Cloudflare (`10.128.0.1/32` staging and `10.128.0.1/32` production).

<Tabs>
<TabItem label="dashboard">
<TabItem label="Dashboard">
To route overlapping IPs over virtual networks:

1. First, create two unique virtual networks:
Expand Down Expand Up @@ -162,7 +162,7 @@ The following example demonstrates how to add two overlapping IP routes to Cloud
## Delete a virtual network

<Tabs>
<TabItem label="dashboard">
<TabItem label="Dashboard">
To delete a virtual network:

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **Networks** > **Tunnels** and ensure that no IP routes are assigned to the virtual network you are trying to delete. If your virtual network is in use, delete the route or reassign it to a different virtual network.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { Render, TabItem, Tabs } from "~/components"

## Create a DNS record for the tunnel

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

To create a new DNS record for your tunnel:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { Render, TabItem, Tabs } from "~/components"

## Add a tunnel to a load balancer pool

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

To create a load balancer, refer to the [Load Balancing documentation](/load-balancing/load-balancers/create-load-balancer/). The endpoint address is the subdomain of your tunnel, `<UUID>.cfargotunnel.com`.

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/cloudflare-one/insights/logs/audit-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Authentication audit logs do not capture actions the user takes once they have a

### Identity-based authentication

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

To view logs for identity-based authentication events:

1. In [Zero Trust](https://one.dash.cloudflare.com), go to **Logs** > **Access**.
2. Expand a row to view details such as the login method, the IP address of the user, and more.
3. If a login attempt was blocked, select **View** for information about why Access denied the user access.

</TabItem> <TabItem label="api">
</TabItem> <TabItem label="API">

The [Access authentication logs](/api/operations/access-authentication-logs-get-access-authentication-logs) API endpoint provides a custom URL to export audit log events for your account.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Make sure you have:

First, create [virtual networks](/cloudflare-one/connections/connect-networks/private-net/cloudflared/tunnel-virtual-networks/) corresponding to your dedicated egress IPs.

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **Settings** > **WARP Client**.
2. In **Network locations**, go to **Virtual networks** and select **Manage**.
Expand All @@ -51,7 +51,7 @@ First, create [virtual networks](/cloudflare-one/connections/connect-networks/pr

</TabItem>

<TabItem label="api">
<TabItem label="API">

1. Create a [virtual network](/cloudflare-one/connections/connect-networks/private-net/cloudflared/tunnel-virtual-networks/) corresponding to one of your dedicated egress IPs. We recommend using a name related to the location of the corresponding dedicated egress IP. For example, if your users will egress from the Americas, you can name the virtual network `vnet-AMER`.

Expand All @@ -78,7 +78,7 @@ First, create [virtual networks](/cloudflare-one/connections/connect-networks/pr

After creating your virtual networks, route your private network CIDRs over each virtual network. This ensures that users can reach all services on your network regardless of which egress IP they use.

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. Go to **Networks** > **Tunnels**.
2. Select your tunnel routing `10.0.0.0/8`, then select **Configure**.
Expand All @@ -93,7 +93,7 @@ After creating your virtual networks, route your private network CIDRs over each

</TabItem>

<TabItem label="api">
<TabItem label="API">

1. Assign your first virtual network to your private network route. For example, assign `vnet-AMER` to your tunnel that routes `10.0.0.0/8`:

Expand Down Expand Up @@ -144,7 +144,7 @@ Each tunnel connected to your private network should have each of your virtual n

Next, assign your dedicated egress IPs to each virtual network using Gateway egress policies.

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **Gateway** > **Egress Policies**.

Expand All @@ -166,7 +166,7 @@ Next, assign your dedicated egress IPs to each virtual network using Gateway egr

</TabItem>

<TabItem label="api">
<TabItem label="API">

1. Add a Gateway egress policy that matches the corresponding virtual network. For example:

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/d1/examples/d1-and-remix.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following example shows you how to define a Remix [`loader`](https://remix.r
* Bindings are passed through on the `context.env` parameter passed to a `LoaderFunction`.
* If you configured a [binding](/pages/functions/bindings/#d1-databases) named `DB`, then you would access D1's [client API](/d1/build-with-d1/d1-client-api/#query-statement-methods) methods via `context.env.DB`.

<Tabs> <TabItem label="ts">
<Tabs> <TabItem label="TypeScript" icon="seti:typescript">

```ts
import type { LoaderFunction } from "@remix-run/cloudflare";
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/d1/examples/d1-and-sveltekit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following example shows you how to create a server endpoint configured to qu

The example also shows you how to configure both your app-wide types within `src/app.d.ts` to recognize your `D1Database` binding, import the `@sveltejs/adapter-cloudflare` adapter into `svelte.config.js`, and configure it to apply to all of your routes.

<Tabs> <TabItem label="ts">
<Tabs> <TabItem label="TypeScript" icon="seti:typescript">

```ts
import type { RequestHandler } from "@sveltejs/kit";
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/data-localization/how-to/cache.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In the following sections, we will give you some details about how to configure

To configure Regional Services for hostnames [proxied](/dns/manage-dns-records/reference/proxied-dns-records/) through Cloudflare and ensure that [eligible assets](/cache/concepts/default-cache-behavior/) are cached only in-region, follow these steps for the dashboard or API configuration:

<Tabs> <TabItem label="dashboard">
<Tabs> <TabItem label="Dashboard">

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select an account and zone.
2. Go to the **DNS** tab.
Expand All @@ -24,7 +24,7 @@ To configure Regional Services for hostnames [proxied](/dns/manage-dns-records/r

</TabItem>

<TabItem label="api">
<TabItem label="API">

1. To create records with the API, use the [API POST](/api/operations/dns-records-for-a-zone-create-dns-record) command.
2. Run the [API POST](/data-localization/regional-services/get-started/#configure-regional-services-via-api) command on the hostname to create a `regional_hostnames` with a specific region.
Expand Down
Loading

0 comments on commit 825149d

Please sign in to comment.