WordPress.org

Making WordPress.org

Opened 11 days ago

Last modified 11 days ago

#4601 assigned enhancement

Init BP DevHub with the BP REST API Handbook

Reported by: imath Owned by: johnjamesjacoby
Milestone: Priority: normal
Component: buddypress.org Keywords: has-patch needs-testing
Cc:

Description

Hi !

To follow up this BP devel post and the latest conversations we had on slack about the 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 :

Needed themes if the patch is not used :

  • wporg-developer,
  • bporg-developer : The 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 1so 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 😍

Attachments (3)

4601.diff (57.6 KB) - added by imath 11 days ago.
screenshot.png (143.9 KB) - added by imath 11 days ago.
buddypress.org/public_html/wp-content/themes/bporg-developer/screenshot.png (not included in the diff)
buddypress-logo.png (9.8 KB) - added by imath 11 days ago.
buddypress.org/public_html/wp-content/themes/bporg-developer/images/buddypress-logo.png (not included in the patch)

Download all attachments as: .zip

Change History (5)

@imath
11 days ago

@imath
11 days ago

buddypress.org/public_html/wp-content/themes/bporg-developer/screenshot.png (not included in the diff)

@imath
11 days ago

buddypress.org/public_html/wp-content/themes/bporg-developer/images/buddypress-logo.png (not included in the patch)

This ticket was mentioned in Slack in #buddypress by espellcaste. View the logs.


11 days ago

#2 @johnjamesjacoby
11 days ago

  • Keywords needs-testing added
  • Owner set to johnjamesjacoby
  • Status changed from new to assigned
Note: See TracTickets for help on using tickets.