Summary for Docs Team Meeting 15 July 2019

Attendance:

@leogermani @chrisvanpatten @estelaris @ibdz @jeffmatson @audrasjb @kenshino attended

We didn’t have a quorum today so we went with a full open floor format!

Global Design Changes

WordPress.org is trying to sync it’s designs up across all the siites and assets. The design team will help sync HelpHub and DevHub’s designs to be compliant.

@ibdz is also picking up design tickets to work on.

Content Update

@leogermani has worked out the full list of hooks that require migration. That list has been merged into the main DevHub migration document available here.

He has also gotten the top 100 hooks (traffic based) and suggested them to be candidates for immediate migration. He’ll work with @atachibana to sort things out and potentially post a Call for Collaborators.

Gutenberg Documentation

@chrisvanpatten said that a Gutenberg Docs bug scrub will happen within the next 2 weeks.

The plans to peg the current released Block Editor docs to the current WordPress release is still an item that they want to fix but have limited resources. We would appreciate anyone wanting to help with this transition to raise their hand!

You can take a look at the meeting transcript via this link.

Agenda for Docs Team meeting 15 July 2019

Our next Documentation Team meeting is scheduled on

Monday, July 15, 2019, 15:00 UTC

in the #docs channel on Slack

Current Projects Updates:

  1. Content Migration from Codex to HelpHub & DevHub – @atachibana
  2. HelpHub development – @milana_cap
  3. Inline Docs – @drewapicture and @atimmer
  4. Docs Team Handbook – @milana_cap

Ad Hoc pieces

  1. Use of the More Info section in Code reference https://make.wordpress.org/docs/2019/05/13/the-best-way-to-use-the-more-info-section/ – @juliobox
  2. Centralised API handbook – https://meta.trac.wordpress.org/ticket/4376
  3. Who’s in the Docs Team? (Let’s finalise this)

Open Floor

Feel free to comment if you have items to add to the agenda.

X-post: Updates to the WordPress User & Developer Survey

X-comment from +make.wordpress.org/updates: Comment on Updates to the WordPress User & Developer Survey

Agenda for HelpHub meeting 8 July 2019

Hello all,

Next HelpHub meeting will happen on

Monday, July 8, 2019, 15:00 UTC
  1. Attendance
  2. Phase 1.5 Check-in
  3. Detailed content discussions
  4. DevHub Migration (Hooks)
    • https://docs.google.com/spreadsheets/d/1j2l2tAys5GXF_uM9Q2OHdMJuXfIC2lK5-Fk15iqLXDM/edit#gid=0
  5. AOB

Helpful Links

  • HelpHub Production – https://wordpress.org/support/
  • GitHub repo – https://github.com/WordPress/HelpHub
  • State of HelpHub (read for Phase 2) – https://make.wordpress.org/docs/2018/02/26/state-of-helphub-february-2018/
  • Previous HelpHub meeting – https://make.wordpress.org/docs/2019/06/18/summary-for-helphub-meeting-17-june-2019/

Summary for Docs Team Meeting 1 July 2019

Attendance

@leogermani @atachibana @milana_cap @felipeelia @audrasjb @estelaris @felipeloureirosantos @chrisvanpatten @fitehal @howdy_mcgee @rahuldsarker @kenshino

Content Migration from Codex to HelpHub & DevHub

@atachibana reported many HelpHub pages were modified during WCEU Contributor Day. The next goal is redirecting of DevHub. the current worksheet is available: https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=0 (open “New Status” tab for overall stats).

There is some instructions about editing this spreadsheet in Docs Team Handbook: https://make.wordpress.org/docs/handbook/code-reference/editing-articles/. Anyone is welcome to join the project.

@leogermani took a try to make sure WP_Query was ready to be redirected. Some missing sections and parameters were added, along with lots of other adjustments.

@leogermani reporte 2 remaining issues on this document:

  1. some of the h3 titles are not automatically added to the Table of Content.
  2. He didn’t create the links to the related Actions/Filters. We have to check if we can add links to them in devhub since they are far more incomplete there.

These issues are not blockers, so @atachibana is going to redirect it.

@kenshino asked if there is statistics of how many DevHub articles are redirected VS how many need redirection.

@atachibana said that we have the number of Functions: 167 of 901 (18.5%) was redirected. But we don’t have the number of Classes and Hooks/Filters.

@atachibana is going to modify the handbook to set high priority to redirecting.

HelpHub development

@milana_cap listed the current opened Meta trac tickets:

Waiting for merge:

  • https://meta.trac.wordpress.org/ticket/4491
  • https://meta.trac.wordpress.org/ticket/4492 (patch added today)

Waiting for code:

  • https://meta.trac.wordpress.org/ticket/4493

@milana_cap is trying to figure out the best way for contributing to helphub dev by sharing GitHub and Trac code in local. Developers who want to help out with phase 1.5 can ping Milana directly.

