[wp-meta] [Making WordPress.org] #7520: Move Handbooks to GitHub to ease ability to contribute content

[Making WordPress.org]

#7520: Move Handbooks to GitHub to ease ability to contribute content
-----------------------------+---------------------
 Reporter:  oglekler         |       Owner:  (none)
     Type:  feature request  |      Status:  new
 Priority:  normal           |   Milestone:
Component:  Handbooks        |  Resolution:
 Keywords:                   |
-----------------------------+---------------------

Comment (by flexseth):

 What about using the WordPress Playground to edit handbooks?

 The Developer Documentation (Devhub) is set up in this way, but requires a
 good bit of wrangling to get up and running so you can offer up PRs. It
 could be possible to package up all of the content as a blueprint that
 could be imported to Playground to build the docs for editing purposes.

 == Possible user flow
 * User sees something to fix or improve on a documentation page
 * Page Bottom: Link to "Improve this page" - meets requested criteria
 * Link directs user to pertinent user flow for building documentation for
 this page
 * User downloads blueprint for this page's documentation, instantiates
 Playground
 * User edits docs in the block editor
 * User submits the edits (new blueprint) for review (this contains the
 changes)
 * Handbook maintainers install blueprint to view changes
 * If approved, handbook maintainers can copy/paste code from block editor
 to update


 == How would this work?

 It would require porting the existing documentation to individual post
 imports via a WXR file.

 Which could be done by running a `wp-cli` command to export each handbook
 page.

 The handbook blueprints could be linked to an "Improve this page"
 contributor flow on each piece of content. The blueprint link to builds a
 Playground instance with the content to edit or improve.

 == Simple use cases
 * Update screenshots
 * Fix spelling or grammar errors
 * add paragraph spacing

 == Optional improvement
 Include a "Ready to Submit?" button for automated workflow to GitHub

 == Benefits
 * Decouples individual content from understanding the entire handbook
 * Contributor flows route content updates to relevant team
 * Enforces use of the block editor, allows GitHub for collaboration
 * Lowers barrier of entry to contributing to documentation teams
 * No build requirements

-- 
Ticket URL: <https://meta.trac.wordpress.org/ticket/7520#comment:14>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org