Summary for Docs Team Meeting 30 September 2019


@kenshino @atachibana @nao @pieter @milana_cap @leogermani @softservenet @aion @estelaris @pascal

Content Migration (from Codex to HelpHub & DevHub)

@atachibana reported we are now redirecting Functions in Codex to Code Reference (DevHub). 210/849 25.8% (last week 24.5% accomplished)
Details stats are here:

Anyone can join these tasks by following below steps:

@kenshino suggested due to the volume that we work on picking up the pace and push to accomplish progress at the coming WCUS

@milana_cap suggested we might be able to create a Documentation Twitter and push requests for assistance and updates there to encourage more participation. @kenshino affirmed that this is a nice idea and will check with @chanthaboune first before we proceed.

@kenshino reported he will be at WordCamp Tokyo and @atachibana suggested that that his thoughts were to encourage work on the Japanese Codex Migration.

@leogermani reported he will be at WordCamp Sâo Paulo next week and would be able to encourage participation at the Dev Day there.

@leogermani reported he is slowly working on hooks content and some functions and has 4 actively in process at the point of the meeting.

@leogermani QUESTION:
If the examples that were in the hook/function in the codex were migrated to the User Contributed Notes, I’m leaving the hook/function explanation without the examples. Unless the function/hook has a very atypical usage that I find important to be added in the Explanation…

Some people already migrated the examples in the codex to the user contributed notes. So if added to the explanation they would be duplicated.

@milana_cap suggested for filters we could add examples, otherwise open the code itself and see what can be filtered.

@kenshino asked if this was related to the “More Info” section and suggested @juliobox is the rep for that.

@atachibana expressed thoughts that duplication is too much. Original concept was moving examples to User Contributed Notes.

@milana_cap expressed she’s not for duplication either, but if there’s no example at all
the generated docs doesn’t show what you can filter, more often than not she had to open code for that.

@kenshino also expressed that it should be understood that the User Notes could at some point be pulled into the Core “More Info” section if they’re written well and also expressed concerns about losing attribution. @leogermani confirmed that this is the reason for his being in favor of maintaining the User Notes and we are losing attribution on the text produced in the wiki that is being copied to DevHub.

@kenshino expressed that this is a topic that needs more discussion and feedback on P2.

HelpHub Development

@milana_cap reported we are on waiting for @netweb’s workflow and design changes from @estelaris and it doesn’t make sense to move on without design, as we might have to change things. There are already things that should be changed, such as the home page.

@kenshino will follow-up with @netweb

Inline Docs

No discussion.

Docs Team Handbook

@milana_cap reported that there is supposed to be a Zoom call on this to set responsibilities for different sections, so that reps maintain their parts of it (and for an overall review)

Design Update

@estelaris gave a quick update on design (the #design team reviewed the files and requested few changes. Last week was difficult as there was a major Beta focus. She also requested feedback on existing tickets.

She reported that the new design changes accomplish:
1. all articles show in one page.Could be set up to 2 pages max (easier for user to find article needed)
2. no more issues with number of rows for long/short excerpts and we don’t need to rewrite them
3. less distracting
4. breadcrumbs allows easy going back to home page without clicking back on the browser

@softservenet asked about the previous Icons on the Grid Design. @kenshino asked if the Icons could be put next to the title.

@estelaris reported she would work on a version with Icons and @kenshino offered we can reach out to the Dashicons Team to get SVGs for this.

HelpHub Localisation

@kenshino asked @pascal about progress. @pascal reported he’s waiting for a GO from someone to deploy all Rosetta sites that have support.

@nao reported she’s finished the Handbook:

@milana_cap reported the Serbian team started creating empty articles to be sure the URLs are correct, categories, personas etc. After that’s done they’ll start actual translating and call more volunteers to join. They’re also looking into a separate Contributor Day to do that.

Common APIs Handbook

@milana_cap reported she reviewed and updated Dashboard Widgets API during WordCamp Nijmegen Contributor Day, a week ago.

@atachibana provided the API Handbook Links Spreadsheet:

Changing the Nature of Docs Team Meetings

@kenshino suggested that the two meetings, Docs team and HelpHub again be combined to one as it seems that will be more productive after trying the other.

• Docs Team: HelpHub (40 mins) and other issues (20 mins)
• Docs Team: DevHub (40 mins) and other issues (20 mins)
• Docs Team: Docs Team Handbook (40 mins) and other issues (20 mins)

@pieter suggested to ping for status the morning of the meeting and adjust agenda accordingly.

@milana_cap brought up that DevHub and the Handbook are not getting enough attention

@kenshino suggested that with a pre-ping, stats could be supplied right at the start of the meeting.

@kenshino will work on P2 post to lay out some ideas and a possible change implementation time might be October 15 if we do in fact change the format.