[wp-meta] [Making WordPress.org] #4601: Init BP DevHub with the BP REST API Handbook

[Making WordPress.org]

#4601: Init BP DevHub with the BP REST API Handbook
----------------------------+-----------------------
 Reporter:  imath           |      Owner:  (none)
     Type:  enhancement     |     Status:  new
 Priority:  normal          |  Milestone:
Component:  buddypress.org  |   Keywords:  has-patch
----------------------------+-----------------------
 Hi !

 To follow up this [https://bpdevel.wordpress.com/2019/06/24/bp-devhub/ BP
 devel post] and the latest conversations we had on
 [https://wordpress.slack.com/archives/C02RQBYUG/p1562818109228300 slack]
 about the [https://developer.buddypress.org/ developer.buddypress.org]
 documentation site, you'll find attached to this ticket a patch to include
 the `bporg-developer` theme. It's a child theme of the `wporg-developer`
 theme and a nice companion to the (wporg) `handbook` plugin.

 To include the parent theme and the handbook plugin, I've used
 `svn:externals` properties. I'm unsure it's the right way to do it but I
 wanted to avoid duplicating the `wporg-developer` theme and the `handbook`
 plugin into the buddypress.org "repository" and I thought it was a great
 way to keep the benefit of their future improvements.

 You can use the patch or alternatively download and install the needed
 themes and plugins on `developer.buddypress.org`.

 ==== Needed plugins : ====
 -
 [https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html
 /wp-content/plugins/handbook Handbook] (if the patch is not used)
 - [https://wordpress.org/plugins/syntaxhighlighter/ Syntax Highlighter]

 ==== Needed themes if the patch is not used : ====
 -
 [https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html
 /wp-content/themes/pub/wporg-developer wporg-developer],
 - [https://github.com/imath/bporg-developer/releases/tag/1.0.0-meta bporg-
 developer] : The [https://github.com/imath/bporg-
 developer/releases/download/1.0.0-meta/bporg-developer.zip bporg-
 developer.zip] file into the assets section of the GitHub release page is
 a specific version for the Meta repository. There's no README, all the
 code relative to the Restsplain plugin has been removed as we won't use it
 on developer.buddypress.org and a specific template has been added to
 display an "Under Construction" message for the Code Reference page.

 PS: Once all this is installed on developer.buddypress.org, please make
 sure to update the option `fresh_site` to `1`so that activating the
 `bporg-developer` theme from the live preview will generate the majority
 of needed pages and widgets.

 About the activating process, I can handle it if I'm promoted as an Admin
 of developer.buddypress.org, otherwise, please activate plugins first and
 then the `bporg-developer` theme **from the live preview feature of the
 Customizer.** To start writing the BP REST API documentation, it would be
 awesome to add me (if not Admin) & @espellcaste as editors.

 NB: the `handbook` plugin comes with a "Handbook Functionality for Pages"
 plugin we don't need to activate.

 Our priority for the 5.0.0 release is the BP REST API documentation,
 that's why I don't include in this ticket the steps relative to the Code
 Reference part (I suggest to work on it later).

 Thanks in advance for your help 😍

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