Sam Munoz 5:04 pm on October 11, 2022
Tags: , ,   

Summary of Docs Team Meeting October 11, 2022

Housekeeping

Attendance: @ninianepress @femkreations @milana_cap @colorful-tones @atachibana @estelaris @samanthaxmunoz @mayankgupta @webcommsat @bph
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/10/10/agenda-for-docs-team-bi-weekly-october-11-2022/
Meeting Facilitator: @ninianepress
Note Taker: @samanthaxmunoz
Next Meeting Facilitator (in two weeks): @estelaris
Next Triage Meeting Facilitator (next week): @ninianepress

Project Updates

It was a busy week for the 6.1 release cycle – many dev notes are published and some are still in review.

Release candidateRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. 1 is ready today as reported by @milana_cap.

@samanthaxmunoz has been 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 and the pattern is ready for review before it is added and documented – see Issue #474.

@femkreations reviewed 333 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/ from 13.1 through 14.1 with the User Documentation label and created 78 issues in GitHub for 6.1 User Documentation.

@femkreations also reviewed the About page draft and listed top priority tasks for the November 1st release. There are 25 items to do that ideally will be completed before the release of WordPress 6.1. The list is pinned to the #docs Slack channel.

Reclassification of End User Documentation

The reclassification of end user documentation has been finalized and there are now articles ready for content review.

In summary, the goal of the reclassification project is to re-organize the end user documentation and remove “too technical” content from end user documentation and/or merge it into developer docs.

An inventory of technical parts from end user documentation can be found here.

Related, 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/ Support is being renamed to Documentation – more information about that is available here, “Renaming WordPress.org Support to Documentation”.

Equal priority should be given to WordPress 6.1 documentation and the reclassification project.

Process in Project Boards Discussion

The team discussed the process for documentation project boards at length. As it stands there are only 2 columns, “In Progress” and “Review”, which are not clear and were discussed last week.

Various ideas were suggested about how to organize the project boards including separating into “new documentation” and “existing documentation”.

A consideration is that during Contributor Days often issues get screenshots and content updates in the comments of the issue, but the articles are not updated or assigned.

New columns have been added with temporary names such as “Text in progress” and “Screenshots in progress” but will likely continue to be refined.

The discussion will continue asynchronously or during the next meeting.

Open Floor

An Online Contributors Day for the Docs Team was discussed and will take place on October 25th starting at 10 am UTC.

@mayankgupta mentioned that DesktopServer has been discontinued yet is referenced in several documentation articles and has created an issue where mentions of DesktopServer are being noted.

#docs, #meetings, #summary

Nicholas Garofalo 12:21 pm on October 11, 2022
Tags: ,   

X-post: Renaming WordPress.org Support to Documentation

X-post from +make.wordpress.org/meta: Renaming WordPress.org Support to Documentation

Estela Rueda 8:04 am on October 10, 2022  

Agenda for Docs Team Bi-Weekly October 11 2022

The next meeting is scheduled with the following details:

When: Tuesday, 11 October, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Projects checks
  4. Reclassification of end-user documentation is finalized, we need help with articles content review
  5. Process in the Project Boards is not very clear, as of now there are only 2 separate status (in progress, review). We need a better process, discussion last week
  6. Open floor

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

#agenda, #meeting-agenda, #meetings

Estela Rueda 8:03 am on October 5, 2022
Tags: ,   

Reclassification of end-user documentation

The team did a second revision of the first recommended site map because we still found articles that should be moved to the developers documentation. The reason is that we want to keep the end-user documentation as clean as possible of developer jargon and make sure it only provides advice on how to use WordPress not how to alter it with code.

The main goal of article reclassification is to improve search and allow new articles to be added into the existing categories without creating a ‘miscellaneous’ categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging..

The first site map included 4 main categories and subcategories under each. The new recommendation maintains the 4 main categories, some subcategories have been renamed to better work in the future.

Link to the spreadsheet for better reading

The revision

As mentioned before, the review focused on removing all articles that were developer-focused. Some articles only require content review and move some of the too-technical parts. These parts were not discarded as they are still valuable information and will be moved to DevHub.

Categories and subcategories

The categories for end-user documentation were created to improve search, making it easier for the user to find the information. A secondary goal is to allow a continued learning path.

WordPress overview

WordPress Overview is the first category with 3 subcategories:

  • Where to start
  • FAQs
  • About WordPress

The intention of these subcategories is to provide a starting point for the new user and a quick access to resources to more seasoned users in the form of FAQs. About WordPress provides background information on how to become a contributor, WordPress’ history, etc.

Technical guides

Technical guides is the second category which includes 3 subcategories:

  • Installation
  • Security
  • Maintenance

Although the technical guides include topics that could be seen as developer-focused, there is some basic information that the end-user needs to learn about installing WordPress and working with their hosting companies, as well as maintaining a healthy and secured site.

Support guides

Support guides is the third category, also includes 3 subcategories:

  • The dashboard
  • Publishing
  • Media

These guides are all about the software, getting to know the moving parts of the front end, how to manage and publish content and media. The guides include articles for Classic Editor as well as the 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.

Customization

