Skip to content

📖 [amp-story-player] Initial docs#26606

Merged
Enriqe merged 8 commits intoampproject:masterfrom
Enriqe:amp-story-player-docs-1
Feb 21, 2020
Merged

📖 [amp-story-player] Initial docs#26606
Enriqe merged 8 commits intoampproject:masterfrom
Enriqe:amp-story-player-docs-1

Conversation

@Enriqe
Copy link
Copy Markdown
Contributor

@Enriqe Enriqe commented Feb 3, 2020

Adds initial documentation for the new amp-story-player.

I2I #24539
Tracker #26308

@amp-owners-bot
Copy link
Copy Markdown

amp-owners-bot bot commented Feb 3, 2020

Hey @alanorozco, these files were changed:

  • extensions/amp-story/amp-story-player.md

Hey @wassgha, these files were changed:

  • extensions/amp-story/amp-story-player.md

@Enriqe Enriqe self-assigned this Feb 3, 2020
@Enriqe
Copy link
Copy Markdown
Contributor Author

Enriqe commented Feb 6, 2020

Friendly ping

Copy link
Copy Markdown
Contributor

@CrystalOnScript CrystalOnScript left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've got a couple of big things about this one:

  1. I really don't think this information should be inside the amp-story folder. Everything in the amp-story folder is either the <amp-story> component, or child components of <amp-story> and must be on AMP valid pages. <amp-story-player> is the exact opposite of this. I think we need to seriously reconsider the structure of this documentation.

  2. It is very unclear to me if I can use this component/viewer on AMP pages or if it is strictly for non-AMP pages.

  3. The fact that we can use this in non-AMP pages makes me question further if it should be in the extensions folder. I highlighted using the extension-doc.template.md but is it an extension of AMP?

@Enriqe Enriqe force-pushed the amp-story-player-docs-1 branch from 42e7d05 to fb31b40 Compare February 6, 2020 20:37
@Enriqe
Copy link
Copy Markdown
Contributor Author

Enriqe commented Feb 10, 2020

Ready for another review @CrystalOnScript 👍

Copy link
Copy Markdown
Contributor

@CrystalOnScript CrystalOnScript left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for migrating it into spec!

@Enriqe Enriqe force-pushed the amp-story-player-docs-1 branch from 78e98d2 to a56a217 Compare February 14, 2020 20:12
@Enriqe
Copy link
Copy Markdown
Contributor Author

Enriqe commented Feb 18, 2020

Thanks @CrystalOnScript for the detailed review!

/to @dvoytenko for owners approval

@Enriqe Enriqe requested a review from dvoytenko February 18, 2020 21:12

### Attributes

The inline width and height ensures that the player will not cause any jumps in your website while the script is being loaded. Feel free to modify the values, but we recommend maintaining a 3:5 aspect ratio.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @hongwei1990 to make sure this is right

@Enriqe Enriqe force-pushed the amp-story-player-docs-1 branch from a56a217 to 806cecb Compare February 21, 2020 20:24

```html
<head>
<script
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does prettier force this to be formatted like this? Can we just make them one line for the script and one line for the style?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep I'm not happy with it either, but prettier forces this style...

@Enriqe Enriqe force-pushed the amp-story-player-docs-1 branch from 806cecb to 4f0e249 Compare February 21, 2020 20:53
@Enriqe
Copy link
Copy Markdown
Contributor Author

Enriqe commented Feb 21, 2020

PTAL @newmuis

@Enriqe
Copy link
Copy Markdown
Contributor Author

Enriqe commented Feb 21, 2020

Friendly ping @dvoytenko for OWNERS approval in spec/img/*

@Enriqe Enriqe merged commit f674102 into ampproject:master Feb 21, 2020
robinvanopstal added a commit to jungvonmatt/amphtml that referenced this pull request Feb 24, 2020
* master: (41 commits)
  custom-element: Minor test improvements (ampproject#26923)
  amp-pixel: Minor test improvements (ampproject#26918)
  viewer: Minor test improvements (ampproject#26906)
  dom: Minor test improvements (ampproject#26913)
  amp-action: Support whitelist lookup in AmpDocShadow (ampproject#26684)
  ✨ Update amp-access-scroll (ampproject#26810)
  🚀 Remove doc css and base css from ESM build (ampproject#26889)
  📖 [amp-story-player] Initial docs (ampproject#26606)
  Amp consent restrict fullscreen prod flag (ampproject#26909)
  📖 Clarify SXG duration minimum (ampproject#26890)
  Improve test vendor requests macros (ampproject#26828)
  🚀 Move scroll left and top macros out of url-replacement-impl (ampproject#25594)
  Update consent string maximum size to 200 bytes (ampproject#26741)
  ✨[amp-story-player] Adds tap-to-next/previous story (ampproject#26865)
  update owners file with correct syntax (ampproject#26899)
  amp-sticky-ad: Fix unit test (ampproject#26855)
  Add performance metrics to README (ampproject#26891)
  🐛 Bug fix: check links test (ampproject#26739)
  ✨Idealmedia uniq ad (ampproject#25838)
  📦 Update dependency jsdom to v16.2.0 (ampproject#26591)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants