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

HelpHub Bug Scrub

HelpHub bug scrub is back. We’ll test Friday 3PM UTC as possible time for regular monthly bug scrub.

We’ll go through 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/ issues for Phase 1.5.

Content issues: https://github.com/WordPress/HelpHub/issues?q=is%3Aissue+is%3Aopen+label%3A%22Phase+1.5+-+Content%22

Design issues: https://github.com/WordPress/HelpHub/issues?q=is%3Aissue+is%3Aopen+label%3A%22Phase+1.5+-+Design%22

Development issues: https://github.com/WordPress/HelpHub/issues?q=is%3Aissue+is%3Aopen+label%3A%22Phase+1.5+-+Development%22

Pinging @atachibana for content and @iviolini for design issues. Everyone are welcome to attend and participate.

Bug scrub will happen in #meta-helphub channel on

Friday, April 26, 2019, 15:00 UTC

#bug-scrub

Summary for HelpHub Bug Scrub 05 October 2017

SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. transcript available here.

Closed issues

These issues are found unrelated for current development phase or fixed by other issues.

All closed issues

Closed pull requests

All closed PRs

Discussions

Active discussions about Home page template, Article voting functionality and Feature post sidebar frontend are happening on 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/.

Next meeting will happen today, Thursday, October 12, 2017, 17:00 UTC in #docs channel. You all are invited.

#bug-scrub, #summary

Summary for HelpHub Bug Scrub 21 September 2017

There was no bug scrubs last week, this is summary for the week before. SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. transcript available here.

Closed issues

These issues are found unrelated for current development phase or fixed by other issues.

All closed issues

Closed pull requests

All closed PRs

Discussions

There’s been discussion about old issues. Hopefully, the idea around them is more clear now. Home page template and article voting functionality are being discussed about in 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/.

Next meeting will happen today, Thursday, October 05, 2017, 17:00 UTC in #docs channel. You all are invited.

#bug-scrub, #summary

Summary for HelpHub Bug Scrub 14 September 2017

SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. transcript available here.

There were no closed issues since our last meeting.

All closed issues

All closed PRs

Discussions

We all agreed that reading time is not helpful and even misleading for HelpHub, so that should be removed before merging.

It has been reported that some issues are old and not providing clear tasks. It’s been quiet last few weeks so we might address these issues on next scrubs (today). It would be good to mark them and either clarify or close them. This meeting will happen today, Thursday, September 21, 2017, 17:00 UTC in #docs channel. You all are invited.

#bug-scrub, #summary

Summary for HelpHub Bug Scrub 7 September 2017

SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. transcript available here.

There were no closed issues since our last bug scrubs but two pull requests are closed – #140 and #147.

We got some attention which will, hopefully, bring more contributors to HelpHub. There are a couple of new people preparing their local installs (yeey).

All closed issues

All closed PRs

Home page template and powerful search are still hot topics.

Home Page Template

Home page template discussion is happening here. Please feel free to join, everyone’s opinion is welcomed.

Search Epic

Issues/PRs under Search epic: #8, #9, #47 and #37.

Huge thank you to all who contribute, you’re mega champions.

Next bug scrub will happen today, Thursday, September 14, 2017, 17:00 UTC in #docs channel and you all are invited. We can discuss any issue.

#bug-scrub, #summary

Summary for HelpHub Bug Scrub 31 August 2017

There were no closed issues or pull requests since our last bug scrubs. However, we had a good discussion about home page template and search functionality. These are going to be the main focus in following period. We are hoping to have intuitive search and helpful home page in order to prevent asking the same questions in forums.

Home Page Template

Home page template discussion is happening here. Please feel free to join, everyone’s opinion is welcomed.

Search Epic

Initial plans included Elastic Search for search functionality. This is something we want to apply with addition to possible usage of WP REST APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. for refining search results via filters. Again, feel free to join discussion, share experiences and ideas, or even code. Any help is welcomed.

Issues/PRs under Search epic: #8, #9, #47 and #37.

SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. transcript available here.

Huge thank you to all who contributed, you’re super heroes.

All closed issues

All closed PRs

Next bug scrub will happen today, Thursday, September 07, 2017, 17:00 UTC in #docs channel and you all are invited. We can discuss all the issues but keep in mind the focus on home page template and Search.

#bug-scrub, #summary

Summary for Helphub Bug Scrub 24 August 2017

Last week we didn’t have bug scrubs due to regular Fortnight Docs meeting. You can check last summary here.

Closed issues

All closed issues

Closed PRs

All closed PRs

Huge thank you to all who contributed, you’re mega heroes.

Next

Now that development tools are synced with the rest of make teams (thanks to @netweb), we can move on with design and functionality. It is noted that we should have clear(er) direction and goals, and bug scrubs should guide towards these goals.

That being said, next main focus should be search functionality and home page template.

Home Page Template

We already have some great ideas for home page and design proposal by @mapk.

Search Epic

We want HelpHub to have powerful search functionality and template. This is one of first places end user will come for information and all information should be easy accessed and found. Issues/PRs under Search epic: #8, #9, #47 and #37.

Next bug scrub will happen today, Thursday, August 31, 2017, 17:00 UTC in #docs channel and you all are invited. We can discuss all the issues but keep in mind the focus on home page template and Search.

#bug-scrub, #summary

Summary for HelpHub Bug Scrub 17 August 2017

SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. transcript available here.

Last week’s focus was on writing guides to help with onboarding new contributors and tracking contributors 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.

For next 7 days it is planned to convert all Grunt tasks to Gulp and keep consistency throughout the project. This will allow finishing document on contributing to HelpHub with code. It is also planned for Tracking contributors plugin to be finished and ready for testing; going through Handbook plugin and extract what’s needed for HelpHub theme (mainly focused on sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme. menu); as well as design fixes, reported in various issues.

Closed issues

  • Markup issues causing breaking layout – #124

All closed issues

Closed PRs

  • Contributing guide – #120, #129
  • Update normalize to latest version – #123
  • Markup issues causing breaking layout – #125

All closed PRs

Huge thank you to all who contributed, you’re superstars.

We will skip today’s bug scrub as documentation team has forthnight meeting in #docs channel and you all are invited.

Next bug scrub will happen next week, Thursday, August 31, 2017, 17:00 UTC in #docs channel and you all are invited. Here are issues we will discuss. If you have any comments/questions/concerns, do post comment to this post (pinging @kenshino, @netweb, @clorith, @mapk, @joyously).

#bug-scrub, #summary

Summary for Helphub Bug Scrub 10 August 2017

First bug scrub for Helphub happened last Thursday – slackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. transcript available here.

Travis issues were major blocker for dev team and it was fixed by @clorith in #112. Huge enhancement in productivity is converting all theme styles into sass partials, also done by @clorith.

Closed issues

  • Table of Contents – #108, #6, #81
  • Links to translate Codex pages – #80
  • Search form in headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes.#110
  • Main menu styles – #106
  • Removed comment form – #107
  • Travis issues – #52, #103

All closed issues

Closed PRs

  • TOC – #102, #100
  • Contributing guide – #120
  • Links to translated Codex pages – #48
  • Search form in header – #117
  • Gitignore improvement – #121
  • Gulp modifications – #118
  • Style.css to SASS – #115
  • Grunt modifications – #116
  • Removed comment form – #113
  • Travis issues – #97, #104, #112

All closed PRs

Huge thank you to all who contributed, you’re megastars.

Another bug scrub will happen today, Thursday, August 17, 2017, 17:00 UTC in #docs channel and you all are invited. Here are issues we will discuss.

#bug-scrub, #summary