HelpHub Bug Scrub Notes, 26 April 2019

HelpHub bug scrub is back. For the time being we’re planning to hold these once a month. If there’s a need, we’ll reconsider this decision. All the meetings will be happening in #meta-helphub channel.

At this point, HelpHub has two places for issues: Trac and Github. Our aim is to move all Phase 1.5 issues from GithubGitHub GitHub is a website that offers online implementation of git repositories that can can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ to TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. as these issues are really just fixes for what is already live at wordpress.org/support. Phase 2 is planned to be worked on at Github for now.

Responsibility for Trac issues is very unclear and should be discussed between docs and metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. teams. We don’t want to step on each other’s toes so it would be beneficial for both teams to make it clear who’s responsible for responses and decisions regarding reported issues.

At this bug scrub meeting we were discussing only Phase 1.5 issues.

Content

Content has only one issue on Github. @atachibana said he’ll comment on it and close it.

Another content related issue is opened on track https://meta.trac.wordpress.org/ticket/4195. It is highly recommended that content reps of documentation team get involved in discussion.

Design

We need decisions for 3 design related issues on Github. Also, we should see if @iviolini is still available for the project.

Development

Good first issues

During bug scrub we detected several issues that can be labeled as “good first issue”. They require either simple fix or just copying code from Github PR.

  1. https://meta.trac.wordpress.org/ticket/4267 – need switching h2 for h1 as explained here
  2. https://github.com/WordPress/HelpHub/issues/239 – has code in PR
  3. https://github.com/WordPress/HelpHub/issues/232 – has code in PR
  4. https://github.com/WordPress/HelpHub/issues/230 – has code in PR
  5. https://github.com/WordPress/HelpHub/issues/229 – has code in PR

Need discussion

1. https://github.com/WordPress/HelpHub/issues/237

We have to decide which is appropriate for HelpHub

  • To keep the order of TOC as like as (paper) book, or
  • To show the latest article as like as Search results

2. https://github.com/WordPress/HelpHub/issues/231

We need to properly redirect this URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org https://wordpress.org/support/category/. It’s not directly accessible from anywhere but it is possible to arrive from, let’s say, here https://wordpress.org/support/category/advanced-topics/ by editing URL.

Ready for coding

  • https://github.com/WordPress/HelpHub/pull/261 – has PR but the code is violating WPCS
  • https://github.com/WordPress/HelpHub/issues/214 – it’s been suggested that we should omit children from TOC but at the meeting we agreed that we want children – ignore the code in PR
  • https://github.com/WordPress/HelpHub/issues/111 – we don’t use Handbook pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party so we can’t replicate the toggles. We should, however, try to style everything else.

Attendance

@atachibana @sergeybiryukov @felipeelia @milana_cap

You can read a transcript of the meeting at https://wordpress.slack.com/archives/CG47GT4G2/p1556290821016800

The next bug scrub will happen in late May. Date and time will be discussed and published prior.

#bug-scrub