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

Summary of Docs Team Meeting March 8, 2022

Housekeeping

Project updates

Docs issue tracker

Updates for issues repo in last 7 days: https://make.wordpress.org/updates/2022/03/07/documentation-team-update-march-7-2022/

WordPress 6.0 release

Docs focus team for WordPress 6.0 release had a first meeting yesterday. If anyone likes to join, help with writing parts of docs, just watch the process, get involved in whatever form, you can do so by stating your interest in #docs 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/. channel or pinging @milana_cap (zzap in slack).

Everyone is welcome to join #6-0-release-leads; you might not be able to post but you’ll see the process and what’s happening.

End user 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 docs

General end user docs

  • new sitemap@estelaris wrote First review on the new Sitemap for HelpHub and needs feedback on it.
  • replacing hashtag@estelaris opened ticket with #meta for evaluating 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) issues and design for removing the hashtag https://meta.trac.wordpress.org/ticket/6171

Developer docs

  • technical parts removed from HelpHub@femkreations created a GH Projects that has the inventory of the technical parts that are removed from the end user docs https://github.com/orgs/WordPress/projects/26/views/1. It’s a work in progress. If you’d like to help, 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.” @femkreations (Femy in slack).

Needs feedback

  • First review on the new Sitemap for HelpHub – one of discussion questions – should FAQ articles live separately in FAQ category or be in their respective sections
  • Change article titles part 1it was recommended from Marketing team (@jonoaldersonwp) to change URLs as well and use 301 redirects – we have to ask in 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. for options to do this.
  • URLs for new HelpHub articles – we don’t have anything about this in Style Guide and @femkreations needs directions for those missing articles in 5.9. Proposed solution is to follow consistency where possible (e.g. adding -block for block articles and embed- for embed blocks) and leave other slugs to be created naturally from the title.

#summary

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 The Accessibility, PHP, JavaScript, CSS, HTML, etc. coding standards as published in the WordPress Coding Standards Handbook. May also refer to The collection of PHP_CodeSniffer rules (sniffs) used to format and validate PHP code developed for WordPress according to the PHP coding standards.. 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 22 February 2022

The next meeting is scheduled with the following details:

When: Tuesday, February 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. Best practices to handle GH tickets (who to contact when you are stuck, screenshots, etc)
  5. Documenting best practices and rules – discussion
  6. Open floor

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

#agenda#meetings

#meeting-agenda

Agenda for docs team bi-weekly meeting 25 January 2022

The next meeting is scheduled with the following details:

When: Tuesday, January 25, 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

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

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/