Agenda for Docs Team Meeting 2 September 2019

Our next Documentation Team meeting is scheduled on

Monday, September 2, 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. HelpHub localisation
  6. Common APIs Handbook – @atachibana

Open Floor

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

X-post: Component Maintainers in 5.3

X-comment from +make.wordpress.org/core: Comment on Component Maintainers in 5.3

Summary for HelpHub Meeting 26 August 2019

Attendance

@estelaris @kafleg @FahimMurshed @wizzard_ @softservenet @ibdz @felipeloureirosantos @justin @bph @kenshino @felipeelia @milana_cap @samikeijonen

Development

We discussed several issues today.

Excerpts on Archives

Last year it was proposed to replace auto generated excerpts with ToC list items. On today’s meeting discussion it’s been decided to use manually created excerpts which would contain the point of the article in one sentence. Short and concise. more meaning, less space.

Join discussion here: https://github.com/WordPress/HelpHub/issues/239

Posts Order on Archives

This was unsolved for a long time. We decided it’s important to order posts according to its content complexity so it resembles “Step 1, Step 2..” format or, if this doesn’t apply, to order according to post’s “importance”. As this is difficult to apply automatically to all categories we decided to use Post Attributes order and intentionally create order which we will specify in WP_Query.

As some articles have more than one category assigned, in which it might have different “importance” and order, we decided to make larger steps between posts using the same logic as menu items in dashboard. So two posts in a succession would have 10 places in between, rather than 1. This should also help with ordering articles published in the future.

Join discussion here: https://github.com/WordPress/HelpHub/issues/237

Single article mobile view

Viewing single article on smaller devices reveals the sidebar throughout the whole visible area. The rest of Handbooks solve this by hiding the sidebar altogether. @milana_cap suggested to place search form and single posts navigation instead of sidebar. For this single posts navigation to be useful, the order of posts (above) should be logical and intuitive.

@estelaris said that she’s working on templates and will discuss this issue on #design team meeting this Wednesday, as this is effecting all WordPress.org Handbooks.

Join discussion here: https://github.com/WordPress/HelpHub/issues/236

Design

@estelaris is working on overview of HelpHub design. Her analysis can be found in Google Spreadsheet: https://docs.google.com/spreadsheets/d/1ZnhtiLxqjXviFlnWsDE5L8YRiBXtkmanvM8doIc1lrg/edit?usp=sharing

After we agree on design template we need to have #accessibility review and usability test. @samikeijonen kindly accepted to perform these testings once we have everything ready.

Content and Rosetta Releases

We skipped these due to absence of key people.


Next Docs meeting is in #docs channel on

Monday, September 02, 2019, 15:00 UTC

You can take a look at the meeting transcript via this link: https://wordpress.slack.com/archives/C02RP4WU5/p1566831612366600

Agenda for HelpHub meeting 26 August 2019

Hello all,

We have missed a few HelpHub meetings because of schedule and Slack downtime – the next HelpHub meeting will happen on

Monday, August 26, 2019, 15:00 UTC
  1. Attendance
  2. Development (@milana_cap / @clorith)
  3. Detailed content discussions
  4. Design
  5. HelpHub rosetta release
  6. 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/

Agenda for Docs Team meeting 19 August 2019

Our next Documentation Team meeting is scheduled on

Monday, August 19, 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. HelpHub localisation
  6. Common APIs Handbook – @atachibana

Open Floor

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

Summary for Docs Team Meeting 12 August 2019

Attendance

@kenshino @milana_cap @atachibana @clorith @David Curtiss @bph @leogermani @juliobox @softservenet @audrasjb @chrisvanpatten @clorith

Development

We are waiting for @netweb to finish setting up SVN and GIT repos together. Meanwhile @milana_cap started working on https://github.com/WordPress/HelpHub/issues/214 Once the new workflow is completed regular bug scrubs will be scheduled again.

Mobile view of HelpHub is identified as making HelpHub hard to use so we are going to prioritize those fixes if we don’t get the git + svn work done by this week.

Content

There are no requests for new pieces that we need to write. @atachibana volunteered to follow the state of Block Editor user’s docs as it is still hard to be found by people. @bph volunteered to help. They will reach out to @karmatosed regarding improvements.

We would like to have some input from Support Team on obvious gaps for Block Editor Docs. @clorith will bring this up on their next meeting.

@leogermani did half of remaining redirects and updated the spreadheet, expecting to finish everything by the end of the week. @audrasjb volunteered to help, @juliobox is already on it.

Design

Skipped due to missing reps.

Rosetta Releases

Japaneese release gathered 11 volunteers. Serbian rosetta still doesn’t have HelpHub enabled. @kenshino will ping @sergey about this.

Open Floor

We currently have 288 user notes (DevHub comments) in queue. @audrasjb volunteered to help with reviews. @softservenet will start a spreadsheet of Docs Team’s ongoing tasks and members working on them. 

Next Docs meeting is in #docs channel on

Monday, August 19, 2019, 15:00 UTC

You can take a look at the meeting transcript via this link: https://wordpress.slack.com/archives/C02RP4WU5/p1565622003178300

#docs

Agenda for HelpHub meeting 12 August 2019

Hello all,

We have missed a few HelpHub meetings because of schedule and Slack downtime – the next HelpHub meeting will happen on

Monday, August 12, 2019, 15:00 UTC
  1. Attendance
  2. Development (@milana_cap / @clorith)
  3. Detailed content discussions
  4. Design
  5. HelpHub rosetta release
  6. 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 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.

X-post: Proposal: Auto-Update Old Versions to 4.7

X-comment from +make.wordpress.org/core: Comment on Proposal: Auto-Update Old Versions to 4.7

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.