Michael Burridge 2:45 pm on January 12, 2022
Tags: ,   

Summary of Docs Team Meeting Jan 11, 2022

Attendance

@milana_cap, @daisyo, @atachibana, @kafleg, @mburridge, @estelaris, @jdy68, @wizzard_, @utz119, @juanmaguitar, @mitchblue006, @femkreations, @kenshino, @sukafia

Housekeeping

Project Updates

A full transcript can be found in the #docs channel in the Making WordPress SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/.

  • HelpHub content
    • thanks to @annezazu, HelpHub is getting new pages relating to V5.9. Those pages will be translated via #polyglots team.
    • @atachibana highlighted the need for auto-changelog – this is a topic for future discussion.
    • future plans: re-design of HelpHub, adding TOC or index into side bar area – however global design changes are coming.
  • 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 end user docs
    • currently without lead in case anyone wants to volunteer.
    • a large amount of work is still outstanding here, tasks need to be moved from 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. to GitHubGitHub GitHub is a website that offers online implementation of git repositories that 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/ while filtering out what’s no longer relevant and keeping what is still relevant.
    • @milana_cap will start working on that this week and allocate some time each week until a new lead volunteers to own the project and can then continue the work themselves.
    • @atachibana will also help with this.
    • @jdy68 expressed interest in helping.
  • HelpHub feedback curating
    • currently without lead in case anyone wants to volunteer.
    • comments are coming in but someone is needed to curate them, filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. out the spam and support and move the relevant ones to GitHub.
    • @esteleris has been helping out.
    • if anyone wants to be responsible for managing these comments, @milana_cap is willing to explain everything in detail.
  • PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party handbook
    • future plans: needs to be updated with the style guide.
    • it has been “blockified” already but still needs external linking.
    • @themiked plans to create a plugin which will form the basis for a progressive tutorial – this is still in the preliminary stages.
  • Theme handbook
    • in addition, some typos, old links, and other minor things have been updated.
    • @milana_cap asked whether there is any content on converting a classic theme into a block based theme, but @kafleg reports that content on block themes has not been started on yet. There are, however, plans to create a list of topics.
  • Common APIs handbook
    • @milana_cap stated that she has ideas for this one and will create a GitHub issue for it.
  • Reference handbook – curating user contributed notes
    • there are currently 38 pending comments.
    • 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  if help is needed on this.
  • Docs team handbook
    • there’s a requirement to go through this handbook and see what’s missing/outdated/etc…
  • Onboarding 
    • @sukafia acknowledges that this has been on hold for a while. Previous work will be reviewed and next steps decided on.
  • Coffee breaks
    • @sukafia acknowledges that this has been on hold for a while. Previous work will be reviewed and next steps decided on.
  • Design
    • WP.org is getting a full redesign, @estelaris now has access to the style guide and will change the previous design of HelpHub and hopes to present the new redesign at WCEU.

The following projects were not addressed, either because the lead was not present or because we ran out of time.

Would the leads of those project please reply in comments on the agenda, thanks.

#summary