@estelaris is going to add needs-design keyword to those tickets.

@kenshino asked if any estimates to when we’ll finish Phase 1.5 dev.

@milana_cap said there are few issues that need decisions. A couple require the actual developer work (not just small CSS tweaks) with decisions made and very slow progress. September would be latest. @kenshino: Also remember @milana_cap and @clorith are dev leads so if it’s a development question, they can make decisions.

Inline Docs

Last week we talked about making sure we have mapped out some ideas for @juliobox to pick up the management of the specific area in Code Reference (“More Info” section).

@kenshino also had a chat with the previous Docs Lead and one of the creators of DevHub, that area was really meant to house the extraordinary amount of examples and information of WP_Query. So using it as a curated content space isn’t out of the norm.

Centralised API Handbook on DevHub

@coffee2code has created that and called it the Common API Handbook. It’s not visible on the front end but when you go to wp-admin, we can see the custom post type.

@atachibana do mark out the pages you’d like to move from the other handbooks to the Common API handbook.

Who’s in the Docs Team

Last update from Docs Team Leads:

Open Floor

@leogermani asked if there are any previous discussion on migrating the Explanations for the Filters/Actions from the Codex to devhub. For example: https://codex.wordpress.org/Plugin_API/Filter_Reference/posts_join. In devhub there is only the basics and no description: https://developer.wordpress.org/reference/hooks/posts_join/

@kenshino: stated one needs to submit a core ticket to add in that straight to the PHP Docs block in the code (that’s how we parse in the Code reference pages).