This is the fourth category and as the titles says, it is all about giving the site or blog the look and feel that the user wants. The number of subcategories increased to 9 and this will help with categorization as the FSE features and new blocks are developed.

  • Appearance
  • Default themes
  • Block Editor
  • Media blocks
  • Text blocks
  • Design blocks
  • Embed blocks
  • Theme blocks
  • WidgetWidget A WordPress Widget is a small block that performs a specific function. You can add these widgets in sidebars also known as widget-ready areas on your web page. WordPress widgets were originally created to provide a simple and easy-to-use way of giving design and structure control of the WordPress theme to the user. blocks

Related tickets

Because there are many moving parts on the site map, everything has been documented in tickets in the documentation issue tracker repository in GH

190Merge articles
192Change article title
373Delete articles from HH
388Move from HH to DH
425Content review duplicated article? Dimension Controls Overview
426FAQ’s content review
427Content review Finding WP Help
429Content review How WP processes post content
430Content review Creating a Search page
442Content review New to WordPress – Where to Start
443Content review Introduction to Blogging
458Content review Comments in WP
469Content review Video shortcodeShortcode A shortcode is a placeholder used within a WordPress post, page, or widget to insert a form or function generated by a plugin in a specific location on your site.
470Content review Weblog client
471Content review WP feeds
473Content review duplicate: WP.org vs WP. com
Tech partsInventory of Technical Parts From End User Docs

Next steps

The #docs team will collaborate with other teams to find the best way to make all the changes. So far, the hosting team is collaborating in moving articles to DevHub.

  • Create new categories and subcategories
  • Change title names to articles and create 301s for older URLs (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’s direction)
  • Merge pages and create 301’s
  • Delete pages and redirect to similar content pages/articles.

Other articles written as part of the redesign of HelpHub

Contributions

If you are interested in making any content review on any of the tickets above, reach out to @estelaris 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/. or leave a comment in the GH ticket.

Props to @femkreations for reviewing the many opened tickets. @milana_cap and @kenshino for reviewing the content. @jonoaldersonwp for providing SEO recommendations.

#helphub

LucP 3:04 pm on September 27, 2022
Tags:   

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

Jenni McKinnon 12:44 pm on September 14, 2022
Tags: , ,   

Agenda for Docs Team Bi-Weekly Meeting 27 September 2022

The next meeting is scheduled with the following details:

When: Tuesday, September 27, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda:

  • Attendance
  • Note-taker & Facilitator selection for Next Meeting
  • Projects checks
  • Do we add FAQs to HelpHub or not? See issue #426 (This requires @milana_cap and @femkreations to make a decision.)
  • Open floor

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

#agenda, #meeting-agenda, #meetings

Jenni McKinnon 12:43 pm on September 14, 2022
Tags: ,   

Summary of Docs Team Meeting September 13, 2022

Housekeeping

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

Project Updates

WCUS Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/.

@femkreations shared contributor day successes at WCUS which was on September 11, 2022:

WCNL Contributor Day

Yoast hosted a WCNL contributor’s day on September 14, 2022 at 10 AM – 4:30 PM UTC +2. It was available to join in-person, or online.

Open Floor

Issue When Editing Docs

@samanthaxmunoz pointed out that there’s an issue when you edit documentation pages in the back end:

  • Many pages are displaying the error message: “This 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. contains unexpected or invalifd content.”
  • The error is also displayed for pages that have recently been updated.
  • If you continue seeing this issue, please open a ticket in Meta.

There was also an issue brought up by @emmaht:

  • Some documentation has the block name italicized, while others don’t. (Post Author Block vs Post Author Block)
  • There doesn’t appear to be an answer in the Documentation Style Guide.

Answers are awaiting upon @femkreations’s return.

Reclassification Project

@estelaris let new contributors know that part of the redesign of end-user documentation (HelpHub) is removing any articles that are for developers and/or to remove any developer jargon that is in the articles. These such articles are being reclassified into categories that make more sense and migrating others to DevHub or developer documentation.

@javiercasares spoke about successes with the Advanced Administration Handbook over WCUS Contributor’s Day online over the past weeked:

  • @javiercasares opened 38 tickets, and 20 pages were formatted.
  • Content is being copied in HTMLHTML HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. from the HelpHub index, then created in markdown, and redirected to the Advanced Admin Handbook.

@javiercasares noted that the process for this is as follows:

  1. Create the structure. (empty files)
  2. Copy the original content into the new files, (using markdown) while changing the least amount as possible.
  3. Check all the pages for links, and old content, and try to renew it.
  4. Launch the new Handbook.

Noting that old pages in HelpHub will be redirected to the new ones in the Advanced Admin Handbook.

#meetings, #summary

Estela Rueda 9:25 am on September 12, 2022  

Agenda for docs team bi-weekly meeting 13 September 2022

Our next Team meeting is scheduled with the following details:

When: Tuesday, 13 September, 2022 at 04:00 PM GMT+2

Where: #docs channel on Slack.

Meeting Agenda

  • Attendance
  • Note-taker & Facilitator selection for Next Meeting
  • Project Updates
  • Do we add FAQs to HelpHub or not? See issue #426
  • Open Floor

#agenda, #meeting-agenda, #meetings

Javier Casares 10:27 pm on September 11, 2022
Tags: ,   

X-post: WordCamp US 2022 Contributor Day: Summary

X-post from +make.wordpress.org/hosting: WordCamp US 2022 Contributor Day: Summary

Javier Casares 11:10 am on September 7, 2022
Tags: ,   

X-post: WordPress Advanced Administration Handbook

X-post from +make.wordpress.org/hosting: WordPress Advanced Administration Handbook