WordPress.org

Making WordPress.org

#3485 closed enhancement (fixed)

HelpHub: Support theme update and associated plugin

Reported by: Clorith Owned by: SergeyBiryukov
Milestone: Priority: normal
Component: HelpHub Keywords: has-patch
Cc:

Description

HelpHub builds on the support theme, but with some custom post types and widgets to customize the landing page of wordpress.org/support, and organize content.

The patch includes the following theme changes:

  • A generic archive template, when more article types are planned for future phases we will likely introduce different archive views.
  • The current forums front page is moved to the archive-forum template.
  • A new (conditional) front page is introduced, it uses widgets and relies on the link block widget in the patch. If the widgets are undefined, the fallback is to use the forums archive like today.
  • Generic code style cleanup.

The following plugin is introduced during the initial release:

  • Adds a support-helphub plugin, in the same spirit as support-forums
  • Custom post types for various articles
  • A widget for declaring link blocks for the front page.

Enabling Gutenberg on WordPress.org/support is also a request to go along with this. The post types we'll be working with for now are REST enabled for this purpose.
Gutenberg has been checked to not cause any issues with bbPress, so that shouldn't be a concern at this time.

Attachments (9)

HelpHub_first_iteration.patch (398.6 KB) - added by Clorith 20 months ago.
HelpHub_first_iteration.2.patch (397.6 KB) - added by Clorith 20 months ago.
HelpHub_first_iteration.3.patch (93.1 KB) - added by Clorith 20 months ago.
3485.patch (101.8 KB) - added by Clorith 19 months ago.
3485.2.patch (101.6 KB) - added by netweb 19 months ago.
3485.3-scss-css.patch (226.4 KB) - added by netweb 17 months ago.
3485.page.png (75.0 KB) - added by SergeyBiryukov 11 months ago.
3485.forums.png (82.9 KB) - added by SergeyBiryukov 11 months ago.
3485.HelpHub_Manager.patch (10.4 KB) - added by Clorith 11 months ago.

Download all attachments as: .zip

Change History (38)

#1 @Clorith
20 months ago

I had forgotten to remove the WPORG fallbacks in HelpHub_first_iteration.patch, please disregard it.

#2 @ocean90
20 months ago

Some quick feedback:

  • It's look like there are a few theme files with code styling changes. Those should be removed from the patch to keep it clean.
  • dirname( __FILE__ ) => __DIR__
  • support-helphub/inc/helphub-front-page-blocks/helphub-front-page-blocks.php shouldn't have a plugin header.
  • /support-helphub/inc/helphub-front-page-blocks/includes/class-support-helphub-front-page-blocks-widget.php shouldn't have the PhpStorm header.
  • No need for helphub-post-types/index.php.
  • support-helphub/inc/helphub-post-types/readme.txt can be removed. Also the plugin/file headers since it's no longer its own plugin.
  • Do we really need jQuery UI CSS Framework 1.12.1?

#3 @Clorith
20 months ago

Thanks for the quick look!

HelpHub_first_iteration.3.patch removes all the PHPCS lines that aren't directly related to new/modified code, and addresses all the other points you made.

The jQuery UI styles are because of the WordPress Version CPT using jQuery UI in the backend, if there's a fixed one for use in meta that should obviously be used instead of the direct styles here.

This ticket was mentioned in Slack in #docs by zzap. View the logs.


20 months ago

This ticket was mentioned in Slack in #docs by zzap. View the logs.


20 months ago

This ticket was mentioned in Slack in #meta by clorith. View the logs.


20 months ago

@Clorith
19 months ago

#7 @Clorith
19 months ago

3485.patch is good to go.

Mostly the same as the previous patch, but introduces the custom editor role.

The HElpHub Editor role provides the default editor roles, with added capabilities to modify menus, as used by widget blocks, and the ability to view the customizer to ensure a good UI on the front end.

This ticket was mentioned in Slack in #meta by clorith. View the logs.


19 months ago

#9 @SergeyBiryukov
19 months ago

  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

This ticket was mentioned in Slack in #docs by netweb. View the logs.


19 months ago

@netweb
19 months ago

#11 @netweb
19 months ago

Patch 3485.2.patch is a minor refresh of 3485.patch with some merge conflicts resolved.

