Summary for Docs Team Meeting 5 August 2019

Attendance:

@kenshino @milana_cap @atachibana @netweb @clorith @ibdz @leogermani @casiepa @kartiks16 @softservenet

Content Migration from Codex to HelpHub & DevHub:

@atachibana provided update spreadsheet:
https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=0

Redirection has been started from Codex to DevHub (Code Reference) and writing down detail steps so that other contributors can follow.
There are two types of items:
1. simple redirection
2. After some inline docs modification and redirection
*in case of 2, contributors need knowledge of Trac

@kenshino asked for statistics. @atachibana reported below:
18.93% (170/898) of Functions have been redirected.
@kartiks16 offered to help with the continuance

@kenshino asked if Hooks had progress. @leogermani reported that he’s started working on them, mapping what needs to be done.
(Hope to get 50 most accessed ready to redirect this month)

@leogermani posed a question:
see this example: https://codex.wordpress.org/Plugin_API/Action_Reference/pre_get_posts
There is a related article section down below, and other related links to the docs.
What do you think is best to do? Keep the links pointing to the codex? are they being migrated as well?
*”related articles” section

@kenshino replied that most are already likely in DevHub.
(The Loop is likely an article in Theme/Plugin handbook for example
Code Documentation – some of them could already be redirected)
@kenshino suggested to take this as an overall epic task to redirect/migrate code references that aren’t already
*and also finish the example posed in the question at the same time

@leogermani looked for this one and didn’t find. “query overview” -> https://codex.wordpress.org/Query_Overview
@atachibana suggested it should be included in Common API handbook.
*general programming topics are covered by it

@leogermani asked for another tab to be added to the tracking spreadsheet in order to track these, @atachibana confirmed he will do this.

@kartiks16 offered to help in this process

@kenshino asked if WP_Query was redirected yet. @leogermani reported it is and pointed out that some h3 titles are not being added to the TOC for some reason.

@atachibana pointed out that If there are no other I18N pages, then automatic redirection tag will be inserted. In this case, other language pages exist so there is a link

HelpHub Development:

@milana_cap: While working on trac patches I realised that having separate git and svn repo is a small nightmare so I’ve been looking for a way to work on them in the same local repo. I’m writing bash script to make it easier for everyone else to get this set up in their locals, for both, first timers and people who already have installations.

@netweb reported that he has making these synced to make contribution easier on his task list.

@milana_cap posed her idea to have one branch in out github repo dedicated to production, where we would create the actual svn patches. @netweb liked the idea.

@kenshino and @milana_cap agreed since @netweb has already been working on a plan for this scenario, that he and @sergey be involved.

@kenshino and @mailana_cap reported lost ssh access on HelpHub Staging. @clorith reported that he has it and should be able to add back, will look at when back from being off.

Docs Team Handbook:

@milana_cap suggested that in order to get this together, that it be split so that appropriate people are responsible for their part of it. @atachibana is already spearheading editing HelpHub content parts.

@kenshino suggested a Zoom call after the HelpHub Meeting.

Rosetta Sites – HelpHub Deployment Progress:

@casiepa reported Japan is done: https://meta.trac.wordpress.org/ticket/4575
*Meta is waiting for some fixes before further installs, such as the planned Serbia.

@netweb was asking for documentation on this. @kenshino reported one of the issues were the article slugs, which is done now.

@casiepa reported being ready to deploy all active from the moment the green light is given (and some basic instructions if required)
Serbia is planned first, then there are 6 or 7 following that are on the list. Then there will be a transition to deploying all the Rosetta sites that have /support active.

@kenshino suggested giving the proper time to gather feedback after Japan and Serbia.

Centralised API Handbook:

@kenshino asked for updates on the API Handbooks and also the WordPress.tv API inclusions. @casiepa reported these are actively on his task list and @atachibana reported he will be following as well.

@kenshino suggested @atachibana nominate somebody to lead the effort. First step could very well be moving the common topics over e.g. – The Loop, Internalization, etc.

@leogermani offered to help with the internationalization topic (he’s already been looking into this and had discussions with Polyglots at WCEU).

Who’s in the Docs Team:

@kenshino reconfirmed the list of current Docs Team Members from July.

-HelpHub Development Lead: @milana_cap, @clorith
-HelpHub Developers: @felipeelia @ajitbohra @audrasjb @carl-alberto @kafleg @wizzard_ @softservenet @mukesh27 @william68
-Content Lead: @atachibana
-User Notes (DevHub) Curator: Open
-Theme Handbook Lead: Open
-Plugin Handbook Lead: Open
-More Info (DevHub) Curator: @juliobox
-Regular Contributor: @aurooba, @leogermani
-Design Lead: @ibdz, @estelaris
*Since then, @acalfieri has come in as Theme Handbook Lead
*Docs Team Handbook Lead will also be @milana_cap and other leads are expected to help in relation to their parts

@milana_cap and @kenshino will work to define details on Doc Team Handbook on Zoom call.

@kenshino suggested that the label “Lead” may be redefined as it can cause confusion with the Make /WordPress Team Leads.

Agenda for Docs Team meeting 5 August 2019

So we missed our last meeting because Slack went down exactly at our meeting time. Let’s make sure it happens this time!

