Skip to content

Commit a0f8335

Browse files
hyperlint-ai[bot]dcpena
authored andcommitted
Improve API and documentation clarity (#22181)
* 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 * Undoing a hyperlint suggestion * Removed extra punctuation and letter * Undoing hyperlint suggestion --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> Co-authored-by: Denise Peña <[email protected]>
1 parent 9747aa4 commit a0f8335

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

src/content/docs/fundamentals/api/how-to/make-api-calls.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Sometimes there will be too many results to display via the default page size, f
6464
"total_count": 200,
6565
```
6666

67-
There are two query parameter options, which can be combined to paginate across the results.
67+
Two query parameter options exist, which can be combined to paginate across the results.
6868

6969
- `page=x` enables you to select a specific page.
7070
- `per_page=xx` enables you to adjust the number of results displayed on a page. If you select too many, you may get a timeout.

src/content/docs/fundamentals/changelog.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ With the version 5 release of Cloudflare's Terraform Provider, Terraform resourc
1919

2020
Warning: Version 5 of the Cloudflare Terraform Provider is a ground-up rewrite of the provider and introduces breaking changes.
2121

22-
Refer to the [upgrade guide](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/guides/version-5-upgrade) for best practices, or the [blog post on automatically generating Cloudflares Terraform Provider](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more information.
22+
Refer to the [upgrade guide](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/guides/version-5-upgrade) for best practices, or the [blog post on automatically generating Cloudflare's Terraform Provider](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more information.
2323

2424
## 2024-12-18
2525

@@ -67,4 +67,4 @@ Refer to the [Terraform documentation](https://registry.terraform.io/providers/c
6767

6868
Cloudflare's API documentation is now [available in preview](/api/) with new automatically generated documentation. This documentation includes code snippets that refer to language-specific SDKs to make it easier to get started than ever.
6969

70-
Refer to the [blog post](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more details.
70+
Refer to the [blog post](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more details.

src/content/docs/fundamentals/reference/cloudflare-ray-id.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ A **Cloudflare Ray ID** is an identifier given to every request that goes throug
77

88
Ray IDs are particularly useful when evaluating Security Events for patterns or false positives or more generally understanding your application traffic.
99

10-
Ray IDs are added as a [request header, cf-ray](/fundamentals/reference/http-headers/#cf-ray), to the connection from Cloudflare to the origin web server.
10+
Ray IDs are added as a [request header, cf-ray](/fundamentals/reference/http-headers/#cf-ray), to the connection from Cloudflare to the origin web server.
1111
As such the Ray IDs can be found using the Developer Tools in your browser or using curl with the `-v` option to show the headers.
1212

1313

src/content/docs/fundamentals/reference/policies-compliances/cloudflare-cookies.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Currently Cloudflare only supports Session Affinity in "orange-cloud" (proxied)
3030

3131
Cloudflare's [bot products](/bots/) identify and mitigate automated traffic to protect your site from bad bots. Cloudflare places the `__cf_bm` cookie on end-user devices that access customer sites protected by Bot Management or Bot Fight Mode. The `__cf_bm` cookie is necessary for these bot solutions to function properly.
3232

33-
This cookie expires after 30 minutes of continuous inactivity by the end user. The cookie contains information related to the calculation of Cloudflares proprietary bot score and, when Anomaly Detection is enabled on Bot Management, a session identifier. The information in the cookie (other than time-related information) is encrypted and can only be decrypted by Cloudflare.
33+
This cookie expires after 30 minutes of continuous inactivity by the end user. The cookie contains information related to the calculation of Cloudflare's proprietary bot score and, when Anomaly Detection is enabled on Bot Management, a session identifier. The information in the cookie (other than time-related information) is encrypted and can only be decrypted by Cloudflare.
3434

3535
A separate `__cf_bm` cookie is generated for each site that an end user visits, as Cloudflare does not track users from site to site or from session to session. The `__cf_bm` cookie is generated independently by Cloudflare, and does not correspond to any user ID or other identifiers in a customer’s web application.
3636

@@ -60,7 +60,7 @@ The `cf_use_ob` cookie informs Cloudflare to fetch the requested resource from t
6060

6161
### \_\_cfwaitingroom for Cloudflare Waiting Room
6262

63-
[Cloudflares Waiting Room](/waiting-room/) product enables a waiting room for a particular host and path combination within a zone. Visitors are put in the waiting room and provided an estimate of when they will be allowed to access the application, if not immediately available.
63+
[Cloudflare's Waiting Room](/waiting-room/) product enables a waiting room for a particular host and path combination within a zone. Visitors are put in the waiting room and provided an estimate of when they will be allowed to access the application, if not immediately available.
6464

6565
The `__cfwaitingroom` cookie is only used to track visitors that access a waiting room enabled host and path combination for a zone. Visitors using a browser that does not accept cookies cannot visit the host and path combination while the waiting room is active. For more details, refer to [Waiting Room cookies](/waiting-room/reference/waiting-room-cookie/).
6666

src/content/docs/fundamentals/reference/policies-compliances/content-security-policies.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To learn more about configuring a CSP in general, refer to the [Mozilla document
1717

1818
## Using a CSP with Cloudflare
1919

20-
Cloudflares [CDN](/cache/) is compatible with CSP.
20+
Cloudflare's [CDN](/cache/) is compatible with CSP.
2121

2222
Cloudflare does not:
2323

src/content/docs/fundamentals/reference/policies-compliances/cybersafe.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Project Cybersafe Schools grants eligible schools with free access to Cloudflare
1414

1515
## Children’s Internet Protection Act (CIPA)
1616

17-
<Render file="cybersafe-description" product="fundamentals" />
17+
<Render file='cybersafe-description' product='fundamentals' />
1818

1919
### CIPA Requirements
2020

src/content/docs/fundamentals/reference/policies-compliances/delivering-videos-with-cloudflare.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,17 @@ Cloudflare permits the delivery of video content with specific paid services. If
3535

3636
[Stream](https://www.cloudflare.com/products/cloudflare-stream/) is a video-on-demand platform for building video applications. Stream encodes, stores, and delivers optimized video formatted for different devices and network connections.
3737

38-
To get started with Stream, visit **Stream** from your Dashboard or [sign up](https://dash.cloudflare.com/sign-up/stream). Your Stream videos are not attached to a domain in your Cloudflare account, and you don't need a domain on Cloudflare to use Stream.
38+
To get started with Stream, visit **Stream** from your Dashboard or [sign up](https://dash.cloudflare.com/sign-up/stream). Your Stream videos are not attached to a domain in your Cloudflare account, and you do not need a domain on Cloudflare to use Stream.
3939

4040
### Option 2: Stream Delivery (Enterprise only)
4141

42-
[Stream Delivery](https://www.cloudflare.com/products/stream-delivery/) offers caching and delivery of video content through Cloudflare data centers around the globe. This CDN feature is only available on the Cloudflare Enterprise Plan. Please [contact sales](https://www.cloudflare.com/products/stream-delivery/#) if youd like to explore this option.
42+
[Stream Delivery](https://www.cloudflare.com/products/stream-delivery/) offers caching and delivery of video content through Cloudflare data centers around the globe. This CDN feature is only available on the Cloudflare Enterprise Plan. Please [contact sales](https://www.cloudflare.com/products/stream-delivery/#) if you'd like to explore this option.
4343

4444
***
4545

4646
## Getting information on the content you are delivering
4747

48-
If you need more information about the content your zone is serving (e.g. content type), you can use the following tools:
48+
If you need more information about the content your zone is serving (for example, content type), you can use the following tools:
4949

5050
* Cache Analytics users: Open the **Caching tab** on the Dashboard to filter by content type and identify the type of traffic you are transferring.
5151
* Users without Cache Analytics: Open the **Analytics tab** on the Dashboard and select the **Performance** section for information about the content you are serving.

src/content/docs/fundamentals/reference/report-abuse/provide-specific-urls.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ To get the URL for a specific piece of content on a webpage:
2929

3030
6. Copy the URL.
3131

32-
This is typically the most specific and helpful URL that someone reporting abuse can provide to Cloudflare, so that Cloudflare can correctly identify any services Cloudflare may be providing with respect to that content.
32+
Providing the most specific and helpful URL enables Cloudflare to correctly identify any services it may be providing with respect to that content.
3333

3434
## Submitting the abuse report
3535

36-
Once you have identified the URL for the specific asset, you can [submit an abuse report](https://abuse.cloudflare.com) through Cloudflares online abuse reporting process.
36+
Once you have identified the URL for the specific asset, you can [submit an abuse report](https://abuse.cloudflare.com) through Cloudflare's online abuse reporting process.
3737

3838
You can learn more about the process, and what you can expect from Cloudflare in response to such abuse reports, from [our abuse policy](https://www.cloudflare.com/trust-hub/reporting-abuse/).

src/content/docs/fundamentals/reference/scans-penetration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Targets like `*.cloudflare.com` or other Cloudflare-owned destinations are only
2424
### Penetration testing
2525

2626
- **Network behavior**:
27-
- Cloudflare's [anycast network](/fundamentals/concepts/how-cloudflare-works/) will report ports other than `80` and `443` as open due to its shared infrastructure and the nature of Cloudflare's proxy. This is expected behavior and does not indicate a vulnerability.
27+
- Cloudflare's [anycast network](/fundamentals/concepts/how-cloudflare-works/) will report ports other than `80` and `443` as open due to its shared infrastructure and the nature of Cloudflare's proxy. The reporting is expected behavior and does not indicate a vulnerability.
2828
- Tools like Netcat may list [non-standard HTTP ports](/fundamentals/reference/network-ports/) as open; however, these ports are open solely for Cloudflare's routing purposes and do not necessarily indicate that a connection can be established with the customer's origin over those ports.
2929
- **Known false positives**: Any findings related to the [ROBOT vulnerability](/ssl/reference/compliance-and-vulnerabilities/#return-of-bleichenbachers-oracle-threat-robot) are false positives when the customer's assets are behind Cloudflare.
3030
- **Customer security review**: During penetration testing, customers should be aware of the Cloudflare security and performance features, configurations, and rules active on their account or zone. After completing the test, it is recommended that customers review their security posture and make any necessary adjustments based on the findings.

src/content/docs/fundamentals/security/cloudflare-challenges/challenge-solve-issues.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Most challenges are quick and should take only a few seconds to complete. If it
2323
:::note
2424
If the issue persists, try switching to a different network or device to rule out any issues with your browser environment.
2525

26-
Make sure that your browser is updated to the latest version.
26+
Ensure your browser is updated to the latest version to maintain compatibility.
2727
:::
2828

2929
## Troubleshooting
@@ -32,4 +32,4 @@ Follow the steps below to ensure that your environment is properly configured.
3232

3333
<Render file="troubleshooting-steps" product="turnstile"/>
3434

35-
If none of the above resolves your issue, contact the website administrator with the [error code](/turnstile/troubleshooting/client-side-errors/error-codes/) and Ray ID or submit a [feedback report](/turnstile/troubleshooting/feedback-reports/) through the Turnstile widget by selecting **Submit Feedback**.
35+
If none of the above resolves your issue, contact the website administrator with the [error code](/turnstile/troubleshooting/client-side-errors/error-codes/) and Ray ID or submit a [feedback report](/turnstile/troubleshooting/feedback-reports/) through the Turnstile widget by selecting **Submit Feedback**.

0 commit comments

Comments
 (0)