Skip to content

Commit 438f421

Browse files
Refine documentation for clarity and consistency (#22432)
* Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Apply suggestions from code review --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> Co-authored-by: Kody Jackson <[email protected]>
1 parent fbd7680 commit 438f421

File tree

9 files changed

+17
-17
lines changed

9 files changed

+17
-17
lines changed

src/content/docs/1.1.1.1/faq.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ Below you will find answers to our most commonly asked questions. If you cannot
1717

1818
1.1.1.1 is Cloudflare's fast and secure DNS resolver. When you request to visit an application like `cloudflare.com`, your computer needs to know which server to connect you to so that it can load the application. Computers don't know how to do this name to address translation, so they ask a specialized server to do it for them.
1919

20-
This specialized server is called a DNS recursive resolver. The resolvers job is to find the address for a given name, like `2400:cb00:2048:1::c629:d7a2` for `cloudflare.com`, and return it to the computer that asked for it.
20+
This specialized server is called a DNS recursive resolver. The resolver's job is to find the address for a given name, like `2400:cb00:2048:1::c629:d7a2` for `cloudflare.com`, and return it to the computer that asked for it.
2121

22-
Computers are configured to talk to specific DNS resolvers, identified by IP address. Usually the configuration is managed by your ISP (like Comcast or AT\&T) if you are on your home or wireless Internet, and by your network administrator if you’re connected to the office Internet. You can also change the configured DNS resolver your computer talks to yourself.
22+
Computers are configured to talk to specific DNS resolvers, identified by IP address. Usually the configuration is managed by your ISP (like Comcast or AT\&T) if you are on your home or wireless Internet, and by your network administrator if you are connected to the office Internet. You can also change the configured DNS resolver your computer talks to yourself.
2323

2424

2525
## How can I check if my computer / smartphone / tablet is connected to 1.1.1.1?

src/content/docs/ai-gateway/guardrails/set-up-guardrail.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ When a request is blocked by guardrails, you will receive a structured error res
3434
- `"code": 2016`
3535
- `"message": "Prompt blocked due to security configurations"`
3636

37-
- **Response blocked**
37+
- **Response blocked**
3838
- `"code": 2017`
3939
- `"message": "Response blocked due to security configurations"`
4040

src/content/docs/ai-gateway/universal.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You can use the Universal endpoint to contact every provider. The payload is exp
1919

2020
- `provider` : the name of the provider you would like to direct this message to. Can be OpenAI, workers-ai, or any of our supported providers.
2121
- `endpoint`: the pathname of the provider API you’re trying to reach. For example, on OpenAI it can be `chat/completions`, and for Workers AI this might be [`@cf/meta/llama-3.1-8b-instruct`](/workers-ai/models/llama-3.1-8b-instruct/). See more in the sections that are specific to [each provider](/ai-gateway/providers/).
22-
- `authorization`: the content of the Authorization HTTP Header that should be used when contacting this provider. This usually starts with "Token" or "Bearer".
22+
- `authorization`: the content of the Authorization HTTP Header that should be used when contacting this provider. This usually starts with 'Token' or 'Bearer'.
2323
- `query`: the payload as the provider expects it in their official API.
2424

2525
## cURL example

src/content/docs/analytics/account-and-zone-analytics/account-analytics.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Cloudflare account analytics lets you access a wide range of aggregated metrics
1111

1212
:::note
1313

14-
For general information about all of Cloudflare's analytics offerings, refer to [About Cloudflare Analytics](/analytics/faq/about-analytics/).
14+
For general information about all of Cloudflare's analytics offerings, refer to [About Cloudflare Analytics](/analytics/faq/about-analytics/).
1515
:::
1616

1717
***
@@ -32,7 +32,7 @@ Once it loads, the Account Analytics app displays a collection of categorized ch
3232

3333
## Review your account metrics
3434

35-
This section outlines the aggregated metrics under each category.  Before reviewing your metrics, lets define a couple of concepts used in some panels:
35+
This section outlines the aggregated metrics under each category. Before reviewing your metrics, let's define a couple of concepts used in some panels:
3636

3737
* *Rate* -  Reflects the ratio between the amount for a specific data category and the total.
3838
* *Bandwidth* - Refers to the number of bytes sent from the Cloudflare edge network to the requesting client.

src/content/docs/analytics/account-and-zone-analytics/analytics-with-workers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ title: Cloudflare analytics with Workers
77

88
Learn how Cloudflare analytics tracks requests made by [Cloudflare Workers](/workers/).
99

10-
## What is a subrequest?
10+
## What is a subrequest
1111

12-
With a no-op Worker (a Worker that simply proxies traffic by passing on the original client request to the origin and proxying the response) running on a particular route, the request to the origin is counted as a subrequest, separate from initial client to edge request. Thus, unless the Worker responds with a static response and never hits an origin, the eyeball → edge request, and edge → origin request will each be counted separately towards the request or bandwidth count in Analytics.  Subrequests are not included in the **Requests** or **Bandwidth** graphs of the Cloudflare **Analytics** app.
12+
With a no-op Worker (a Worker that simply proxies traffic by passing on the original client request to the origin and proxying the response) running on a particular route, the request to the origin is counted as a 'subrequest', separate from initial client to edge request. Thus, unless the Worker responds with a static response and never hits an origin, the eyeball → edge request, and edge → origin request will each be counted separately towards the request or bandwidth count in Analytics. Subrequests are not included in the **Requests** or **Bandwidth** graphs of the Cloudflare **Analytics** app.
1313

1414
***
1515

@@ -29,7 +29,7 @@ For a breakdown of subrequest traffic (origin facing traffic), you may go to the
2929

3030
## FAQ
3131

32-
**Why dont I have any analytics for Workers?**
32+
**Why don't I have any analytics for Workers?**
3333

3434
* If you are not currently using Workers (don’t have Workers deployed on any routes or filters), we will not have any information to show you.
3535
* If your Worker sends a static response back to the client without ever calling fetch() to an origin, you are not making any subrequests, thus, all traffic will be shown in zone Analytics

src/content/docs/analytics/account-and-zone-analytics/status-codes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Status codes
77

88
:::note
99

10-
Status Codes analytics by data center is exclusive to the [enterprise level of service](https://www.cloudflare.com/plans/enterprise/contact/).
10+
Status Codes analytics by data center is exclusive to the [enterprise level of service](https://www.cloudflare.com/plans/enterprise/contact/).
1111
:::
1212

1313
Status Codes metrics in the Cloudflare dashboard **Analytics** app provide customers with a deeper insight into the distribution of errors that are occurring on their website per data center. A data center facility is where Cloudflare runs its servers that make up our edge network ([current locations](https://www.cloudflare.com/network/)).
@@ -59,7 +59,7 @@ For more information, refer to [4xx Client Error](/support/troubleshooting/http-
5959
- `522` - Our edge could not establish a TCP connection to the origin server.
6060
- `523` - Origin server is unreachable (for example, the origin IP changed but DNS was not updated, or due to network issues between our edge and the origin).
6161
- `524` - Our edge established a TCP connection, but the origin did not reply with a HTTP response before the connection timed out.
62-
- `525` - This error indicates that the SSL handshake between Cloudflare and the origin web server failed, either due to a network issue or a certificare issue at the origin.
62+
- `525` - This error indicates that the SSL handshake between Cloudflare and the origin web server failed, either due to a network issue or a certificate issue at the origin.
6363
- `526` - The certificate configured at the origin is not valid.
6464

6565
For more information, refer to [Troubleshooting Cloudflare 5XX errors](/support/troubleshooting/http-status-codes/cloudflare-5xx-errors/).

src/content/docs/analytics/account-and-zone-analytics/threat-types.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ source: https://support.cloudflare.com/hc/en-us/articles/204191238-What-are-the-
44
title: Threat types
55
---
66

7-
Cloudflare classifies the threats that it blocks or challenges. To help you understand more about your site’s traffic, the Type of Threats Mitigated metric on the analytics page measures threats blocked or challenged by the following categories:
7+
Cloudflare classifies the threats that it blocks or challenges. To help you understand more about your site’s traffic, the 'Type of Threats Mitigated' metric on the analytics page measures threats blocked or challenged by the following categories:
88

99
## Bad browser
1010

@@ -14,7 +14,7 @@ Cloudflare's [Browser Integrity Check](/waf/tools/browser-integrity-check/) look
1414

1515
## Blocked hotlink
1616

17-
[Hotlink Protection](/waf/tools/scrape-shield/hotlink-protection/) ensures that other sites cannot use your bandwidth by building pages that link to images hosted on your origin server. This feature can be turned on and off by Cloudflares customers.
17+
[Hotlink Protection](/waf/tools/scrape-shield/hotlink-protection/) ensures that other sites cannot use your bandwidth by building pages that link to images hosted on your origin server. This feature can be turned on and off by Cloudflare's customers.
1818

1919
## Human challenged
2020

@@ -52,7 +52,7 @@ A /24 IP range that was blocked based on the [user configuration](/waf/tools/ip-
5252

5353
## New Challenge (user)
5454

55-
[Challenge](/cloudflare-challenges/) based on user configurations set for visitors IP in either WAF managed rules or custom rules, configured in **Security** > **WAF**.
55+
[Challenge](/cloudflare-challenges/) based on user configurations set for visitor's IP in either WAF managed rules or custom rules, configured in **Security** > **WAF**.
5656

5757
## Challenge error
5858

src/content/docs/analytics/account-and-zone-analytics/total-threats-stopped.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ source: https://support.cloudflare.com/hc/en-us/articles/204964927-How-does-Clou
44
title: Total threats stopped
55
---
66

7-
Total Threats Stopped measures the number of suspicious and bad requests that were aimed at your site. Requests receive these labels as they enter Cloudflares network:
7+
Total Threats Stopped measures the number of 'suspicious' and 'bad' requests that were aimed at your site. Requests receive these labels as they enter Cloudflare's network:
88

99
- **Legitimate:** Request passed directly to your site.
1010
- **Suspicious:** Request has been challenged with a [Cloudflare challenge](/cloudflare-challenges/).

src/content/docs/analytics/account-and-zone-analytics/zone-analytics.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Once it loads, you can find tabs for **Traffic**, **Security**, **Performance**,
3939
This section outlines the metrics available under each Analytics app tab. Before proceeding, note that each tab may contain:
4040

4141
* One or more panels to further categorize the underlying metrics.
42-
* A dropdown (on the panels top right) to filter metrics for a specific time period. The time period you can select may vary based on the Cloudflare plan that your domain is associated with.
42+
* A dropdown (on the panel's top right) to filter metrics for a specific time period. The time period you can select may vary based on the Cloudflare plan that your domain is associated with.
4343

4444
Below is a summary of each Analytics app tab.
4545

@@ -60,7 +60,7 @@ Privacy-first Web Traffic Analytics are available on the Pro, Business,
6060
and Enterprise plans.
6161
:::
6262

63-
Analytics are based on Cloudflares edge logs, with no need for third party scripts or trackers. The Traffic tab features the following metrics:
63+
Analytics are based on Cloudflare's edge logs, with no need for third party scripts or trackers. The Traffic tab features the following metrics:
6464

6565
* **Requests** - An HTTP request. A typical page view requires many requests. If you are using Cloudflare Workers, subrequests data will not be visible in zone Traffic Analytics. Instead, you can find subrequests analytics under the **Workers & Pages** tab in the **Overview** section. Refer to [Worker Analytics](/analytics/account-and-zone-analytics/analytics-with-workers/#worker-analytics) for more information.
6666
* **Data Transfer** - Total HTTP data transferred in responses.

0 commit comments

Comments
 (0)