Summary of Docs team meeting Apr 5, 2022

Housekeeping

Project updates

WordPress 6.0 End User Documentation 

@bph created a list of changes coming to WordPress 6.0 that would need End-User Documentation. She is waiting for the 13.0 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/ 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 release happening on Friday 4/8 and the walk-through before completing the list and setting priorities. Currently, some of the sections are not fully curated and some PRs might not be user-facing. She hopes to have the list completed by Monday, April 11th.

@milana_cap to start creating GitHub issues in the tracker repo from the list, once the list of changes is finalized. She also created 2 priority levels for the tasks: High and Medium.

@estelaris noted: Contributors who work on End-User Documentation need to follow the style guide such as using sentence case for headings and adding the word ‘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.’ to the title and URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org for all the block pages.

@bph to start wrangling PR authors for their Dev Notes for the release and the Field guide.

@bph/@milana_cap to go through all TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets to collect all DevNotes, dev and end-user docs. They will also update the Contributors-wanted post and share the post on the internet.

Other updates

@estelaris: Work on the HelpHub is progressing well. The 301 redirects issue will be fixed for wordpress.org and will be on the list of features for the next release. HelpHub sitemap has been approved by Josepha and the Docs team.

@estelaris is currently working on the HelpHub design. The Docs team reviewed the first draft in the meeting. Once the design is approved by the design team, it will be shared. And the next step will be to redirect articles (changing titles/URLs/merging articles, etc).

@milana_cap: recorded onboarding session. She will upload it to wordpress.tv after she edits out a section. She did some work on triaging Trac tickets for 6.0 docs. She also reviewed quite a few block editor end-user issues.

@femkreations: Added more new pages to the Block Editor End-User Docs for the missing block pages for the 5.9 release.

@themiked: Updated a plugin handbook page.

#meetings

Working on WordPress release 6.0 – Selecting Trac tickets for DevNotes

As you might know, we have entered WordPress 6.0 release cycle. Important part of it is going through all TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets and selecting those for documentation.

There are 3 types of documentation created for release:

  • End user documentation – updates to HelpHub
  • Developer documentation – updates to DevHub
  • Dev notes – published on #core blog and then gathered in release Field Guide

During last Documentation team meeting attendees showed interest in seeing how this is done so I’ll be doing a live session in a Zoom call. Everyone is welcome to join.

Session will be recorded for everyone who can’t make it and wants to see it later. See you soon 🍪

#meetings

#release

Summary of Docs Team Meeting March 22, 2022

Housekeeping

Project updates

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 documentation updates for 5.9:

We are currently updating the documentation to 5.9

@femkreations: Currently adding new pages for the various blocks that are missing in the end-user documentation. Completed 7 pages and will continue working on this.
@rmartinezduque: Worked on the Pinterest embed and Wolfram embed block pages.
@atachibana: Updating the end-user docs with screenshots and images.

if anyone wants to join, please chose one of these issues: https://github.com/WordPress/Documentation-Issue-Tracker/projects/3. The board also has Good First Issue label on issues, to help you get started.

WordPress 6.0 documentation:

@bph is working on the Dev notes board. She also went through the 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/ 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 releases to prepare the list of needed end-user documentation changes for 6.0. This document will be done by the end of the week with one Gutenberg plugin release (13.0) to go for 6.0.

@milana_cap to go through the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. tracs and add tickets to the Dev notes board. She will make it a zoom call so anyone who wants to see how it’s done can join. The date/time for the zoom call will be announced beforehand in a blog post (coming soon) and the process will also be recorded.

Others:

@bph created a Trac ticket for the modification needed on developer.w.org/news for the Developer News Blog  (Proposal

#meetings

Agenda for docs team bi-weekly meeting 22 March 2022

The next meeting is scheduled with the following details:

When: Tuesday, March 22, 2022, 03:00 PM GMT+1

Where: #docs channel on Slack

Agenda

1. Attendance

2. Note-taker & Facilitator selection for Next Meeting

3. Projects checks

4. Open floor

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

#agenda, #meeting-agenda, #meetings

Agenda for docs team bi-weekly meeting 8 March 2022

The next meeting is scheduled with the following details:

When: Tuesday, March 8, 2022, 03:00 PM GMT+1

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Projects checks

@femkreations has the floor

For the URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org for the new pages in the HelpHub, is there anything specific to keep in mind while creating the URL?

@estelaris has the floor

Reviewing the re-categorization and renaming of some articles.

4. Open floor

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

#agenda, #meeting-agenda, #meetings

Summary of Docs Team Meeting Feb 22, 2022

Housekeeping

Project updates

@milana_cap:  Updated the following 2 articles to 5.9.

The future of the hashtag in documentation articles

@estelaris: Please read the post about the hashtag, and share your comments and questions. The accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) team supports any of the ideas in the post. She will be discussing further with 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. The post has been flagged to Josepha for Matt’s attention as we need his approval to apply any of the solutions.

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 doc pages inventory on GH projects

@femkreations:  The inventory for the block editor end-user docs is ready in GH Projects. She will open new trackers for the 56 pages that are missing in HelpHub based on the inventory.

Adding tips section to docs

@milana_cap: We are deciding whether we want to offer “best practices” kind of advice to docs. These best practices would not be our personal opinions, but ones collected from dev notes, other teams, opinions of the majority/most experienced, and a general guide of what works. 

ACTION ITEM: @milana_cap to write a P2P2 P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. to discuss this further and get opinions from other teams. 

Some things to consider: Whose opinions should be considered for making the best practices and what happens if they disagree?

Best practices to handle GH tickets (who to contact when you have issues/questions when documenting):

This item came up as a contributor posted in the #docs channel on Slack that he was having issues with screenshots quality and his comment went unanswered.

ACTION ITEM: We could add a list of team reps’ names in CONTRIBUTING.md maybe in the issues template.

Question by @mitchblue006: For this issue, when creating screenshots is it ok to use a dummy account?

@milana_cap: As long as it is the correct WordPress version, fresh install with no additional plugins, no themes or languages changed, dummy account is fine

She also shared this awesome app https://app.instawp.io/login. You can choose 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. and WP versions and the installation lives for 72 hours, after which you can revive it and the content will be preserved.

Documenting best practices and rules

Based on a discussion started here, which code standard should code samples adhere to?

@themiked: the answer was WordPress-CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. but WordPress-Extra is better. He re-visited every page in the 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 and fixed the code samples to be compliant.

@milana_cap: For plugin/theme development you should really compile to WordPress Coding StandardsWordPress 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.. We need to present the code in docs by WordPress-Extra coding standards. This is applicable mainly for the docs maintainers.

@estelaris: Do we need to add this tip somewhere so all contributors are aware of it?

Open Floor:

Discussion 1: 

@femkreations: Related to this tracker – removing the technical content from the HelpHub where will the removed technical parts go, as she starts making the updates to end user docs? 

@milana_cap: They will go into some/few of devhub handbooks, depending on the topic.

ACTION ITEM: @femkreations to create a GH project to track the removed technical parts- where they came from and an open column that tracks where they are going.

Discussion 2:

@milana_cap: To revive docs team coffee breaks, and use it partly as onboarding calls if new contributors like to join. We will try them for a couple of months and see results.

ACTION ITEM: @milana_cap to set up a doodle to start.

#meetings

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

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

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