Summary of Docs Team Meeting Aug 3, 2021

Housekeeping

Attendance

@milana_cap, @femkreations @chaion07@basilh, @tacitonic, @johnbillion, @estelaris @themiked, @jrf  @fierevere 

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator:  @milana_cap

Note Taker: @femkreations

Project Updates

@tacitonic – No updates for the Style Guide. 

@milana_cap – DevHub feedback code to be done by next week.

Please refer to the Summary for details on the tool for handling the issues with documentation such as if docs are out of date, has an error/typo, etc.  For suggestions (and questions), please leave comments on this post 

@femkreations – Working on the GB end-user docs updates based on the 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. board for the WordPress release 5.6. The goal is to clean up the board and move everything to the new tool we’re going to decide on.

@estelaris – Will be back next week to continue cleaning up the project.

Open Floor

Discussion 1: 

@johnbillion is looking for someone to run the WP parser (which constructs all the function, method, and hook documentation on the dev site) over trunk after 51529 (51530, 51531, and 51532) and check that the docs for the affected methods are still parsed correctly. 

Some annotations have been added in between the phpdoc 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. and the function itself, so we need to make sure that, with the extra annotation immediately above the method, the phpdoc block gets detected and parsed correctly. If it breaks, the annotations need to be moved to, before the phpdoc block. 

If anyone has documentation on setting up parser or would like to help out, please share in the #docs channel. This needs to be completed before the 5.9 release.

@jrf  added: WordPress-Docs uses only “upstream” PHPCSPHP Code Sniffer PHP Code Sniffer, a popular tool for analyzing code quality. The WordPress Coding Standards rely on PHPCS. Commenting sniffssniff A module for PHP Code Sniffer that analyzes code for a specific problem. Multiple stiffs are combined to create a PHPCS standard. The term is named because it detects code smells, similar to how a dog would "sniff" out food. at this time and she has submitted fixes for those sniffs to PHPCS and those PRs have been merged. She expects PHPCS 3.6.1, which will include the fixes, to be released before PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. http://php.net/manual/en/intro-whatis.php. 8.1/WP 5.9, so we should be good. She still has to review if there are any sniffs within WPCSWordPress Coding Standards A collection of PHP_CodeSniffer rules (sniffs) to validate code developed for WordPress. It ensures code quality and adherence to coding conventions, especially the official standards for WordPress Core. that need adjusting and will be addressing them soon.

Discussion 2: 

@basilh raised the question: How can one track the progress of a query submitted through the feedback form at the button on a support article. 

@milana_cap added: When the issue is reported, depending on its complexity, it is either fixed right away or an issue is opened in the GitHub repo for Helphub

Many of them are either spam or support questions that should be asked in forums and we don’t have enough people to respond to them in a timely manner. If anyone is interested in this position, please 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.” @milana_cap.

@atachibana is in charge of general end-user docs and we’re still working on the block editor end-user docs, all of which are the WordPress articles in the HelpHub

@fierevere added:  She has cleaned spam, made sure that spammers are banned, deleted support questions, and fixed simple issues for HelpHub, and will report more complicated issues in the #docs channel on Slack