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 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.

Agenda for Docs team bi-weekly meeting January 11th, 2022

The next meeting is scheduled with the following details:

When: Tuesday, January 11, 2022, 14:00 UTC

Where: #docs channel on Slack

Agenda

1. Attendance

2. Note-taker & Facilitator selection for Next Meeting

3. Projects checks – current status, where we need more people (some need reps as well).

  • WP releases – currently 5.9 – @mkaz
  • HelpHub content – @atachibana
  • 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
  • HelpHub feedback curating – currently without lead
  • 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 – @themiked
  • Theme handbook – @kafleg, @utz119, @poena
  • Common APIs handbook – @leogermani
  • Block editor dev handbook – @mkaz
  • Reference handbook – more info – @juliobox
  • Reference handbook – curating user contributed notes – @audrasjb, @crstauf
  • Docs team handbook – @milana_cap, @atachibana
  • Onboarding – @sukafia
  • Coffee breaks – @sukafia
  • Design – @estelaris
  • Docs style guide – applying – @tacitonic
  • External linking policy – @milana_cap and @themiked for Plugin Handbook
  • Docs issue tracker – have we started fixing reported issues?

4. Open floor

If there’s anything you’d like to discuss in open floor, please leave the comment below.

#agenda, #meetings

Meeting Notes: Theme docs updates for WP 5.9 and block themes

Who: @milana_cap, @mkaz, @utz119

When: Dec 8, 2021 @ 1500 UTC

What:

We met to discuss the upcoming 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. themes in WP 5.9 and where to document with relation to the existing Theme handbook.

Summary:

Block themes has a small call out as an experimental feature now on the first page of the Theme handbook. The next step is to update that page with a clear distinction between Classic themes and Block themes, a brief explanation about the differences, and links to learn about each. Classic themes links will continue to theme handbook, Block theme links will go to Block editor handbook.

Discussion:

We discussed what current documentation we have between the two handbooks. The ongoing goal will be to highlight the areas of overlap between classic and block themes and keep those in the handbook, try not to duplicate any documentation in either handbook, and use plenty of cross links so developers can find what they need.

We touched on some complexities with the Block editor handbook structure. The initial goal was teaching developers about blocks, getting them started learning and creating blocks. We need to look at information architecture and flow of the handbook to better help developers navigate. For with WP 5.9 features like block themes, theme.jsonJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML., styles and settings a developer can be greatly involved with topics covered in the handbook without having to create a block.

A larger project that needs to be tackled is the information architecture of all developer handbooks and documentation. Valuable content is being created and organized in various different areas in different ways, this makes it hard for developers to find what they need. For example, great developer content is created within Learn that is not cross-linked with developer.wordpress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/. Additionally, browsing the “Common APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways.” or “Code Reference” sections only return the 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. APIs when there is a large suite of JavaScriptJavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. https://www.javascript.com/. APIs in the Block editor handbook.

+make.wordpress.org/themes/

Summary of Docs Team Meeting: 7th December 2021

Attendance

@sukafiai, @estelaris, @mkaz, @atachibana, @kulsum, @mitchblue, @femkreations, @themiked, @milana_cap

Housekeeping

  • Meeting Facilitator: @estelaris
  • Note Taker: @sukafia
  • Next Meeting: Tuesday 14 December 2021
  • Next Meeting Facilitator: N/A
  • Next Week: Docs Issue Triage

The meeting started with a warm welcome from @estelaris and the focus was on projects progress, blockers and next steps. Here are the project updates:

Helphub update

@estelaris informed the team that MetaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. and the design team are working on a full redesign for WP.org and that she’ll be working with them to follow the new design style guide for HelpHub.

She mentioned she also needs to do a review on the article-page requirements since some things have changed, e.g feedback at the end of an article: are we still using it or are we expecting users to report feedback in GH?

@femkreations indicated she’ll b collaborating with @estelaris since she’s currently working on moving the technical details from the HelpHub document and updating the articles.

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

@Mkaz reported the primary focus is on WP 5.9 release. He added there’s a lot to do such as tracking the progress of user docs and dev notes.

He mentioned the biggest blocker is that most of the engineers who need to write the Dev Notes are still doing finishing touches around bugs, so haven’t circled back to the docs.

Team handbook

@Mkaz informed the team he and @milana_cap will be having a meeting tomorrow with the Theme’s team to discuss what the docs team can do for the Theme handbook with regards to the upcoming WP 5.9 release and its major change to block themes. He added that anyone who’s interested in joining the meeting should see this thread and 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 for an invite.

Docs Style Guide

@estelaris mentioned that applying the new style guide to all previous articles is happening as people including her, @femkreations, etc. are reviewing the articles and adding them to the issue tracker in 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/.

It was concluded that whoever is rewriting articles, should apply the style guide and @atachibana and @milana_cap should be contacted for articles reviews.

Open Floor

  • New meeting time@femkreations asked if 14:00-15:00 UTC is a good meeting time for everyone and if members would be open to 15:00-16:00 UTC? Most members indicated that 14:00-15:00 is a good time for them and it was agreed that this should be added to the meeting summary so other members can air their views.
  • New members onboarding@milana_cap asked about the status of the new members onboarding project and @sukafia responded he’ll check with @chaion07 since he’s been absent for a while.
  • Holiday break@estelaris asked if the team will be taking a break during the holidays and @milana_cap responded that this should be discussed in the December 21st meeting.

Docs team bi-weekly meeting December 7th, 2021

The next meeting is scheduled with the following details:

When: Tuesday, December 7th 2021, 02:00 PM UTC

Where: #docs channel on Slack

Meeting Agenda:

Today we are reviewing all projects: progress, blockers and next steps. If you are working on any of the following projects, please feel free to add your update to the comments here or attend the meeting.

