Init BP DevHub with the BP REST API Handbook

[imath]

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 :

• Handbook (if the patch is not used)
• ​Syntax Highlighter

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 😍

[imath]

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

[imath]

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

[johnjamesjacoby]

In 9131:

BuddyPress: Initial commit of BuddyPress Developer child theme.

This is the first of a few additions/edits required to test & deploy the up-coming developer.buddypress.org site update.

Props imath. See #4601.

[johnjamesjacoby]

• bporg-developer child theme Subversion external added
• wporg-developer parent theme Subversion external added
• handbook plugin Subversion external added
• @espellcaste and @imath added as Administrators to site
• Deployed to production
• Handbook plugin activated
• fresh_site set to 1 and customized (default content added)

There are some styling tweaks still to-do, specifically around the header/masthead & admin-bar and fixing their positions. (These should probably be made in bporg-developer/style.css)

[imath]

Option a: the WP Admin Bar at the top

[imath]

The WP Admin Bar just over the #masthead

[imath]

Hi @johnjamesjacoby

Thanks a lot for your work on the site, It looks awesome! 😍

Just added two patches to keep the admin bar at the top (4601.2a.patch​) or to move it just over the #masthead (4601.2b.patch) like it's the case for other website of the BuddyPress network.​

[imath]

Missing class

[imath]

4601.3.patch includes a missing class. I've used the Customizer custom CSS on the staging site and forgot to update the theme. Sorry about this extra work.

[johnjamesjacoby]

In 9132:

BuddyPress: Styling tweaks for developer.buddypress.org.

Makes the admin-bar styling match the rest of BuddyPress.org.

Props imath. See #4601.

[johnjamesjacoby]

4601.3.patch is committed & deployed, but it looks like it still needs a few more changes (responsive, etc...)

Going to refresh my memory and see if there's a way to simplify the #wp-toolbar CSS.

[johnjamesjacoby]

In 9133:

BuddyPress: Enqueue bb-Base styling for developer.buddypress.org.

Remove redundant styling from bbpress/buddypress specific themes.

See #4601.

[johnjamesjacoby]

In 9134:

BuddyPress: styling tweaks to better blend the various parent/child themes.

See #4601.

[johnjamesjacoby]

In 9135:

BuddyPress: Toolbar tweaks for better site integration.

Fixes z-index issues with mobile.

See #4601.

[johnjamesjacoby]

In 9136:

BuddyPress: Toolbar z-index overrides.

Fixes toolbar overlapping mobile responsive dropdown on developer.buddypress.org.

See #4601.

[johnjamesjacoby]

Pretty sure we are OK to close this one. @imath go ahead and close when you're OK with everything?

[imath]

Thanks a lot @johnjamesjacoby I think we still need to apply 4601.3.patch and I saw some potential little fixes. But yes we’re touching goal 🙌

[imath]

Actually this commit [9133] has some damages :(

The landing page is no more using 3 columns:

The text is now very big:

Could we avoid loading the bb-base style removing wp_enqueue_style( 'bb-base', content_url( 'themes' ) . '/bb-base/style.css' ); at line 19 of bporg-developer/functions.php to see how it goes ?

imho the mobile layout is secondary

[imath]

@johnjamesjacoby I think 4601.4.patch should fix the 3 columns layout issue and the text size issue.

Here are some screenshots:

3 columns on landing page

Text size on BP API REST handbook page (The header and the WP Admin bar are both fixed)

[imath]

Hi @johnjamesjacoby

This time, I think the layout issue should be fixed on desktop and on mobile. I've improved my previous patch to make sure the header mobile display is similar to what we have on BuddyPress.org.

Home - 3 columns - mobile (on the left menu is cloded, on the right it's opened)

Content - mobile (on the left menu is cloded, on the right it's opened)

The layout on desktop is back to what we had in the first place except that the WP Admin Bar & the main header are fixed just like on BuddyPress.org

Home - 3 columns - desktop

Content - desktop

The needed code for everything is into 4601.5.patch (PS: it replaces .4.patch)

[johnjamesjacoby]

In 9142:

BuddyPress: Unplug the bb-base styling dependency for Developer site.

Also includes styling tweaks for mobile that would normally be in bb-base.

See #4601. Props imath.

[johnjamesjacoby]

Still some styling improvements needed, but they aren't blockers IMO.

Discussion in Slack: ​https://wordpress.slack.com/archives/C02RQBYUG/p1568655020020400

[imath]

Hi @johnjamesjacoby

4601.6.patch should fix the header's responsiveness.

Here's a Without/With screenshot:

[imath]

Now there's #4894 I believe it would be coold to take this opportunity to commit 4601.6.patch to fix the header's responsiveness ;)

[tellyworth]

Can this be closed? I can't reproduce the issue in the last screenshot.