[wp-meta] [Making WordPress.org] #3593: Centralize GitHub Markdown importer

Making WordPress.org noreply at wordpress.org
Fri Apr 27 14:07:56 UTC 2018

#3593: Centralize GitHub Markdown importer
 Reporter:  schlessera   |      Owner:  (none)
     Type:  enhancement  |     Status:  new
 Priority:  normal       |  Milestone:
Component:  Handbooks    |   Keywords:
 There are currently a few teams that want GitHub Markdown importing to
 feed their handbook: [https://meta.trac.wordpress.org/changeset/4733 CLI],
 [https://meta.trac.wordpress.org/ticket/2968 REST API],
 [https://meta.trac.wordpress.org/changeset/6304 Gutenberg],
 [https://meta.trac.wordpress.org/ticket/3377 WPCS], and probably more to
 come in the future, I think it would be worth a small refactoring effort
 to produce a reusable plugin that handle this across all teams & sites.

 @rmccue has already done a lot of preliminary work for making this
 reusable in https://github.com/WP-API/markdown-sync, but some details are
 still missing.

 Basic functionality could look like the following:

 1. Field to enter a markdown source on GitHub. This could be a nice,
 proper UI, but simply accepting a custom field under a common field key
 convention would be enough for an MVP. Something like [https://github.com
 wporg_markdown_source] would do the trick.
 2. Refresh button in the post edit screen to fetch the latest version of
 the content from GitHub and make updates as needed.
 3. Cron job that goes through all posts that have a custom field as
 registered on 1. and update as needed.
 4. Ability to specifiy a manifest file that defines the posts (and their
 post type) to create and their respective markdown sources.
 5. Cron job that goes through the manifest file and adds/removes/updates
 posts as needed.

 1., 2. & 3. are also great for one-off pages/posts that should be updated
 from an arbitrary GitHub file, without it being tied in an automated
 structure. As an example, a feature project page like the one from
 [https://make.wordpress.org/core/features/servehappy/ servehappy] could be
 set up to be updated from the corresponding GitHub repo's
 [https://github.com/WordPress/servehappy/blob/master/README.md README.md
 file], or individual pages in the different team handbooks could be set up
 for easier collaboration.

Ticket URL: <https://meta.trac.wordpress.org/ticket/3593>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org

More information about the wp-meta mailing list