@leogermani asked if “Centralised API Handbook on DevHub” discussion is related to this topic opened by @atachibana ? (See also: https://make.wordpress.org/docs/2019/05/19/proposal-wordpress-developer-handbook-for-common-topics/). @kenshino answered it’s exactly the same thing.

About HelpHub Internationalization:

Locales that are ready to begin with HelpHub internationalization are invited to open a Meta Trac ticket. At this moment, some of them have already opened a ticket: 4523 (pt_BR), 4571 (Serbian), 4572 (pt_ES), 4573 (nl_NL), 4574 (fr_FR) and 4575 (ja).

@kenshino added it would be good to comment on https://make.wordpress.org/meta/2019/06/20/helphub-handbooks-localisation/ as well so that others can see which locales are joining.

Agenda for Docs Team meeting 1 July 2019

Our next Documentation Team meeting is scheduled on

Monday, July 1, 2019, 15:00 UTC

in the #docs channel on Slack

Current Projects Updates:

  1. Content Migration from Codex to HelpHub & DevHub – @atachibana
  2. HelpHub development – @milana_cap
  3. Inline Docs – @drewapicture and @atimmer

Ad Hoc pieces

  1. Use of the More Info section in Code reference https://make.wordpress.org/docs/2019/05/13/the-best-way-to-use-the-more-info-section/
  2. Centralised API handbook – https://meta.trac.wordpress.org/ticket/4376
  3. Who’s in the Docs Team? (Let’s continue to name people to this)

Open Floor

Feel free to comment if you have items to add to the agenda.

X-post: HelpHub & Handbooks Localisation

X-comment from +make.wordpress.org/meta: Comment on HelpHub & Handbooks Localisation

Summary for HelpHub meeting 17 June 2019

Attendance

@nao @Pieter @chetan200891 @justinahinon @jeffmatson @makewebbetter @felipeelia

Phase 1.5 Development

@milana_cap Fixed

  • https://meta.trac.wordpress.org/ticket/4267

and waiting the merge

  • https://meta.trac.wordpress.org/ticket/4491

Still Open

  • https://meta.trac.wordpress.org/ticket/4492
  • https://meta.trac.wordpress.org/ticket/4493

If you want to tackle these issues, read below article at first to construct the development environment.
https://github.com/WordPress/HelpHub/blob/master/CONTRIBUTING.md

Phase 1.5 Design

@ibdz waiting for response on these:

  • https://github.com/WordPress/HelpHub/issues/245
  • https://github.com/WordPress/HelpHub/issues/246
  • https://github.com/WordPress/HelpHub/issues/201

Comment your thoughts to each issue. In WCEU, these items will be discussed with design team.

Contents Redirection

HelpHub migration and redirection were completed.
Next our goal is redirection of developer related pages such as Function, Class and Hooks.
Refer this article for step by step guide:
https://make.wordpress.org/docs/handbook/code-reference/editing-articles/

Stats: https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=1576070270

Docs team agenda plan in WCEU

  1. HelpHub in i18n (@nao)
    It should be collaboration of docs, polyglots and meta
  2. New Handbook plan for common programming topics (@atachibana)
    Refer this proposal:
    https://make.wordpress.org/docs/2019/05/19/proposal-wordpress-developer-handbook-for-common-topics/

Agenda for HelpHub meeting 17 June 2019

Hello all,

Next HelpHub meeting will happen on

Monday, June 17, 2019, 15:00 UTC
  1. Attendance
  2. Phase 1.5 Check-in
  3. Detailed content discussions
  4. Docs team agenda in WCEU
    • What items should we discuss?
  5. AOB

Helpful Links

Summary for Docs Team Meeting 10 June 2019

Attendance

@kenshino @atachibana @clorith @softservenet @chrisvanpatten @aurooba @ibdz @johnbillion @juliobox @seedsca

@milana_cap provided pre-meeting update.

Content Migration

@atachibana reported all Phase 1 contents were migrated.

@kenshino requested a report about the status of redirection.

@atachibana reported all Phase 1, 2 and Version Text Content has been redirected as referenced on the sheet:
https://docs.google.com/spreadsheets/d/1PeHj7pSFLcdMbIC41JJdzEkl12TJT3mwWyzQv2mi01U/edit#gid=835534324

@kenshino requested an update on DevHub Redirection (ie: Codex to DevHub)

@atachibana supplied a tracking sheet and will be writing an Editing Guide for it: https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=0

@atachibana and @kenshino discussed coming up with a summary of remaining tasks as well as determining permissions for people to help at WCEU Contributor Day.

HelpHub Development

@milana_cap was not able to attend, but supplied a Phase 1 Dev Update:

We are still waiting for any kind of response on this one https://meta.trac.wordpress.org/ticket/4267

Is there anything we should or can do to make things get a bit faster merged for HelpHub?

Asked: @clorith if he’d have some time to help push Development decisions ahead as we have the Meta Team help now.

DISCUSSION:

@ibdz proposed a design related to ticket 4267
*with the below suggestions
https://github.com/WordPress/HelpHub/issues/245

-Sidebar navigation for HelpHub (match DevHub and overall wp.org Meta)
-Add breadcrumb
-The right sidebar should be more selective and link to main sections (not implemented in this design yet)
-Propose the accordion solution for “For devs” section

@kenshino asked the status of this proposal and it was discussed that this would be looked at during WCEU and that the Design Team may also have some input.

@ibdz said that we can do the patch for now, according to the latest update design in About page.

Gutenberg Handbook

@chrisvanpatten reported he is working on moving over to the `wp/` branch and cleaning up some of the code on the Gutenberg side and that he feels other than the backend docs infrastructure cleanup, the handbook content itself is “stable” at this point.

He invited anyone that has documentation ideas or requests, or want visibility on existing ideas, to feel free to create or comment on GitHub.

@kenshino thanked @chrisvanpatten and Contributors for their work and detail of the documentation and both confirmed that this should now be able to be moved to a regular check in.

@kenshino also requested @chrisvanpatten supply a list of those who worked on the project so that they can be assigned Contributor and Team badges.

Best use of the More Info field on DevHub

https://make.wordpress.org/docs/2019/05/13/the-best-way-to-use-the-more-info-section/

@kenshino commented about there being some notes about how to utilize this and asked @juliobox to map out his ideas on how to move ahead and move into giving him access to try working with these for a period of time and then look back for feedback. @juliobox expressed willingness to moderate the user_notes.

@aurooba has notes from when the conversation originally came up and will add them to the comments so that @juliobox can use these for his mapping of ideas.

Centralised API Handbook on DevHub

https://meta.trac.wordpress.org/ticket/4376

@kenshino stated we just need to agree to work on it and would if there were no objections forthcoming with the ticket.

Google Season of Docs

@kenshino reported that we did not end up participating in this for two main reasons:

1. Everyone who would want to participate needed to submit their own applications, and we couldn’t get it done in time.
2. We couldn’t find two people willing to act as the financial contacts.

*we’ll try again next time keeping this in mind, with more time

Who’s in Docs Team

@kenshino asked for people to volunteer for the draft list of Docs Team positions:

Docs Team Lead
• HelpHub Development Lead
• Content Lead
• User Notes (DevHub) Curator
• Theme Handbook Lead
• Plugin Handbook Lead
• More Info (DevHub) Curator
• Regular Contributor
• Design Lead

Even if currently holding the position, either DM @kenshino to re-volunteer for it or reply to the notes from this meeting.

He also asked that all people with Key Positions in the Team to go through the training @chanthaboune is proposing:
https://make.wordpress.org/updates/2019/06/03/team-lead-interest-post/

@clorith mentioned input is being solicited (for another week) on the team lead documents linked in the above post and everyone is welcome to provide input, or to voice their interest and take part.

Open Floor

@ibdz brought up the responsive table pattern (mobile) for HelpHub:
https://github.com/WordPress/HelpHub/issues/246

@kenshino asked @ibdz to determine who approves the designs and to advise and asked everyone to comment on the designs done by @ibdz