Summary of Docs Team Meeting September 27, 2022

Housekeeping

Attendance: @ninianepress @femkreations @milana_cap @colorful-tones @leonnugraha @dpknauss @lucp @estelaris @samanthaxmunoz
Where: #docs channel on 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/.. Find the complete transcript of the meeting on Slack.
Agenda: https://make.wordpress.org/docs/2022/09/14/agenda-for-docs-team-bi-weekly-meeting-27-september-2022/
Meeting Facilitator: @ninianepress
Note Taker: @lucp
Next Meeting Facilitator (in two weeks): @estelaris
Next Triage Meeting Facilitator (next week): @milana_cap

Project Updates

The documentation for WordPress release 6.1 is getting off the ground. Adding a comment to this issue will ensure that you get pinged once it gets started.

@femkreations also reports that the issue gardening for 6.1 is in progress from 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/ PRs.
Currently they have 19 To do items and 1 In progress in the 6.1 Project board.
The team closed 5 issues in GH for 6.0 and more will be reviewed and closed this week.

@emmaht has reviewed these two issues:
https://github.com/WordPress/Documentation-Issue-Tracker/issues/225
https://github.com/WordPress/Documentation-Issue-Tracker/issues/226

This week @leonnugraha and his colleague will work on this issue and this one.

@colorfultones is keeping an eye on this issue to see if it gets backported with the 6.1 release correctly.

@lucp talks about the new Advanced Admin handbook and how old content-migrations from HelpHub have now been included as PRs, specifically these issues that @femkreations has submitted.

And @estelaris reports about the reclassification project:
The sitemap revision/comparison is finally finished. A post is in the works.
She did a lot of content revision and opened a lot of tickets.

FAQs at the bottom of HelpHub pages

This discussion was scheduled for this meeting and connected to this github issue. While everybody agreed that doing content-review for this content is smart (and 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 all the too technical stuff), the question remained on wether or not to put FAQs at the bottom of pages or give the FAQ its own section. The team eventually landed on creating a seperate FAQ section, which @estelaris will incorporate into the design.

Open floor

@samanthaxmunoz has compiled a list of high-priority issues mostly surrounding the documentation of WordPress 6.0, which can be found here

@femkreations has a similar list of WordPress 6.1, but it’s in a Github Project.

@samanthaxmunoz is also working on a 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. pattern for block documentation as discussed in this Slack thread. It will get converted into an issue with the new label internal task

Summary of Docs Team Biweekly Meeting August 30, 2022

Housekeeping

Attendance @milana_cap, @estelaris, @lucp, @femkreations, @chaion07, @greenshady, @leonnugraha, @robinwpdeveloper, @colorful-tones and @samanthaxmunoz (async).
Where: #docs channel on 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/.. Find the complete transcript of the meeting on Slack.
Agenda: https://make.wordpress.org/docs/2022/08/30/agenda-for-docs-team-bi-weekly-meeting-30-august-2022/
Meeting Facilitator: @chaion07
Note Taker: @lucp
Next Meeting Facilitator (in two weeks): @estelaris

Triage next week:

Project Updates

Reclassification

@estelaris posted an update about the reclassification project. The team is still working on the sitemap.
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 was asked for the latest sitemap for documentation (as it was 2 weeks ago when @estelaris received it). And when the two sitemaps got compared there was a discrepancy of about 20 articles. So @estelaris has been going over them one by one. The total now stands at 300+ articles.

There’ll be tickets for any article that requires content review as well as a list of articles that should be moved to Devhub entirely.

WordPress version docs

@femkreations shares updates on the docs for new WordPress versions:

  • The 5.9 Project board is officially closed.
  • Work on the 6.0 project is in progress: 3 new pages added, 7 pages updated
    Doing content review and updating pages in the HelpHub based on @estelarisfeedback: Pages have been rewritten with new content and screenshots.
  • Prep for 6.1 is ongoing: Adding “User Documentation” label for the closed PRs in 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/. Completed for 13.1 and 13.2.

@leonnugraha and @wigno will be working on these issues this week, further documenting the new blocks in 6.0:
https://github.com/WordPress/Documentation-Issue-Tracker/issues/237
https://github.com/WordPress/Documentation-Issue-Tracker/issues/226
https://github.com/WordPress/Documentation-Issue-Tracker/issues/225

Advanced Admin

The advanced admin handbook is in the works. It’ll be a collaboration between the #docs and #hosting teams. @javiercasares created a very extensive sitemap for the new handbook, which can be found here: https://docs.google.com/document/d/1fVIw3DztzyVY18RDPCGk-kDYTO6gzHtx81o7aitGijo/edit

