amp-story: Metadata docs #14196
Merged
amp-story: Metadata docs #14196
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
newmuis
reviewed
Mar 22, 2018
extensions/amp-story/amp-story.md
Outdated
| poster-landscape-src="https://example.com/my-story/poster/4x3.jpg"> | ||
| ``` | ||
|
|
||
| These metadata attributes will be used for displaying a preview of this story across the AMP Stories ecosystem. For example, these attributes can be used to render an engagin preview link in the bookend of a related story. Providing these attributes will also help ensure your story is future-proof for rich, embedded experiences in AMP Stories surfaces to come. |
extensions/amp-story/amp-story.md
Outdated
| poster-landscape-src="https://example.com/my-story/poster/4x3.jpg"> | ||
| ``` | ||
|
|
||
| These metadata attributes will be used for displaying a preview of this story across the AMP Stories ecosystem. For example, these attributes can be used to render an engagin preview link in the bookend of a related story. Providing these attributes will also help ensure your story is future-proof for rich, embedded experiences in AMP Stories surfaces to come. |
There was a problem hiding this comment.
nit: s/AMP Stories/AMP stories/
newmuis
approved these changes
Mar 22, 2018
ghost
suggested changes
Mar 26, 2018
| @@ -156,6 +193,22 @@ The `amp-story` component represents an entire story. The component itself imp | |||
|
|
|||
| Identifies that the AMP document is a story. | |||
|
|
|||
| ##### title [required] | |||
There was a problem hiding this comment.
If these are required, it would make sense to update the sample in the example section (right before this section) so it shows those attributes.
extensions/amp-story/amp-story.md
Outdated
|
|
||
| These metadata attributes will be used for displaying a preview of this story across the AMP stories ecosystem. For example, these attributes can be used to render an engaging preview link in the bookend of a related story. Providing these attributes will also help ensure your story is future-proof for rich, embedded experiences in AMP stories surfaces to come. | ||
|
|
||
| Note that these metadata attributes supplement and does not replace any Structured Data (e.g. JSON-LD) on the page. We still recommend adding [Structured Data](https://developers.google.com/search/docs/data-types/article#amp-sd) to all your AMP pages, including AMP stories. |
extensions/amp-story/amp-story.md
Outdated
|
|
||
| ##### poster-portrait-src [required] | ||
|
|
||
| The story poster in portrait format (3x4 aspect ratio). |
There was a problem hiding this comment.
Can you expand on this for new users. What would this typically be? For example,
"The poster is an image that displays in the UI until your story is loaded. The poster can generally be the first screen of your story, although any image that is representative of the story."
There was a problem hiding this comment.
Added a new section and linked to it.
extensions/amp-story/amp-story.md
Outdated
|
|
||
| ##### publisher-logo-src [required] | ||
|
|
||
| A publisher's logo in square format (1x1 aspect ratio). |
There was a problem hiding this comment.
Suggest adding, "For example publisher-logo-src="https://example.com/logo/1x1.png", where 1x1.png is a 36x36 pixel logo.
ghost
approved these changes
Mar 26, 2018
ghost
mentioned this pull request
glevitzky
pushed a commit
that referenced
this pull request
Apr 27, 2018
* add metadata reqs to new announcements section in amp-story.md * add attrs in main section and note about structured data * minor fixes * barb's comments * minor fixes * Update announcement date
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.
Partial for #11989.
/to @bpaduch @newmuis