docs: add docs for content steering #1442
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
misteroneill
changed the title
misteroneill
requested changes
Nov 8, 2023
docs/content-steering.md
Outdated
| content steering tag in the `.m3u8` or `.mpd` and refresh the steering manifest | ||
| at an interval defined in that manifest. | ||
|
|
||
| Content steering manifest response will look something like this: |
There was a problem hiding this comment.
Suggested change
| Content steering manifest response will look something like this: | |
| A content steering manifest response will look something like this: |
docs/content-steering.md
Outdated
| # Content Steering | ||
|
|
||
| Content Steering provides content creators a method of runtime control over | ||
| the location where segments are fetched via a content steering server and |
There was a problem hiding this comment.
Suggested change
| the location where segments are fetched via a content steering server and | |
| the location from which segments are fetched via a content steering server and |
docs/content-steering.md
Outdated
| https://www.content-steering.com/. | ||
|
|
||
| HLS and DASH each define their own specific Content Steering tags and properties | ||
| that prescribe how the client will fetch the content steering manifest as well |
There was a problem hiding this comment.
Suggested change
| that prescribe how the client will fetch the content steering manifest as well | |
| that prescribe how the client should fetch the content steering manifest as well |
docs/content-steering.md
Outdated
| "CDN-PRIORITY": ["beta","alpha"] | ||
| } | ||
| ``` | ||
| Where `CDN-PRIORITY` represents either `PATHWAY-PRIORITY` for HLS or `SERVICE-LOCATION-PRIORITY` for DASH. This priority collection of keys will match with either a `PATHWAY-ID` or `serviceLocation` (HLS and DASH respectively) associated with a location where VHS can fetch segments. |
There was a problem hiding this comment.
Suggested change
| Where `CDN-PRIORITY` represents either `PATHWAY-PRIORITY` for HLS or `SERVICE-LOCATION-PRIORITY` for DASH. This priority collection of keys will match with either a `PATHWAY-ID` or `serviceLocation` (HLS and DASH respectively) associated with a location where VHS can fetch segments. | |
| `CDN-PRIORITY` represents either `PATHWAY-PRIORITY` for HLS or `SERVICE-LOCATION-PRIORITY` for DASH. This list of keys in priority order will match with either a `PATHWAY-ID` or a `serviceLocation` (HLS and DASH respectively) associated with a location where VHS can fetch segments. |
docs/content-steering.md
Outdated
| ``` | ||
| Where `CDN-PRIORITY` represents either `PATHWAY-PRIORITY` for HLS or `SERVICE-LOCATION-PRIORITY` for DASH. This priority collection of keys will match with either a `PATHWAY-ID` or `serviceLocation` (HLS and DASH respectively) associated with a location where VHS can fetch segments. | ||
|
|
||
| VHS will attempt to fetch segments from the locations defined in the steering manifest response, in the order, then during playback provide quality of experience metrics back to the steering server which can then adjust the steering decision accordingly. |
There was a problem hiding this comment.
Suggested change
| VHS will attempt to fetch segments from the locations defined in the steering manifest response, in the order, then during playback provide quality of experience metrics back to the steering server which can then adjust the steering decision accordingly. | |
| VHS will attempt to fetch segments from the locations defined in the steering manifest response in order. Then, during playback, VHS will provide quality of experience metrics back to the steering server which can adjust the steering guidance accordingly. |
wseymour15
reviewed
Nov 8, 2023
|
@misteroneill great suggestions, I appreciate the thorough feedback! @wseymour15 Good catch, I mentioned it at the bottom of the content-steering.md doc Fixed both 🍻 |
misteroneill
approved these changes
Nov 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add docs describing the basics of content steering
Specific Changes proposed
Add to supported-features.md and link to a specific content-steering.md doc.
Requirements Checklist