Skip to content

Commit 82f0a3b

Browse files
Update API Documentation and Fix Minor Issues (#22308)
* 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 * Update src/content/docs/bots/reference/sample-terms.mdx --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> Co-authored-by: Kody Jackson <[email protected]>
1 parent 7916cab commit 82f0a3b

File tree

10 files changed

+18
-17
lines changed

10 files changed

+18
-17
lines changed

src/content/docs/ai-gateway/observability/logging/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,4 @@ See full list of available filters and their descriptions below:
8585
8686
### API deletion
8787
88-
You can programmatically delete logs using the AI Gateway API. For more comprehensive information on the `DELETE` logs endpoint, check out the [Cloudflare API documentation](https://developers.cloudflare.com/api/resources/ai_gateway/subresources/logs/methods/delete/).
88+
You can programmatically delete logs using the AI Gateway API. For more comprehensive information on the `DELETE` logs endpoint, check out the [Cloudflare API documentation](/api/resources/ai_gateway/subresources/logs/methods/delete/).

src/content/docs/ai-gateway/observability/logging/logpush.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ We employ a hybrid encryption model efficiency and security. Initially, an AES k
2626

2727
Now, for securely sharing this AES key, we use RSA encryption. Here's what happens: the AES key, although lightweight, needs to be transmitted securely to the recipient. We encrypt this key with the recipient's RSA public key. This step leverages RSA's strength in secure key distribution, ensuring that only someone with the corresponding RSA private key can decrypt and use the AES key.
2828

29-
Once encrypted, both the AES-encrypted data and the RSA-encrypted AES key are sent together. Upon arrival, the recipient's system uses the RSA private key to decrypt the AES key. With the AES key now accessible, it's straightforward to decrypt the main data payload.
29+
Once encrypted, both the AES-encrypted data and the RSA-encrypted AES key are sent together. Upon arrival, the recipient's system uses the RSA private key to decrypt the AES key. With the AES key now accessible, it is straightforward to decrypt the main data payload.
3030

3131
This method combines the best of both worlds: the efficiency of AES for data encryption with the secure key exchange capabilities of RSA, ensuring data integrity, confidentiality, and performance are all optimally maintained throughout the data lifecycle.
3232

src/content/docs/analytics/graphql-api/features/discovery/settings.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Every subnode of `settings` node could consist of these fields:
4242

4343
* `enabled` - shows whether the node is available for a requester or not;
4444
* `availableFields` - shows the list of fields available for a requester. If
45-
it's a nested field, the path will be returned, like `sum_requests`;
45+
it is a nested field, the path will be returned, like `sum_requests`;
4646
* `maxPageSize` - retrieves the maximum number of records that can be returned
4747
* `maxNumberOfFields` - answers on how many fields could be used in a single
4848
query for that node;

src/content/docs/automatic-platform-optimization/troubleshooting/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77

88
## Do I still need to create "Edge Cache TTL" page rules with "Cache Level: Cache Everything"?
99

10-
No, you don't need create Edge Cache TTL page rules. When the WordPress plugin is installed, APO automatically caches content for 30 days and invalidates on change within 30 seconds. However, because APO now supports cache-related page rules, make sure existing page rules don't affect the resources served by APO.
10+
No, you do not need create Edge Cache TTL page rules. When the WordPress plugin is installed, APO automatically caches content for 30 days and invalidates on change within 30 seconds. However, because APO now supports cache-related page rules, make sure existing page rules do not affect the resources served by APO.
1111

1212
## Does Origin Cache Control override APO?
1313

src/content/docs/automatic-platform-optimization/troubleshooting/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The WordPress plugin may go undetected on your Cloudflare dashboard for a few re
1717
* WordPress only runs on a subdomain, but WordPress and the WordPress plugin check against the apex domain.
1818
* **Solution:** For additional information, see [Subdomains and subdirectories](/automatic-platform-optimization/reference/subdomain-subdirectories/)
1919

20-
If your Cloudflare dashboard can't detect the WordPress plugin after trying the solutions above, ensure you completed all of the steps listed in [Activate the Cloudflare WordPress plugin](/automatic-platform-optimization/get-started/activate-cf-wp-plugin/).
20+
If your Cloudflare dashboard cannot detect the WordPress plugin after trying the solutions above, ensure you completed all of the steps listed in [Activate the Cloudflare WordPress plugin](/automatic-platform-optimization/get-started/activate-cf-wp-plugin/).
2121

2222
:::note
2323

src/content/docs/bots/reference/sample-terms.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ Cloudflare recommends that customers consider updating their Terms of Service to
1717
This language is provided for informational purposes only. It does not constitute legal advice, nor does it guarantee any specific outcome.
1818

1919
This is an illustrative example of language that can be included in a website's terms to put AI providers on notice that they are not authorized to use automated means to scrape content from your website for purposes of training or otherwise contributing to their AI models or systems, unless you have expressly permitted them to do so in your `robots.txt` file.
20-
:::
20+
:::
21+

src/content/docs/bots/troubleshooting/frequently-asked-questions.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Cloudflare uses multiple methods to detect bots, but these vary by plan. For mor
1616

1717
---
1818

19-
## How do I know what's included in my plan?
19+
## How do I know what is included in my plan?
2020

2121
To know what's included in your plan, refer to our [Plans](/bots/plans).
2222

@@ -75,7 +75,7 @@ Yes. WAF rules are executed before Super Bot Fight Mode. If a WAF custom rule pe
7575

7676
A request's _cf.bot_management.verified_bot_ value is a boolean indicating whether such request comes from a Cloudflare allowed bot.
7777

78-
Cloudflare has built an allowlist of good, automated bots, e.g. Google Search Engine, Pingdom, and more.
78+
Cloudflare has built an allowlist of good, automated bots, for example Google Search Engine, Pingdom, and more.
7979

8080
This allowlist is large based on reverse DNS verification, meaning that the IPs we allow really match the requesting service. In addition to this, Cloudflare uses multiple validation methods including ASN blocks and public lists. If none of these validation types are available for a customer, we use internal Cloudflare data and machine learning to identify legitimate IP addresses from good bots.
8181

@@ -103,7 +103,7 @@ If you are experiencing errors with your bot solution and need to submit a Suppo
103103

104104
:::caution
105105

106-
The following information gathering are required when you are experiencing issues (e.g. false positives) with Enterprise Bot Management only (Enterprise plan).
106+
The following information gathering are required when you are experiencing issues (for example, false positives) with Enterprise Bot Management only (Enterprise plan).
107107

108108
Because Bot Fight Mode (BFM) and Super Bot Fight Mode (SBFM) are set at a domain level, we often find that disabling these features is the best solution to false positives.
109109

@@ -136,7 +136,7 @@ Please follow instructions in the following questions on how to disable BFM and
136136

137137
**How to disable BFM/SBFM feature?**
138138

139-
If you encounter any issues with BFM/SBFM feature (e.g. false positive), you can disable it under **Security** > **Bots**.
139+
If you encounter any issues with BFM/SBFM feature (for example, false positive), you can disable it under **Security** > **Bots**.
140140

141141
- For **Free** plans, toggle the **Bot Fight Mode** option to **Off**
142142
- For **Pro** plans, click the **Configure Super Bot Fight Mode** link and set each of **Definitely automated** and **Verified bots** features to **Allow**, and toggle the **Static resource protection** and **JavaScript Detections** options to **Off**

src/content/docs/browser-rendering/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you are attempting to scan your **own zone** and need Browser Rendering to ac
2626

2727
##### Code generation from strings disallowed for this context while using an Xpath selector
2828

29-
Currently it's not possible to use Xpath to select elements since this poses a security risk to Workers.
29+
Currently it is not possible to use Xpath to select elements since this poses a security risk to Workers.
3030

3131
As an alternative try to use a css selector or `page.evaluate` for example:
3232

src/content/docs/browser-rendering/how-to/pdf-generation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Rather than using Browser Rendering to navigate to a user-provided URL, manually
7272
You can generate your HTML or CSS using any method you like. This example uses string interpolation, but the method is also fully compatible with web frameworks capable of rendering HTML on Workers such as React, Remix, and Vue.
7373
:::
7474

75-
For this example, we're going to take in user-provided content (via a '?name=' parameter), and have that name output in the final PDF document.
75+
For this example, we are going to take in user-provided content (via a '?name=' parameter), and have that name output in the final PDF document.
7676

7777
To start, fill out your `generateDocument` function with the following:
7878

src/content/docs/browser-rendering/platform/playwright.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ sidebar:
99

1010
import { Render, WranglerConfig, TabItem, Tabs } from "~/components";
1111

12-
[Playwright](https://playwright.dev/) is an open-source package developed by Microsoft that can do browser automation tasks; it's commonly used to write frontend tests, create screenshots, or crawl pages.
12+
[Playwright](https://playwright.dev/) is an open-source package developed by Microsoft that can do browser automation tasks; it is commonly used to write frontend tests, create screenshots, or crawl pages.
1313

14-
The Workers team forked a [version of Playwright](https://github.com/cloudflare/playwright) that was modified to be compatible with [Cloudflare Workers](https://developers.cloudflare.com/workers/) and [Browser Rendering](https://developers.cloudflare.com/browser-rendering/).
14+
The Workers team forked a [version of Playwright](https://github.com/cloudflare/playwright) that was modified to be compatible with [Cloudflare Workers](/workers/) and [Browser Rendering](/browser-rendering/).
1515

1616
Our version is open sourced and can be found in [Cloudflare's fork of Playwright](https://github.com/cloudflare/playwright). The npm package can be installed from [npmjs](https://www.npmjs.com/) as [@cloudflare/playwright](https://www.npmjs.com/package/@cloudflare/playwright):
1717

@@ -195,7 +195,7 @@ Using the above, the browser will stay open for up to 10 minutes, even if inacti
195195

196196
## Session management
197197

198-
In order to facilitate browser session management, we've extended the Playwright API with new methods:
198+
In order to facilitate browser session management, we have extended the Playwright API with new methods:
199199

200200
### List open sessions
201201

@@ -220,7 +220,7 @@ Notice that the session `478f4d7d-e943-40f6-a414-837d3736a1dc` has an active wor
220220

221221
### List recent sessions
222222

223-
`playwright.history()` lists recent sessions, both open and closed. It's useful to get a sense of your current usage.
223+
`playwright.history()` lists recent sessions, both open and closed. It is useful to get a sense of your current usage.
224224

225225
```json
226226
[
@@ -268,7 +268,7 @@ You should also be able to access this information in the dashboard, albeit with
268268

269269
## Playwright API
270270

271-
The full Playwright API can be found [here](https://playwright.dev/docs/api/class-playwright).
271+
The full Playwright API can be found at the [Playwright API documentation](https://playwright.dev/docs/api/class-playwright).
272272

273273
Note that `@cloudflare/playwright` is in beta. The following capabilities are not yet fully supported, but we’re actively working on them:
274274

0 commit comments

Comments
 (0)