Tag Archives: docs

estelaris 2:20 pm on January 23, 2023
Tags: docs   

Support, forums, training or documentation

There are several ways to find information regarding the features or issues in WordPress and each one of them has a function and a time. This is a short explanation of what each means, the difference and when to use them.

What is what?

A good way to differentiate them is to define them and to provide use cases for each. None is better or worst than the other neither is any more or less important. It all depends on when they are used.

  • Support is 1:1, requires interaction and it is used for more urgent issues, whether is a chatbot or person and is immediate.
  • Forums are intended for broader help or best advice on specific topics. Most of the time is asynchronous but is monitored by a team or person, paid or volunteer. Most importantly, forums are community driven.
  • Documentation are basically instructions on how to do things. There is no interaction of any kind for questions. Literally, “what you read is what you get.”
  • Training creates lessons on topics. These can be on video or written form. Can be individual or part of a series. And training can be immediate or in the user’s own time.

Some use cases

Users require information for different reasons and search for it in different ways.

For instance, hosting companies use support, either by chat or call, to resolve a user’s issue. Whether is urgent or not, it usually is something that the user cannot solve by themselves or it has an immediate need for solution.

The forums are topical and in threads. They are very useful for discussions and to provide guidance over an issue or topic. Forums are monitored and conversation are mostly asynchronous. Some of the uses could be a school discussion group, product sales, best practices, product help, product how-to’s, etc.

When a user wants to learn fairly quick how to do something, following the steps in a documentation article is the best way. There are no interactions and the user reads it in their own time.

In opposition to wanting to deeply learn about a subject, then the user would search for a training lesson or course.

What can a user find in 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/

WordPress.org does not provide support. There is no team that will reply to questions 1:1 at any time. Instead there are the Forums that are monitored by contributors, volunteer and paid, that reply to questions posted.

There is documentation for end-users and developers and there are training lessons offered in Learn.

It is a strong recommendation by the documentation team to stop using the word support and instead refer to each instance with their respective name.

Props to @milana_cap and @atachibana for the review of this article.

#docs

Jenni McKinnon 2:16 am on January 13, 2023
Tags: docs, ,   

Summary for Docs Team meeting, January 10, 2023

Attendance

@ninianepress @milana_cap @leonnugraha @femkreations @atachibana @thisisyeasin @estelaris @wigno @vanpariyar @kartiks16 @samanthaxmunoz @ninthcoder @daisyo @webtechpooja @onlykawshar

Housekeeping

Find the complete Transcript of the meeting on Slack.

Moving HelpHub to the New Site

@estelaris is working 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 to replace the /support site with the /documentation site. The new URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org is expected to be ready after January 17, 2023. In the meantime, contributors should refrain from adding, editing, or publishing content on the /support site as they will be lost.

Read this post for more information.

Project Checks

@leonnugraha – Reviewed and published #234 and #314

@milana_cap – Almost completed the Team roles page(s)

@ninianepress – Finishing an update that was supposed to be done by the end of 2022

@wigno – Completed #506, and it’s now ready for review. Will plan to work on #508 and #502 this week

Topics for the 2023 WordPress Community Summit

We should think, as a team, of possible topics for the Community Summit. What are the Documentation team needs that can, in full or partially, be solved in an environment where all other teams are present? 

@estelaris proposed the following topic: How will we collaborate with polyglots to translate the documentation and help them create the new sitemap? We need to push for translations. Otherwise, a lot of our work will stagnate as an English version only

@ninianepress wants to submit a topic that @milana_cap mentioned during last year’s WCEU – about a waterfall solution across teams for everyone to be able to collaborate on projects across all teams. @milana_cap added an example that the Training/Learning team has been discussing for a long time with the Docs team on how to make a tool that would help us all communicate better about release changes.

@atachibana pointed out several workflow issues for the HelpHub that can be improved. Through the discussions, we agreed that we could discuss these issues internally within the Docs team.

Open Floor

@wigno volunteered to review and publish documentation content. @leonnugraha will help him to get going.

@milana_cap has an idea for three little tools that should help with some workflows and will build something to test out:

  • Meeting agenda generator
  • Meeting summary generator
  • New contributor orientation tool/onboarding tool

@estelaris will ask the meta team about the users’ access when the /documentation site is live.

Props to @leonnugraha for writing this meeting summary.

#docs, #meetings, #summary

estelaris 6:42 pm on January 7, 2023
Tags: docs   

There is work in progress in HelpHub (Documentation)

This post is to ask everyone who has access to HelpHub, to please refrain from adding, editing or publishing old or new articles as of the writing of this post.

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 the replacement of the /support/ site for a /documentation/ site and whatever is not there as of today, will be lost.

Please hold off any updates until after 17 January 2023. If you have any questions, reach out to @estelaris on #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/. or leave a comment below.

Niels Lange 2:24 pm on November 2, 2022
Tags: docs, ,   

Summary of Docs Team Meeting November 1, 2022

Housekeeping

Attendance: @milana_cap, @chaion07, @atachibana, @nielslange, @kafleg, @leonnugraha, @lucp, Malcolm, @femkreations, @colorful-tones, @dpknauss, @bph, and @estelaris
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: n/a
Meeting Facilitator: @milana_cap,
Note Taker: @nielslange
Next Meeting Facilitator (in two weeks): @femkreations
Next Triage Meeting Facilitator (next week): TBD