There’ll be a discussion during both the WordCamp US and the WordCamp the Netherlands contributor days about this handbook and how to make this as concrete as possible.

WCUS contributors day facilitator

@milana_cap, @femkreations, @bph and @welcher will all be there. They’ll share the role of facilitator.

@estelaris will add tags to issues that are good things to tackle during a contributor day: good first bugs, things that are easy to spot and get to. Many of them first need to be reviewed.

There’s also the i18n and escape errors in codex and user generated examples that can be tended to.

Open floor

Nothing on the open floor this meeting.

Kick-off WordPress 6.1 release docs

Thank you for participating in the kick-off meeting for the WordPress 6.1 release documentation team: @milana_cap, @femkreations, @mburridge, @bph (facilitator and notetaker). @webcommsat participated asynchronously and added input from the video. 

The meeting was recorded and is available on YouTube.

Updated August 11: refined the instructions to match the GitHub Tracking issue for 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 PRs.

TL;DR: Follow the progress

Links to relevant information.

Next Steps and process for 6.1

Triage Phase

DevNotes and Developer Documentation

  • Add ‘Needs Dev Note’ label to tickets in milestones, and 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
  • Trac tickets ‘needs-dev-note’
  • 🙋‍♀️ Triage TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets – Milana
  • GitHub (Gutenberg) needs dev note
  • 🙋‍♀️ Triage Gutenberg plugin PRs – Birgit

End User Documentation

  • Add '[Type] User Documentation' or needs user-doc labels to Trac tickets and Gutenberg PRs and all will be tracked via the 6.1 Project for both (trac + 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/)
  • GitHub Gutenberg [Type] User Documentation
  • 🙋‍♀️ Add labels to PRs on Gutenberg – Femy
  • 🙋‍♀️ Trac Tickets to be labeled with needs-user-docs: Milana

Tracking

  • Add ‘needs dev note’ / ‘needs dev docs’ tickets to the project – Milana
  • Create issues for pages once the scope of user-facing features tracked with [Type] User Documentation is determined – Femy
  • Track Gutenberg needs dev note via the Tracking issue on GitHub and connect with developers regarding delivery – Birgit
  • Reach out to the Component Maintainers for the “But Wait there is more” tickets – Birgit. Abha, if extra hands needed

Delivery and Collecting the Dev Notes Tasks

After BetaBeta A pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process. 1, it will be pretty clear which patch and PR will make it into the WordPress 6.1 release. It would help tremendously if dev notes are drafted between Beta 1 and Beta 2 (for 6.1, this will be between September 20 and 27, 2022). This will help the reviewers have more time to give it a fuller review.

Stand-along Post

If a dev note requires a separate post, the process is slightly different between dev notes concerning the Gutenberg project and developers who provided a patch on trac.
The instructions for dev notes on Editor features are listed in the GitHub Tracking Issue for DevNotes

For developers who provided commits via trac also draft the dev note on Make Blog, and once drafted, the developer should add a message to the docs channel, with the public preview link to let the team know it’s ready for review.

For small dev notes for a combined post

If only a small dev note is required, it will be published with other notes in a combined post (Miscellaneous Block Editor, or Miscellaneous Theme, Miscellaneous Caching). The developer assigned will add the dev notes as a comment to the particular PR or the Trac ticket.
Trac tickets also are then labeled with has dev note.
For the GitHub PRs the developer should post a comment on the GitHub tracking issue
The release documentation team will review and collect those for the Miscellaneous blog posts.

Tasks for release documentation team:

  • provide author privileges to developers who write dev notes
  • collect the small notes from the PRs and organize them on Miscellaneous Dev Note posts
  • collect snippets from the Component Maintainers’ responses
  • compile the Field Guide
  • assist in triaging, prioritizing and recruit writers for End User Documentation

How to get involved? 

End User Documentation updates

With new features coming to WordPress, the majority of help is needed in triaging, scoping and executing changes to the end user documentation for the block editor. Femy Praseeth @femkreations, a documentation team project rep and one of the co-leads of the 6.1 release documentation team, is the contact point if you can help with one of the areas listed below.

  • Triaging: join in on labeling user-facing Gutenberg PRs for End-User Documentation
  • Issue Gardening: once all issues are reviewed, create issues in Documentation Issue Tracker repo for End-User Documentation, adding information from the PRs to the description
  • Writing: add and edit identified pages of  End User documentation 
  • Taking screenshots (Training video)

Abha will support Femy in triaging, prioritizing and recruiting writers for End User Documentation.

Write and review 6.1 Dev Notes

