📖 [AMP Story Paywall] amp-story-subscriptions documentation #38179
Conversation
|
Hey @newmuis, @gmajoulet! These files were changed: |
|
Is there a reason for this to be internal? Can you convert it to markdown and include it here? |
|
The public markdown file is in fact included in this PR and is based on the provided doc link in the PR description. Updated the PR description to make it clear. |
|
Friendly ping. |
extensions/amp-story-subscriptions/0.1/amp-story-subscriptions.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Approving with a nit.
I'll leave it to @CrystalOnScript for the final review!
extensions/amp-story-subscriptions/0.1/amp-story-subscriptions.md
Outdated
Show resolved
Hide resolved
extensions/amp-story-subscriptions/0.1/amp-story-subscriptions.md
Outdated
Show resolved
Hide resolved
extensions/amp-story-subscriptions/0.1/amp-story-subscriptions.md
Outdated
Show resolved
Hide resolved
extensions/amp-story-subscriptions/0.1/amp-story-subscriptions.md
Outdated
Show resolved
Hide resolved
| ... | ||
| ``` | ||
|
|
||
| See details about specifying this configuration in [`amp-subscriptions`](https://amp.dev/documentation/components/amp-subscriptions/). |
There was a problem hiding this comment.
If there is no difference between the configuration for a Story or classic AMP, I think we could call it out specifically (you can port your existing configuration...) and just link to the doc without giving an example.
There was a problem hiding this comment.
Sure. Removed this section and call it out in the summary section.
…are using the same way to specify configs.
| </amp-story> | ||
| ``` | ||
|
|
||
| ### `publisher-logo-src` {string} required |
There was a problem hiding this comment.
Can we get it from the amp-story metadata? https://github.com/ampproject/amphtml/blob/main/extensions/amp-story/amp-story.md#publisher-logo-src-guidelines
Do publishers need to repeat it?
There was a problem hiding this comment.
It is from amp-story's attribute. I was trying to express that this amp-story attribute is mandatory for this extension to work. But yes, this attribute is already mandatory. We don't need to repeatedly saying that here. Removed this entirely.
|
|
||
| A URL to the story publisher's logo in square format (1x1 aspect ratio). This logo would be shown on the publisher's subscribe button. For example `publisher-logo-src="https://example.com/logo/1x1.png"`, where 1x1.png is a 96x96 px logo. See the guidelines at [`amp-story` dev document](https://amp.dev/documentation/components/amp-story/?format=stories#publisher-logo-src-guidelines). | ||
|
|
||
| ### `subscriptions-page-index` {number} optional |
There was a problem hiding this comment.
Plz sort by required first, then optional
|
|
||
| Note that this specified page cannot be the first two pages nor the last page of the story. | ||
|
|
||
| ### `price` {string} required |
There was a problem hiding this comment.
Please give one or two examples (e.g. $10 or 10€) so people see how they can specify currencies
There was a problem hiding this comment.
Done.
Btw I never noticed that it is 10€ instead of €10. nice to know : )
…ct#38179) * amp-story-subscriptions doc * Add validator rules * update validator tests * uncommit all validator changes * Add description for if the optional params are not provided * change wording to "templated UX" * Clarification for some attributes * Fix check link error * Remove config example and call it out that AMP pages and web stories are using the same way to specify configs. * Clarification
…ct#38179) * amp-story-subscriptions doc * Add validator rules * update validator tests * uncommit all validator changes * Add description for if the optional params are not provided * change wording to "templated UX" * Clarification for some attributes * Fix check link error * Remove config example and call it out that AMP pages and web stories are using the same way to specify configs. * Clarification
The public markdown file in this PR is based on the internal API documentation draft here: go/amp-story-subscriptions-documentation