Project updates

  • @nielslange fixed broken code formats of the theme-related docs (see https://github.com/WordPress/Documentation-Issue-Tracker/issues/531).
  • @femkreations worked on WordPress 6.1 pages (see https://wordpress.slack.com/archives/C02RP4WU5/p1667311973175699).
  • @colorful-tones created a Trac ticket related to Block Patterns (see [#6556: Consider allowing Make teams to create block patterns](https://meta.trac.wordpress.org/ticket/6556) ).
  • @leonnugraha is planning to work on [HelpHub Remove redundant block name from “settings” panels · Issue #513 · WordPress/Documentation-Issue-Tracker · GitHub](https://github.com/WordPress/Documentation-Issue-Tracker/issues/513).
  • @femkreations mentioned that 44 pages of [6.1](https://github.com/orgs/WordPress/projects/45/views/2) and 14 pages of [6.0](https://github.com/orgs/WordPress/projects/28/views/11) have the status `Todo` if all issues for 6.0 should be moved to 6.1. @milana_cap then raised the question if the issues can be merge theme seamlessly.
  • @nielslange mentioned that a few issues of 6.0, that are in `Todo` should be in `Ready for Review` and volunteered moving the corresponding issues to the correct column.
  • @milana_cap mentioned that the [Yoast Contributor Day](https://yoast.com/about-us/events/yoast-contributor-day-november-2022/) will take place on November 3rd, 2022.
  • @estelaris mentioned that @ninianepress finished adding terms to the docs glossary project in GitHub (see https://wordpress.slack.com/archives/C02RP4WU5/p1667313612480669 and https://github.com/orgs/WordPress/projects/20/views/1).

Open Floor

  • @nielslange asked about how to follow-up after working on a doc and `Save it for later`. @milana_cap suggested to 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.” the corresponding team lead.
  • @milana_cap mentioned that she saw the docs team small, then big, then small and now growing again and that she’s very happy with the current documentarians that are very dedicated.
  • @estelaris and @milana_cap had a brief discussion about the Handbook’s Glossary and @estelaris mentioned the link to [WordPress Glossary update](https://github.com/orgs/WordPress/projects/20/views/1).

#docs, #meetings, #summary

estelaris 9:01 pm on October 19, 2022
Tags: docs,   

New design for HelpHub in WordPress.org

The end-user documentation or HelpHub will go through a transformation, both in the design and the site map. 

The refinements in the template will improve the user experience while searching for information. These improvements include one landing page for end-user and developers documentation that will be called Documentation. This is the entry port to both HelpHub and DevHub. Although this article focuses on HelpHub, there will be changes for DevHub in the future.

Showing the look of the new end-user documentation landing page showing the 4 categories and subcategories under each in two columns. There are links to developers documentation and the forums at the bottom of the page.

Better search

The new site map includes 4 main categories and subcategories under each. This will 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..

New site map showing categories and subcategories

New features

Documentation will have a new headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes.. The team is dropping the word ‘Support’ and replacing it with ‘Documentation’. This area of the website will contain reference information rather than be a place where users interact with the Support team as described in the Renaming WordPress.org Support to Documentation.

The new header for end-user documentation replaces the word Support for Documentation

A changelog was added to keep historic information on each article. The user will have a better idea of how recent the information is.

Example of changelog

Other features that will help searching are the breadcrumbs, a new documentation submenu to the categories, a more prominent table of content and, a highlighted link to Support Forums.

Example showing placement for breadcrumbs table of contents and documentation search box, including the Support Forums block.

Another new feature was the retirement of the hash character at the end of the headlines as they were an 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) issue and caused visual noise. The hash has been replaced by a link icon.

Appearance phases for the headlines

Documentation on mobile

The mobile version offers faster access to the specific topic in the article by using accordions to navigate long articles on mobile. The breadcrumbs, search and table of contents will remain at the top of the article.

Example of a documentation article on mobile.

The design

The design follows the style set by the News redesign. It is cleaner, jazzier and the new template opens the canvas to improve readability. Using also the same typography connects this design to the redesign of WordPress.

The color palette is simple and muted so as to not interfere with the multiple videos and screenshots used within the articles.

The work started at WCEU 2019 Contributors Day in Berlin. The following articles describe the work previously done.

Props to @milana_cap, @kenshino, and @atachibana for their direction on this project.

Props to @tobiasfeistmantl, @fmellitzer, @davidvie, @majaloncar, @pendraq, @igorel, @nobnob, @marcio-zebedeu, @chaion07, @netpassprodsr, @bph, @timohaver, @dmivelli, who contributed to the reclassification project.

Props to @melchoyce, @karmatosed, and @beafialho for their design guidance.

Props to @webcommsat and @marybaum for reviewing and editing help of this article.

#docs, #helphub

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

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

estelaris 8:03 am on October 5, 2022
Tags: docs,   

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: docs   

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

LucP 4:19 pm on August 30, 2022
Tags: docs, hosting   

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.

Birgit Pauli-Haack 9:22 am on August 10, 2022
Tags: 6.1, Dev Note, docs, ,   

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