Our next Documentation Team meeting is scheduled on

Monday, August 5, 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
  5. Rosetta Sites – HelpHub deployment progress

Ad Hoc pieces

  1. HelpHub localisation
  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.

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.

Proposal: WordPress Developer Handbook for common topics

In DevHub (https://developer.wordpress.org/), we have Code Reference, Theme developer handbook, Plugin developer handbook, etc. but some topics are independent from those categories and quite common. For example,

What about creating the “WordPress Developer Handbook” for these common topics?

What’s the best way to use the More Info section?

Hello there, I’m Julio Potier. Long time contributor here and there, I loved to contribute to the french and english (old) codex.

Now it’s time to move on and use the new dev site.

However since it’s not a wiki anymore, we lose the possibility of total freedom. At the same time, we won an automatic parsing/filling !

Also, user notes (comments) are useful at the bottom of a page, it’s like php.net with the difference that a Doc team member has to verify and validate it.

BUT because there is a but, this is the point of this post. Sometimes there is a “More Informations” at the end of the page, before the users notes. Check that one for example, it’s my ideal case and I love it:

For me, the interest is the same as php.net : provide a few examples of usage, some do&dont, some tips&tricks.

But not as a user notes, this is not “official” enough, anyone can add a user note, why would I trust one?

But this section is part of the page, the examples are (again) like php.net, THE examples.

So, I’m here to ask : do you/we want to keep that and let people of the doc team contribute to this “More Infos” box? Because I would like to help.

Voilà I would like to do this when I encounter a page that could need some examples. Of course, I’ll/can add user notes, it depends on the context.

So, I raise my hand to handle this, I appreciate your feedback on that 😉

Agenda for Documentation Team meeting 10 June 2019

Our next Documentation Team meeting is scheduled on

Monday, June 10, 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. Gutenberg Handbook – @mkaz and @nosolosw

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. Google Season of Docs Update
  4. Who’s in the Docs Team? (Let’s actually name people to this)

Open Floor

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

Agenda for Docs Team meeting 27 May 2019

Our next Documentation Team meeting is scheduled on

Monday, May 27, 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. Gutenberg Handbook – @dryanpress and @nosolosw
  5. Google Season of Docs – @chanthaboune

Ad Hoc pieces

  1. Use of the More Info section in Code reference – https://make.wordpress.org/docs/2019/05/09/more-informations-on-doc-need-your-feedback/
  2. Centralised API handbook – https://meta.trac.wordpress.org/ticket/4376
  3. Who’s in the Docs Team? (Let’s clarify this!)

Open Floor

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

Agenda for Docs Team meeting 13 May 2019

Our next Documentation Team meeting is scheduled on

Monday, May 13, 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. Gutenberg Handbook – @dryanpress and @nosolosw
  5. Google Season of Docs@chanthaboune

Ad Hoc pieces

  1. Use of the More Info section in Code reference – https://make.wordpress.org/docs/2019/05/09/more-informations-on-doc-need-your-feedback/
  2. Centralised API handbook – https://meta.trac.wordpress.org/ticket/4376
  3. Who’s in the Docs Team? (Let’s clarify this!)

Open Floor

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

Summary for HelpHub meeting 6 May 2019

Attendance

@kenshino @milana_cap @atachibana @mkaz @kartiks16 @SallyinStC @felipeelia @tomf @kafleg @ibdz attended

Phase 1.5 – Development

@milana_cap outlined some VVV (local development tool) issues with Ubuntu 14.04 hitting end of life (EOL). It’s not absolutely a blocker to continue contribution work but it isn’t ideal.

@milana_cap also outlined 2 items that should receive a decision so that development work can start on it (small pieces)

  • https://github.com/WordPress/HelpHub/issues/237
  • https://github.com/WordPress/HelpHub/issues/231

A bug scrub was conducted on April 26 and the notes are available here – https://make.wordpress.org/docs/2019/04/28/helphub-bug-scrub-notes-26-april-2019/

Content Migration

@atachibana announces that migration of Phase 2 content is 100% complete.

@naomibush helped to transfer 19 Version (WordPress version notes) pages at WordCamp Atlanta, where she was leading the Doc team’s contributor day table.

@justinahinon added 4 new block editor pages based on classic editor docs.

As also discussed in the last Docs Team meeting, we’re shifting focus on the content front to doing redirections.

Gutenberg Developer Handbook

While not related to HelpHub, we also talked about the Gutenberg Dev handbooks that are being migrated to DevHub (developer.wordpress.org)

@mkaz outlined the following tasks that need to be done to release the handbook to the public

  1. Merge final PRs
  2. Publish to DevHub
  3. Confirm everything looks good
  4. Work with #meta to add redirects and disable previous auto-sync
  5. Confirm all looks good over week or two and rename to have just one manifest and retire old handbook

HelpHub Localisation

There have been technical suggestions from the meta team and I think we’re going to wrap up on what the Community and Docs team suggest as a first step.

We haven’t done that officially but I think we’re still going to recommend setting up the HelpHub plugin on Rosetta sites (other handbook CPT for community team) so that people can actually translate content right away.

If GlotPress becomes the tool we can use for long form translation, we can shift back to it when needed

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