Summary for Docs Team Meeting on February 15, 2021

Attendance

@collinsmbaka, @bph, @aurooba, @estelaris, @tacitonic, @atachibana, @chaion07, @crstauf, @sukafia, @poena, @themiked, @nahidsharifkomol

Housekeeping

Project Updates

End User BlockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. Editor team

Updates by @bph

Scheduled Sprint

February 25th, 2021 with two time slots, 14:00 – 16:00 UTC (9 to 11 EST) and 21:00 – 23:00 UTC (6 to 8pm EST)

  • To get the task list together, onboard new contributors, update TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. Cards, and progress follow up with experience contributors.. There will be a Zoom call with demos, screen sharing, and Q&A.

Updates for 5.7 release

  • @geheren and @bph have been working on identifying user facing changes and cluster them per section.
  • Updates are happening for existing pages with a link to the More Options page, and to reduce the duplicate content. When touching all pages, the feedback section is also opened up on all pages. @collinsmbaka and @bph will rally the troops on #meta-helphub
  • To Do: We need to come up with a process for the comments to tally them and see the nature of the problem and how to solve them.

Design

Updates by @estelaris

The comments for the requirements for a new design for user documentation were closed yesterday. There was a discussion with the design team about the anchor icon, in particular, and a decision was made to design a new icon to replace the current ‘#’ icon, further explanation can be found here.

@estelaris is working on the new navigation and post about that part, but needs help. There are many articles (at least 170) that need to be reviewed for old/broken links. To help review them:

  • View the list of articles in this Google doc, in the “List of Pages” tab. The results of the review should go into the “Link Review” tab.
  • Please do not fix any links, that is the job of @atachibana and his team, and any changes need to be approved by them
  • If you have any questions, pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” @estelaris in Slack.

Full Site Editing Documentation

Transcript bookmark

Planning of Full-Site Editing (FSE) documentation is ongoing (for the 5.8 release). Contributors are needed who know FSE deeply and can teach the rest of the team how it’s supposed to work. Thanks to Tom Rankin for working on the outline. @bph will be publishing a blog post with a call for contributors.

Before the meeting, @milana_cap mentioned, “As a team, considering the way documentation is structured currently, we have to come up with our proposal where FSE (Full Site Editing) documentation should live.”

There was a healthy discussion around how the FSE documentation should be structured and how FSE should be defined. As @bph described, there are 3 parts to FSE documentation:

  1. Themes need to be built for it. A theme must support FSE for it to be available. This information needs to be available in the Developers Handbook.
  2. There is the user facing site for those who have access that should be in the User facing documentation on Help Hub.
  3. Documentation for site builders who build sites for others. There is no current space for this yet.

@poena pointed out there are a lot of overlaps between these 3 aspects, since users, site builders, theme developers, and theme designers all will use the editor to assemble blocks.

@themiked felt FSE should be a single page with links pointed towards discussions on how to use it within the desired context: theme handbook for themes, user handbook for users, etc. Ultimately, we can link to respective spaces when needed and create a bridge pages to interlink the different areas. The key issue here is to make the documentation easy to discover. @bph brought up the Fireside chat at WordCamp India, where @chanthaboune and @matt talk about FSE.

This is an undecided topic, which needs a dedicated post for feedback.

@bph will have a post out about user-facing documentation for FSE before February 25.

New Member Mentoring

🎉 Five new members joined the Docs channel this past week and were welcomed by @sukafia.

The mentorship team met last week Thursday on Zoom to plan and set goals for the year.
(If you’re not familiar with the team, you can read the initial proposal here to learn more.)

Monthly Coffee Break

February’s Coffee break is scheduled for Thursday, February 25th, being planned by @sukafia and @chaion07; a post with the zoom link and details will be published later this week.

Google Season of Docs

Updates from @tacitonic

Open Floor

Today is the last day to submit questions for the Full Site Editing call for questions.