In the next few weeks, Abha will co-ordinate additional steps to help those writing dev notes, including information on adding excerpts, a summary paragraph at the top of the post, the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. style guide, and avoiding using ‘here’ for links which are difficult for 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), etc.

Developers of release features which will be relevant for other developers will write the dev notes or the relevant section to include into a collection of dev notes. If you are assigned a dev note, drafting it on the Make blog between Beta 1 and Beta 2 would be great. Please do not publish the dev note until it has been through its review stages. It will be published by the Release Documentation Team and the GitHub entry updated.

Each dev note requires two people to review, plus final review by the documentation release team. If you like to review other people’s writing, reviewing dev notes could be for you! 

Find out more

As the team is just starting to get all the pieces in place, they might not have all the answers yet.

Please don’t hesitate to comment below or send a message via the Make 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/. #docs channel 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.” either @femkreations, @milana_cap or @bph.

Props for reviewing the post: @webcommsat, @milana_cap, @femkreations, @audrasjb

#6-1, #dev-note, #meetings, #summary

Summary of Docs Team Biweekly Meeting July 5th, 2022

Housekeeping

Projects checks

DevHub & Learn WordPress development

  • The #meta team is working on improvements to DevHub (the developers documentation). If you have any suggestions, please comment on this post
  • There is also an x-post from the Learn team. Again, if you are interesting in either collaborating or have ideas, please comment. The docs team is actively contributing with the Learn team.

