From d69d3d0d8fcbbbf89c31ed4591e622990f47ee67 Mon Sep 17 00:00:00 2001
From: Olivia Flory <45692622+oliviaflory@users.noreply.github.com>
Date: Thu, 7 Dec 2023 10:43:12 -0500
Subject: [PATCH] Docs--update-video-mdx (#1736)
* Docs--update-video-mdx
* update json video description
---
src/data/components.json | 2 +-
src/pages/components/video.mdx | 11 ++++++-----
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/src/data/components.json b/src/data/components.json
index e45566068..279016f95 100644
--- a/src/data/components.json
+++ b/src/data/components.json
@@ -409,7 +409,7 @@
"Video": {
"url": "/components/video",
"designLink": "https://ibm.box.com/s/9q7rdj73m32hufcw1xwl1td6nr88rghm",
- "description": "Video allows you to embed Kaltura videos from the media center in various ways throughout a page.",
+ "description": "Video allows you to embed videos from Media Center throughout a page, using the IBM standard video player, Kaltura.",
"storybook": {
"webcomponents": "http://www.ibm.com/standards/carbon/web-components/?path=/story/components-video-player--default",
"reactwrapper": "https://www.ibm.com/standards/carbon/web-components/react/?path=/story/components-video-player--default"
diff --git a/src/pages/components/video.mdx b/src/pages/components/video.mdx
index 1727e9ea4..edfcc1546 100644
--- a/src/pages/components/video.mdx
+++ b/src/pages/components/video.mdx
@@ -1,6 +1,6 @@
---
title: Video
-description: The Video component allows you to embed Kaltura videos from the media center in various ways throughout a page.
+description: Video allows you to embed videos from Media Center throughout a page, using the IBM standard video player, Kaltura.
---
import ComponentDescription from 'components/ComponentDescription';
@@ -11,19 +11,18 @@ import ResourceLinks from 'components/ResourceLinks';
-Resources
Overview
+Resources
Content guidance
Feedback
-
## Overview
The video component defaults to the aspect ratio of the source video, or one of the standard aspect ratios specified
-below can be used instead. In most cases 16x9 is recommended.
+in the [content guidance](#content-guidance) table can be used instead. In most cases, 16:9 is recommended.
By default, the component is prefilled with content returned from the Kaltura service. You can override this default
content and provide a custom video title, description, and poster image. If the content is optional for the component
@@ -45,6 +44,8 @@ The latter is recommended for a more immersive viewing experience.
Example of a video inside lightbox media viewer
+
+
## Content guidance
| Element | Content type | Required | Instances | Character limit
(English / translated) | Notes |
@@ -53,7 +54,7 @@ The latter is recommended for a more immersive viewing experience.
| Video title | Text | No | 1 | 65 / 85 | Optional overide of default title appears as caption under poster image. Video duration appended to title. |
| Video description | Text | No | 1 | 200 / 260 | Default populates but can be overridden. Only appears in [Lightbox media viewer](./lightbox-media-viewer). |
| Play mode | Option list | No | 1 | – | In-line (default), lightbox. |
-| Aspect ratio | Option list | No | 1 | – | Default is 16x9. Other ratios are 9x16, 2x1, 1x2, 4x3, 3x4, 1x1. |
+| Aspect ratio | Option list | No | 1 | – | Default is 16:9. Other ratios are 9:16, 2:1, 1:2, 4:3, 3:4, 1:1. |
| Poster image | [Image](https://www.ibm.com/standards/carbon/components/images) | No | 1 | – | Default to poster image from video source. Optional overide. |
For more information, see the [character count standards](https://www.ibm.com/standards/carbon/guidelines/content#character-count-standards).