[wp-meta] [Making WordPress.org] #2968: Move REST API Handbook content to GitHub

Making WordPress.org noreply at wordpress.org
Tue Jul 18 07:00:10 UTC 2017

#2968: Move REST API Handbook content to GitHub
 Reporter:  rmccue         |       Owner:
     Type:  enhancement    |      Status:  new
 Priority:  normal         |   Milestone:
Component:  Developer Hub  |  Resolution:
 Keywords:                 |

Comment (by rmccue):

 [attachment:2968.diff] adds a new WPORG Markdown plugin that just provides
 the base class used by the CLI (commands) and REST API handbooks. It
 doesn't update the CLI Handbook proper to use it yet, since that has a bit
 more functionality, but it will. Will require the CLI Handbook's manifest
 to be updated though, since it's incompatible.

 In the process of extracting this out, I added a few extra bits of
 functionality not in the existing classes:

 * '''Updating existing pages''' - If an existing page is found, it will
 now update the source URL. This allows us to retrofit into existing
 Handbooks (like the REST API)
 * '''Conditional updates''' - When fetching the Markdown source, it will
 store the ETag from the server, and send it back on the next request.
 GitHub will return a 304 response, allowing us to skip updates altogether.
 * '''Simplified manifest''' - Removed the requirement for `title` and
 `cmd_path` from the manifest. `title` is pulled from Markdown anyway, and
 `cmd_path` is redundant with the key already there. (This still correctly
 parses the CLI command manifest.)

 Will also publish this to GitHub as a standalone plugin.

Ticket URL: <https://meta.trac.wordpress.org/ticket/2968#comment:2>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org

More information about the wp-meta mailing list