Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Interactive docs first final version #30594

Merged
merged 23 commits into from
Nov 3, 2020

Conversation

mszylkowski
Copy link
Contributor

@mszylkowski mszylkowski commented Oct 9, 2020

Final documentation for amp-story-interactive.

Changes:

  • Pointed images towards amphtml/master instead of this branch
  • Set draft to false
  • Link amp.dev from the README and update README to GA

Added Google hosted backend

Closes #29468

@mszylkowski mszylkowski self-assigned this Oct 9, 2020
@amp-owners-bot
Copy link

amp-owners-bot bot commented Oct 9, 2020

Hey @gmajoulet! These files were changed:

extensions/amp-story-interactive/README.md
extensions/amp-story-interactive/amp-story-interactive.md

@CLAassistant
Copy link

CLAassistant commented Oct 23, 2020

CLA assistant check
All committers have signed the CLA.

@mszylkowski
Copy link
Contributor Author

@gmajoulet can you check these changes again and let's push them?

@mszylkowski mszylkowski changed the title 📖 Interactive docs final 📖 Interactive docs first final version Nov 2, 2020
[tip type="note"]
Before setting up a backend, consider if the already existing backends satisfy your requirements.
[/tip]
Backends need to be specified on the necessary components (binary-poll, poll, quiz), and can be deployed by publishers, tools or others.
Copy link
Contributor

Choose a reason for hiding this comment

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

In a separate PR, can we work on providing some very simple documentation on what the JSON API looks like for people to build a backend?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sunds good

@mszylkowski mszylkowski merged commit 245d7ec into ampproject:master Nov 3, 2020
ed-bird pushed a commit to ed-bird/amphtml that referenced this pull request Dec 10, 2020
* Add documentation for interactives

* Sourcecode to triple ticks

* Upload images and docs

* Add results image

* Uploaded latest changes to interactive docs

* Added changes to interactive docs

* Started fixing comments

* Added backticks to attributes

* Update extensions/amp-story-interactive/amp-story-interactive.md

Co-authored-by: CrystalOnScript <crystallambert@google.com>

* Update extensions/amp-story-interactive/amp-story-interactive.md

Co-authored-by: CrystalOnScript <crystallambert@google.com>

* Updated documentation

* Updated documentation

* Updated link

* Apply suggestions from code review

Co-authored-by: CrystalOnScript <crystallambert@google.com>

* Code suggestions

* Apply suggestions from code review

Co-authored-by: CrystalOnScript <crystallambert@google.com>

* Updated documentation

* Updated documentation

* Switched backend url for backend.com

Co-authored-by: CrystalOnScript <crystallambert@google.com>
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.

[Story interactives] Write official public documentation
4 participants