Amp-wp: As a plugin user, I should have documentation for the official 0.7 release of this plugin

Created on 22 Mar 2018  路  6Comments  路  Source: ampproject/amp-wp

AC1: Ensure plugin features are documented in this repo's Wiki.
AC2: Ensure plugin changelog is appropriately documented, outlining major and minor changes from the 0.6 to 0.7 releases.

All 6 comments

FYI, some useful info regarding comments in 0.7 from @westonruter here.

Also see internal ticket AP2-20.

Request For Review

Hi @ThierryA,
Could you please take a look at the wiki pages listed on AP2-20?

For the public record, that ticket lists these changes to the wiki pages:

New

Updated

Some more things that would probably be worthwhile to add docs for:

  • How to add shortcodes and widgets, including the use of is_amp_endpoint() inside the render function to switch between the two versions when required.
  • Make sure that any GitHub links include the full permalink (with the commit hash) so that they don't become invalid when the plugin evolves.
  • Add a section regarding enqueueing scripts and how they will be blocked from being output. Maybe include here a section regarding amp-bind to introduce the topic and how it is the alternative to including custom scripts, such as those included in Underscores.
  • Show how to create a form that takes a POST request. Note the requirement about doing wp_redirect(). Mention also here that the AMP component scripts for forms and for any other components will be automatically included, so you don't have to do so manually. (I added a note related to this under the discussion of amp-live-list.) You could also mention here that you can implement forms that use templates to show the results without doing full redirects by using the action-xhr attribute instead of action.

I pushed up some edits for other things I thought should be added.

Otherwise, I think it's good for the v0.7 release.

Thanks @kienstra, things are looking good!

I think an area that could still be explain further is the post-processor actions when the AMP theme support is declared, basically what does the post-processor do and how it could be an issue in some cases. That said, this is really much related to the Validation Status details so we can hold on to 1.0 to provide more details about it.

Thanks

Hi @ThierryA,
Thanks, that's a good idea to explain the post-processor in 1.0.

I added these new wiki pages:

new-wiki-pages

Was this page helpful?
0 / 5 - 0 ratings

Related issues

swissspidy picture swissspidy  路  5Comments

luizeof picture luizeof  路  4Comments

miina picture miina  路  3Comments

miina picture miina  路  5Comments

GitaStreet picture GitaStreet  路  4Comments