Open Floor

  • @mburridge wanted clarification on whether to continue creating 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 Handbook issues in the Documentation-Issue-Tracker. (see issues #379 and #75).
  • While the Block Editor Handbook falls under 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/ team, @milana_cap mentioned in one of the issues that we might as well gather all issues regarding the Block Editor Handbook in the Documentation-Issue-Tracker while the docs team is preparing to send over a larger issue to the Gutenberg team with all sorts of improvements.
  • Similar issues as #379 and #75 should be posted in #docs so the team can take a look at it. @milana_cap later clarified the point on slack

Props to @greenshady for helping with notes.

#summary

Summary of Docs Team Biweekly Meeting June 21, 2022

Housekeeping

Open Floor

Docs Onboarding Videos

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

@lucp and @milana_cap:

5.9 Issues for HelpHub

@femkreations:

  • Issues with WordPress version 5.9 for the HelpHub are being worked on.
  • Later, the issues will be merged into the 6.0 project.
  • A lot of images don’t have ALT text and this needs to be emphasized for adding screenshots to HelpHub articles.
  • @milana_cap noted that ALT text is mentioned in the docs team Handbook.
  • A list will be added for this to the GitHub Issue Template for resolving on WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. contributor days.
  • An extra phase in the content review process will be added to address this issue.

@milana_cap will add a link to the list on the Leading a Contribution Day Handbook page.

Props to @ninianepress for writing the notes.

#summary

First review on the new Sitemap for HelpHub

Following up on the post Explorations of a new classification for user documentation, we suggested to create 4 pillars (categories) and subcategories. My suggestion is to keep the subcategories to the minimum and add as many articles as needed, this will allow the system to grow as needed.

The 4 pillars in HelpHub

The 4 suggested pillars with their own subcategories are:

  1. WP Overview
    • About WordPress
    • Resources
    • FAQs
  2. Technical guides
    • WordPress installation
    • WordPress multisites
    • Configuration
    • Maintenance
    • Security
    • Troubleshooting
  3. Support guides
    • Get to know the dashboard
    • Publishing
    • Media
  4. Customization
    • Appearance
    • Default themes
    • Classic Editor
    • 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
    • Common Blocks
    • Formatting
    • Layout elements
    • Theme Blocks
    • Widgets
    • Embeds

What has been done

During Google Season of Docs 2020, there was a project to reclassify all the articles, change article titles to follow the new style guide being written at the time and review the content (including links, outdated content, etc).

These are some of title changes given and the team will discuss the next steps to either change the affected URLs or not, but that is for another post.

Due to the rotation of contributors and the team focusing on other issues, the revision of content is still ongoing. If you would like to help out, join a meeting or reach out to @femkreations on 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/, @Femy on Slack and she will guide you.

The new titles and the reclassification has been done. We will continue to include articles that are still to be written, as well as any new article.

The first draft

This is a first draft of the Sitemap and we need your help to make sure articles are in the correct categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. or if there is anything else we need to add. You can leave your comments on this post or in the Draft of the Sitemap linked above.

What is up for review

  • Category names
  • Subcategory names
  • Articles classified in the correct category/subcategory

What is not for review

  • The four pillars (the title yes, but we won’t be adding anymore pillars)
  • Order of articles under categories nor order of subcategories (we will review them at a later time)
  • New name titles for articles (these were given during GSoD and have been already reviewed and accepted/rejected by the #docs team)

Other articles written as part of the redesign of HelpHub

If you would like to contribute or have any questions, reach out to @estelaris on Slack or leave a comment.

Props to @milana_cap for peer review.

#helphub

The hashtag and its future in documentation articles

In a previous post, we listed the requirements for the new design for HelpHub. This article is going to discuss one particular requirement, the hashtag at the end of the headlines inside an article.

Basically, we want to remove the # character from the headlines. It may be a radical change but it is necessary for 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) reasons.

First of all, let’s mention the requirements to remove or replace the hashtag. The function must be:

  1. Clear on purpose
  2. Easy to read with keyboard
  3. Reduce visual noise
  4. Not polluting the link’s list for screen readers

The hashtag is used at the end of a headline in the articles as seen in the image below. In order to define its future, we need to understand its behavior.

Image of a headline including the hashtag

The hashtag is a link; the anchor is the H2 in the example above. It’s the anchor element, but it’s the link behavior, so it is ambiguous.

Technically, anchor refers to the target of an on-page link. This appears to be a link that gives easy access to identify the URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org that will give you access to the current location on the document. That’s…actually kind of complicated.

What about accessibility?

The icon of the character used is not as important as communicating the function of the link. Right now, the # has aria-hidden=true label, so it won’t be read at all.

<h2 id="requirements-on-the-server-side" class="toc-heading" tabindex="-1">Requirements on the server side <a href="#requirements-on-the-server-side" class="anchor"><span aria-hidden="true">#</span><span class="screen-reader-text">Requirements on the server side</span></a></h2>

Link to the code page, line 196

It’s backed by screen reader text that duplicates the heading title, but is also nested inside the heading; this means that the heading text will be read  (e.g.) “Recommended setup Recommended setup”.  It’s creating duplicate text nested inside the heading and does not expose any visible text to explain the purpose.

The options

After some research, I have found several options for replacing and/or removing the hashtag.

  • Adding the link to the heading with a character
  • Making the heading a link
  • Replacing the hashtag with a fly-out menu

Adding the link to the heading, as used by GitHub,  where the link is currently the method to expose the link to that section. It can also be linked from the topics table, at the top of the article. We would have to make sure the implementation is accessible to others besides sighted mouse users.

The link element can be added at the beginning of the headline.
The link element can also be inserted at the end of the headline.

Adding the link to the heading is reasonable and the simplest solution to replace the hashtag, as it will simplify the problem: the functionality will be clear and the visual noise would be reduced considerably.

There are arguments against providing links that point to themselves, however, as it can make a confusing interaction. One of the arguments against this method is that it pollutes the link list on a screen reader. The way the hashtag is presented now, already pollutes the screen reader’s link list.

Replacing the hashtag

Replacing the hashtag with a fly-out menu, as explained by the w3.org. The w3.org recommends using the fly-out menu to meet WCAGWCAG WCAG is an acronym for Web Content Accessibility Guidelines. These guidelines are helping make sure the internet is accessible to all people no matter how they would need to access the internet (screen-reader, keyboard only, etc) https://www.w3.org/TR/WCAG21/.. The fly-out menu removes the need for multiple page loads. The biggest disadvantage is for people with reduced dexterity who can have trouble or it could be almost impossible to operate fly-out menus,which can be prevented with the correct implementation.


Video showing how the fly-out menu operates

The design above would be changed to meet the 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/ design style.

Removing the Symbol

Is removing the symbol entirely an option? Another recommendation from w3.org is placing the interactive elements in an order that follows sequence. This means adding a table of contents which will link to the interactive element, the headline in this case. Basically, the way it is right now but without the hashtag.

Video showing mouse-click to headline and the URL pointing to that headline

References

We would like to hear from you. Do you have another solution that could meet all the requirements?

Props to @ryokuhi, @joedolson, @milana_cap, @jillmugge for peer review.

Update 8 March 2022

We are moving the discussion to a meta ticket to discuss options and accessibility.

#accessibility, #docs, #helphub

Summary of Docs Team Meeting Jan 25, 2022

Attendance

@estelaris, @kafleg, @milana_cap, @atachibana, @femkreations, TC, @kenshino, @themiked

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 page titles and urls

In the future, we should be able to be able to change page titles/urls /301s. For more detail refer this discussion and @estelaris‘ two tickets:

Now, we should keep current page titles and urls.

WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. EU 2-4 June

@milana_cap will lead the Documentation Team at Contributor Day.

Do contribution and get a cookie!

#summary

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

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