Projects:

  • HelpHub in general
  • 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
  • HelpHub feedback curating
  • 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
  • Theme handbook (we’ll have meeting with theme team soon, I have to check doodle)
  • Common APIs handbook
  • Block editor dev handbook
  • Reference handbook – more info
  • Reference handbook – curating user contributed notes
  • Docs team handbook
  • Docs style guide – applying
  • External linking policy
  • WP releases – currently 5.9
  • Docs issue tracker – have we started fixing reported issues?

We won’t have time for open floor, but if you have any issue, please add it here.

#meeting-agenda

Summary for Docs Team Meeting: 23 November 2021

Attendance

@chaion07, @Femy, @mitchblue, @milana_cap, @bedas, @mkaz, @Courtney, @peteringersoll, @estelaris.

Housekeeping

  • Meeting Facilitator: @chaion07
  • Note Taker: @bedas
  • Next Meeting: 07 December 2021, Tuesday
  • Next Meeting Facilitator: N/A
  • Next Week: Docs Issue Triage

Project Updates

@mkaz continues working on this issue https://github.com/orgs/WordPress/projects/11/

@milena_cap continues her work on Common APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. handbook.

@Femy continues to work on Removing technical details from user docs and rewriting them.

@mkaz mentioned tweets in regards to requirements to update DOC (themes) in regards of Blocks, this issue is forwarded to @poena, @acalfieri and @kafleg.

@mitchblue has started working on screenshots. Additional help is welcome to tackle the issues listed at https://github.com/WordPress/gutenberg/issues?q=is%3Aopen+is%3Aissue+label%3A%22%5BType%5D+Documentation%22 or https://github.com/WordPress/Documentation-Issue-Tracker/issues.

@estelaris mentioned that a new video would be required to explain the purpose of a Blog better and in a more up-to-date fashion. 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. task here https://trello.com/c/cfDu3rtG/358-blogging-with-wordpress.

@peteringersoll is introduced as new member of training team and being in charge of relaying information across DOC and Training Teams.

Thanks to @bedas for preparing the notes. Unfortunately he wasn’t available to publish the notes which is why I am publishing this on behalf of him.

#meeting-notes, #meetings, #notes, #summary

Agenda for Docs Team Meeting 23 November 2021

Our next Team meeting is scheduled with the following details:

When: Tuesday, November 23, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Project Updates
  4. Revision of Projects that have been put on hold
  5. Open Floor

#agenda, #meeting, #meeting-agenda

Summary for Docs Team Meeting November 9, 2021

Attendance

@milana_cap @mkaz @juanmaguitar @chaion07 @muhammadfaizanhaidar @kafleg @atachibana @mitchblue006

Housekeeping

Find the complete Transcript of the meeting on Slack.

Please note: Next week (16.11.2021) shall be  “Issues Triage Meeting” and thereafter (23.11.2021) “Docs Team Meeting”.

@chaion07 will facilitate this meeting and the agenda will be revision of projects that were put on hold.

Project Updates

5.9 Release (Documentation)

@mkaz is the Docs Lead for WP 5.9 https://github.com/orgs/WordPress/projects/11/. Integration of custom spreadsheets may be used for future releases as default. 

@mkaz made “Doc Type” properties to 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. by Dev Note, User Docs, or Dev Docs.

Additional help welcome as @audrasjb  @milana_cap @annezazu are also working on this release.

@milana_cap also mentioned today is feature freeze, and closed tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets as well as planning in writing docs should be considered.@mkaz is the go to regarding this.

Open Floor

@muhammadfaizanhaidar  is awaiting response with https://github.com/WordPress/Documentation-Issue-Tracker/issues/47, @milana_cap suggested waiting for @estelaris to respond.

@milana_cap mentioned that content from Themes handbook could be combined and updated https://developer.wordpress.org/themes/theme-security/using-nonces/.

#meeting-notes

#docs, #meetings

Summary for Docs Team Meeting October 26, 2021

Attendance

@kenshino @mkaz @mburridge @juanmaguitar @chaion07 @ashiquzzaman @donaldwmoorejr @muhammadfaizanhaidar @kafleg @atachibana @femkreations @sasiddiqui

Housekeeping

Find the complete Transcript of the meeting on Slack.

Open Floor

5.9 Release (Documentation)

@mkaz will be the Docs Lead for WP 5.9 with help from @audrasjb and @zzap on coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. docs, and @annezazu for user docs

@femkreations @mburridge offered to help with these docs

Design refresh for Org sites

@mkaz comments the MetaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. team is working on a design refresh for Org sites starting with /News, see work-in-progress here: https://wordpress.org/news-test/

They are building them as 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. themes, with the idea of other handbooks would be child themes off them.

Licensing Legal Text

 @chaion07 comments a few weeks back we were discussing on Licensing Legal Text with Josepha to assist us (saw this in the #team-reps channel)

@kenshino says the text is expected to be with the lawyers this week because GutenbergGutenberg The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/ docs are also on WordPress.org, it makes things slightly more complicated

The main issue is that general contents are CC0 and code is GP, but Gutenberg is also dual-licensed – GPLGPL GPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. + MIT, so this info has been passed to the lawyers for them to sort out

#meeting-notes

#docs, #meetings

Agenda for Documentation Team Meeting October 5, 2021

The next meeting is scheduled with the following details:

When: Tuesday, October 5, 2021, 14:00 UTC

Where: #docs channel on Slack

Meeting Agenda:

  1. Project Updates
  2. 15 min repo triage/ If needed
  3. Open Floor

Please feel free to suggest agenda items by commenting on this post or raising it during Open Floor.

Thank you!

#meeting-agenda