Agenda for Docs Team meeting 16 September 2019

Our next Documentation Team meeting is scheduled on

Monday, September 16, 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 and @clorith
  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 HelpHub Meeting 9 September 2019

@kenshino @milana_cap @leogermani @kafleg @aion @softservenet @Pieter @audrasjb @estelaris @bph @joyously

Development

Development of HelpHub was blocked for 2 things and discussed:

@estelaris commented for HelpHub design:
https://docs.google.com/spreadsheets/d/1ZnhtiLxqjXviFlnWsDE5L8YRiBXtkmanvM8doIc1lrg/edit#gid=0
This is the document to gather all the requirements docs team has.

Design team review

They reviewed two things:

  1. mobile view
    https://github.com/WordPress/HelpHub/issues/235
    They agreed that it needs to change, so they are working on a template to be used by the entire WP.org ecosystem.
  2. anchor symbol
    They are thinking about using a similar treatment to GitHub. It will be global as well.

#needs-desing keywords for tickets

@estelaris added needs-design keyword to 3 trac tickets:

@estelaris will look into those 3 this week and will add screenshots

Improbements for archives

Docs Team did make some decisions on previous meeting that should improve usability of them

  1. Team agreed to use custom excerpts for each article – this is extra work for content but we can all help perhaps we can add another column to @atachibana ‘s document.
  2. Order of posts will be set manually because we want to make it contextual/complexity/step-by-step order
    This can’t really be automated and applicable to every category so we’ll use the order functionality in Post Attributes and @felipeelia already created patch for it.

Dev flow setup

@kenshino will catch up with @netweb.
@leogermani will test the documentation to get the dev environment up.

HelpHub rosetta release

Now, there are two releases: Serbian and Japanese.
Serbian team had HelpHub enabled on wrong site. It was disabled then and enabled on /support/ so they are ready to go.
Japanese team shared guide for getting started with this.

French, Brazil, Russia and some other countries are in the line for that activation.

HelpHub contents migration

@leogermani migrated content and hooks. Top 3 actions and filters (total of 6) were done and @millana_cap reviewed.

Open floor

@milana_cap suggested to have different people leading the meetings, Like rotating but more volunteering. We can call it a facilitator rather than “leading”. The agenda already mentions people sho will “lead” each topic.

@leogermani volunteered to lead the next HelpHub meeting, and @softservenet follows.

Agenda for HelpHub meeting 9 September 2019

Hello all,

The next HelpHub meeting will happen on

Monday, September 9, 2019, 15:00 UTC
  1. Attendance
  2. Content status @atachibana
  3. Design review – @estelaris
  4. Development (@milana_cap / @netweb)
  5. HelpHub rosetta release
  6. AOB

Helpful Links

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/