Summary of Docs Team Meeting April 19, 2022

Housekeeping

Review of the design for documentation 

The design team has reviewed the design. We are waiting on Josepha’s approval. The mobile version is not ready yet as there are a few items to be resolved. 

  • We now have 4 categories for the content and a submenu with the 4 categories, displayed at the top so users can easily navigate. 
  • The breadcrumbs are included as part of the left navigation (the blue square on the top left). The first 3 lines are the breadcrumbs, followed by the headings in the article. We also have another option (on the 3rd article example) where the breadcrumbs are horizontal, at the top of the TOC 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..

Please add your comments here or in the slack channel.

Discussion 1: @femkreations: How are we handling the Changelog section since some of the Changelog entries are long?

@milana_cap: suggests not to delete the Changelog as it’s a history of the WP docs.
@bph: The Changelog is also used for translation and some locales might be behind on the pages.
@ibdz: We can have 2 different font sizes- one for the parent <li> (date) and one for secondary level <li> (content) to keep it aesthetically pleasing.

It was decided to add pagination to the Changelog. It is accessible and we can limit the number of entries per page, keeping the newest entries on page one and the oldest on page 2.

Discussion 2: @milana_cap: Would the definition list be semantic markup for the Changelog?

 @mburridge suggests the details disclosure element

Discussion 3: @estelaris: What about the FAQs that are on some of the block articles? Are we going to keep them there or can we extract them and create a new FAQs section under resources?

@milana_cap: Thinks all FAQs should be in FAQs and articles that currently have them could link to them.
@atachibana: Suggests keeping it as is, to reduce the cost, and also create independent pages of the FAQ.
@ibdz: Thinks from the user’s point of view, it’s good to have the FAQ attached to the page.

Project updates

@milana_cap:

  • Closed a few more 5.9 block editor end-user issues.
  • All tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets are labeled for docs and GitHub project is ready.
  • We have a new channel #docs-firehose for getting GitHubGitHub GitHub is a website that offers online implementation of git repositories that can can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ updates so that we keep the #docs channel clean

@femkreations:

  • Triaging the Google Doc and creating the Tracker issues for 6.0 end-user documentation.
  • So far, 40 trackers have been added for 6.0 End User Documentation.
  • Will complete the triage by the end of the week.

@estelaris:

All the block editor articles listed in the inventory have been added to the new sitemap.

Open floor

@estelaris and @femkreations to review the following two pages: Block Editor and WordPress Editor to make sure they are not repetitive and if so, merge and delete one. @atachibana: Suggests renaming WordPress Editor to Classic Editor and keeping with TinyMCE.

@milana_cap gave a talk about Docs at WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Athens in person.

@milana_cap to lead the Docs table at the Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. for WCEU.

#meeting