Further work ongoing...

This ticket was mentioned in Slack in #docs by zzap. View the logs.


18 months ago

This ticket was mentioned in Slack in #meta by joyously. View the logs.


17 months ago

#15 @dd32
17 months ago

In 7283:

HelpHub: Add the plugin directory for the new HelpHub plugin.

See #3485.

#16 @dd32
16 months ago

In 7306:

Support Hub: Add Support Hub plugin

Props atachibana, bravokeyl, carl-alberto, clorith, felipeelia, hideokamoto, hlashbrooke, joyously, justingreerbbi, kenshino, mapk, mariovalney, mirucon, miyauchi, netweb, torounit, webdevmattcrom, zzap

See #3485.

#17 @netweb
16 months ago

In 7354:

Support Hub: Update Support Hub to latest changes via GitHub

References:

Props clorith, kenshino, netweb.
See #3485.

#18 @netweb
16 months ago

In 7373:

Support Hub: Update Support Hub to latest changes via GitHub

Reference: https://github.com/Kenshino/HelpHub/commit/ed34600

Props milana_cap.
See #3485.

This ticket was mentioned in Slack in #meta by tellyworth. View the logs.


14 months ago

#20 @netweb
12 months ago

In 7813:

Support Forum: Updated bbPress templates

See #3485.

#21 @SergeyBiryukov
12 months ago

In 7818:

Support Forums: Revert [7813], overzealous escaping breaks legitimate markup.

See #3485.

#22 @netweb
11 months ago

In 7835:

Support Forum: Updated bbPress templates and styles

See #3485.

#23 @SergeyBiryukov
11 months ago

@netweb: [7835] unnecessary limits the width on existing pages and adds extra underlines on the forums, see 3485.page.png and 3485.forums.png.

Could we limit these changes to HelpHub pages only, e.g. with .single-helphub_article instead of .single and .page-_some_helphub_class_ instead of .page?

#24 @coffee2code
11 months ago

In 7836:

Support Theme: Limit HelpHub-specific styles to HelpHub sections.

Props SergeyBiryukov, coffee2code.
See #3485.

#25 @coffee2code
11 months ago

[7836] seems to address the issues Sergey brought up. I didn't spot any other problems, so this may be ready for deploy. (Which should be noted is holding up deploy on any other potential w.org changes.)

#26 follow-up: @Clorith
11 months ago

I've attached 3485.HelpHub_Manager.patch which introduces a new HelpHub Manager role, allowing manager users to add HelpHub Editors using the default profiles on wordpress.org/support/users/<username>.

This allows for more flexibility in who can be given the capabilities to manage HelpHub contributors, and also avoids the need for messing with core role and capability management.

Keymasters have the regular profile edit link which gives access to the same role changer, as such the capabilities for the base edit form is tied to the manage_helphub capability only (meaning HelpHub Managers and network admins will be able to see it).

#27 in reply to: ↑ 26 ; follow-up: @netweb
11 months ago

Replying to coffee2code:

[7836] seems to address the issues Sergey brought up. I didn't spot any other problems, so this may be ready for deploy. (Which should be noted is holding up deploy on any other potential w.org changes.)

Looks good to me, thanks, deploying sounds good to me 👌


Replying to Clorith:

I've attached 3485.HelpHub_Manager.patch which introduces a new HelpHub Manager role, allowing manager users to add HelpHub Editors using the default profiles on wordpress.org/support/users/<username>.

Let's move this to a ticket of its own, primarily to close out this ticket and make further iterations in individual tickets please.

This ticket was mentioned in Slack in #meta by clorith. View the logs.


11 months ago

#29 in reply to: ↑ 27 @coffee2code
11 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

This has been deployed (yesterday, with the related CSS cache bust just now).


Replying to netweb:

Replying to Clorith:

I've attached 3485.HelpHub_Manager.patch which introduces a new HelpHub Manager role, allowing manager users to add HelpHub Editors using the default profiles on wordpress.org/support/users/<username>.

Let's move this to a ticket of its own, primarily to close out this ticket and make further iterations in individual tickets please.

Clorith has opened this particular item as #3918.

Note: See TracTickets for help on using tickets.