Skip to content

Commit abcbe09

Browse files
Clarify language and improve documentation accuracy (#22306)
* 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 22b4647 commit abcbe09

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

src/content/docs/ssl/troubleshooting/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,5 +155,5 @@ The Let's Encrypt Certificate Authority and SNI are not currently supported by R
155155

156156
We recommend one of the following options:
157157

158-
* Change the Universal Certificate Certificate Authority to a different CA.
158+
* Change the Universal Certificate Authority to a different CA.
159159
* Add an [advanced certificate](/ssl/edge-certificates/advanced-certificate-manager/) or [custom certificate](/ssl/edge-certificates/custom-certificates/) using a different CA.

src/content/docs/stream/edit-videos/adding-captions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ To create or modify a caption on a video a [Cloudflare API Token](https://www.cl
1717

1818
The `<LANGUAGE_TAG>` must adhere to the [BCP 47 format](http://www.unicode.org/reports/tr35/#Unicode_Language_and_Locale_Identifiers). For convenience, many common
1919
language codes are provided [at the bottom of this document](#most-common-language-codes).
20-
If the language you are adding isn't included in the table, you can find the value
20+
If the language you are adding is not included in the table, you can find the value
2121
through the [The IANA registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry), which maintains a list of language codes. To find the
2222
value to send, search for the language. Below is an example value from IANA when
2323
we look for the value to send for a Turkish subtitle:
@@ -47,7 +47,7 @@ to generate closed captions for your videos.
4747
A video must be uploaded and in a ready state before captions can be generated.
4848
In the following example URLs, the video's UID is referenced as `<VIDEO_UID>`.
4949
To receive webhooks when a video transitions to ready after upload, follow the
50-
instructions provided [here](/stream/manage-video-library/using-webhooks/).
50+
instructions provided in [using webhooks](/stream/manage-video-library/using-webhooks/).
5151

5252
Captions can be generated for the following languages:
5353

src/content/docs/stream/examples/obs-from-scratch/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You need a Live Input on Stream. Follow the [Start a live stream](/stream/stream
3131

3232
- **RTMPS URL**, which will most likely be `rtmps://live.cloudflare.com:443/live/`
3333
- **RTMPS Key**, which is specific to the new live input
34-
- Whether you selected the beta "Low-Latency HLS Support" or not. For your first test, leave this _disabled._ ([What's that?](https://blog.cloudflare.com/cloudflare-stream-low-latency-hls-open-beta))
34+
- Whether you selected the beta "Low-Latency HLS Support" or not. For your first test, leave this _disabled._ ([What is that?](https://blog.cloudflare.com/cloudflare-stream-low-latency-hls-open-beta))
3535

3636
## 2. Install OBS
3737

@@ -92,7 +92,7 @@ _Your available options in the "Video Encoder" menu, as well as the resulting "E
9292

9393
For more information about these settings and our recommendations for Live, see the "[Recommendations, requirements and limitations](/stream/stream-live/start-stream-live/#recommendations-requirements-and-limitations)" section of [Start a live stream](/stream/stream-live/start-stream-live/).
9494

95-
## What's Next
95+
## What is Next
9696

9797
With these steps, you have created a Live Input on Stream, broadcast a test from OBS, and you saw it played back in via the Stream built-in player in Dash. Up next, consider trying:
9898

src/content/docs/stream/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ When HDR videos are uploaded to Stream, they are re-encoded and delivered in SDR
5959

6060
Cloudflare Stream supports video file uploads for any FPS, however videos will be re-encoded for 70 FPS playback. If the original video file has a frame rate lower than 70 FPS, Stream will re-encode at the original frame rate.
6161

62-
If the frame rate is variable we will drop frames (e.g. if there are more than 1 frames within 1/30 seconds, we will drop the extra frames within that period).
62+
If the frame rate is variable we will drop frames (for example if there are more than 1 frames within 1/30 seconds, we will drop the extra frames within that period).
6363

6464
### What browsers does Stream work on?
6565

src/content/docs/stream/manage-video-library/using-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ At this point, you should discard requests with timestamps that are too old for
160160

161161
Prepare the signature source string and concatenate the following strings:
162162

163-
* Value of the `time` field e.g. `1230811200`
163+
* Value of the `time` field for example `1230811200`
164164
* Character `.`
165165
* Webhook request body (complete with newline characters, if applicable)
166166

src/content/docs/stream/uploading-videos/player-api.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Multiple attributes can be used together, added one after each other like this:
2121

2222
* `autoplay` boolean
2323

24-
* Tells the browser to immediately start downloading the video and play it as soon as it can. Note that mobile browsers generally do not support this attribute, the user must tap the screen to begin video playback. Please consider mobile users or users with Internet usage limits as some users don't have unlimited Internet access before using this attribute.
24+
* Tells the browser to immediately start downloading the video and play it as soon as it can. Note that mobile browsers generally do not support this attribute, the user must tap the screen to begin video playback. Please consider mobile users or users with Internet usage limits as some users do not have unlimited Internet access before using this attribute.
2525

2626
:::note
2727
To disable video autoplay, the `autoplay` attribute needs to be removed altogether as this attribute. Setting `autoplay="false"` will not work; the video will autoplay if the attribute is there in the `<stream>` tag.
2828

29-
In addition, some browsers now prevent videos with audio from playing automatically. You may add the `mute` attribute to allow your videos to autoplay. For more information, go [here](https://webkit.org/blog/6784/new-video-policies-for-ios/).
29+
In addition, some browsers now prevent videos with audio from playing automatically. You may add the `mute` attribute to allow your videos to autoplay. For more information, see [new video policies for iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/).
3030
:::
3131

3232
* `controls` boolean
@@ -55,7 +55,7 @@ Multiple attributes can be used together, added one after each other like this:
5555

5656
* `poster` string
5757

58-
* A URL for an image to be shown before the video is started or while the video is downloading. If this attribute isn't specified, a thumbnail image of the video is shown.
58+
* A URL for an image to be shown before the video is started or while the video is downloading. If this attribute is not specified, a thumbnail image of the video is shown.
5959

6060
* `src` string
6161

@@ -145,15 +145,15 @@ Stream supports most of the [standardized media element events](https://develope
145145

146146
* `error`
147147

148-
* Sent when an error occurs. (e.g. the video has not finished encoding yet, or the video fails to load due to an incorrect signed URL)
148+
* Sent when an error occurs. (for example, the video has not finished encoding yet, or the video fails to load due to an incorrect signed URL)
149149

150150
* `loadeddata`
151151

152152
* The first frame of the media has finished loading.
153153

154154
* `loadedmetadata`
155155

156-
* The media's metadata has finished loading; all attributes now contain as much useful information as they're going to.
156+
* The media's metadata has finished loading; all attributes now contain as much useful information as they are going to.
157157

158158
* `loadstart`
159159

src/content/docs/stream/viewing-videos/displaying-thumbnails.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ Using the `poster` query parameter in the embed URL, you can set a thumbnail to
3535

3636
Supported URL attributes are:
3737

38-
* **`time`** (default `0s`, configurable) time from the video e.g. `8m`, `5m2s`
38+
* **`time`** (default `0s`, configurable) time from the video for example `8m`, `5m2s`
3939
* **`height`** (default `640`)
4040
* **`width`** (default `640`)
41-
* **`fit`** (default `crop`) to clarify what to do when requested height and width doesn't match the original upload, which should be one of:
41+
* **`fit`** (default `crop`) to clarify what to do when requested height and width does not match the original upload, which should be one of:
4242
* **`crop`** cut parts of the video that doesn't fit in the given size
4343
* **`clip`** preserve the entire frame and decrease the size of the image within given size
4444
* **`scale`** distort the image to fit the given size
@@ -69,10 +69,10 @@ Stream supports animated GIFs as thumbnails. Viewing animated thumbnails does no
6969

7070
Supported URL attributes for animated thumbnails are:
7171

72-
* **`time`** (default `0s`) time from the video e.g. `8m`, `5m2s`
72+
* **`time`** (default `0s`) time from the video for example `8m`, `5m2s`
7373
* **`height`** (default `640`)
7474
* **`width`** (default `640`)
75-
* **`fit`** (default `crop`) to clarify what to do when requested height and width doesn't match the original upload, which should be one of:
75+
* **`fit`** (default `crop`) to clarify what to do when requested height and width does not match the original upload, which should be one of:
7676
* **`crop`** cut parts of the video that doesn't fit in the given size
7777
* **`clip`** preserve the entire frame and decrease the size of the image within given size
7878
* **`scale`** distort the image to fit the given size

0 commit comments

Comments
 (0)