Summary for docs team meeting, January 24, 2023

Attendance

@leonnugraha @ninianepress @milana_cap @estelaris @ninthcoder @atachibana @femkreations

Housekeeping

Find the complete Transcript of the meeting on Slack.

Project checks

@milana_cap is working on crafting the WCAS Contributor Day task list.

@ninianepress finished issue #128.

Status update for HelpHub

@estelaris walked through the recently finished updates to the End-User Documentation (HelpHub, internally).

For full details of these changes, please see New look, new site, new HelpHub.

Status update for DevHub

@estelaris noted that @javiercasares (not in attendance) is the project lead for the Developer Handbook (DevHub, internally) redesign. She mentioned that the design has been finalized, and development work has begun.

Open floor

@milana_cap mentioned there is a new non-project role in the team that no one has been doing before: GitHub issues coordinator.

@femkreations would also like to note that issue gardening for v6.2 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/ pull requests (PRs).

#docs, #meetings, #summary

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

Summary for Docs Team meeting, December 13, 2022

Attendance

@ninianepress @milana_cap @leonnugraha @femkreations @atachibana @thisisyeasin @emmaht @juanmaguitar @estelaris @bph @themiked @psykro

Housekeeping

Find the complete Transcript of the meeting on Slack.

Documentation team holiday schedule

It has been decided that the Documentation team will have a 3 weeks long time off for the holidays. This means that no meetings will happen during this time, as well as the response in SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel can be slower.

The time of is starting on Monday, December 19th 2022; and ends on Sunday, January 8th, 2023. The first meeting in 2023 will be on Tuesday, January 10th, at 2PM UTC. The format will be regular biweekly meeting.

Projects checks

@themiked – all the security related stuff is rewritten and consolidated now (#622, #623)

@femkreations – Reviewed, updated and closed 8 tasks for 6.1 Project and 9 tasks for 6.0 Project

@leonnugraha – Closed and published one high-prio 5.9 issue.

@atachibana – Tackling opened issues from the bottom (the oldest). Closed two issues and working #13.

@estelaris – working with 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. on the redesign for HelpHub and DevHub. We are testing the breadcrumbs and waiting on a resolution from coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. on next steps to do the reclassification of the articles, title changing and lots of 301s. May not have a holiday break.

@milana_cap – started working on Estela’s issue, did some reviewing of dev blog posts, a bit of onboarding docs (really hope to get that done before the next meeting).

Open floor

@estelaris – we need to add props for meeting facilitators and note takers so that everyone gets acknowledge.

@femkreations – saw this posting in the Make blog. Anything we can come up with for the Docs team?

Topics for the WordPress Community Summit 2023

We should think, as a team, of possible topics for 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? This should be the first agenda item at the next meeting. Format:

  • Topic description
  • Why would this topic particularly benefit from in-person discussion/work at the Community Summit?
  • Who needs to participate in the discussion described above?(In other words, without these people in the room, the discussion may be incomplete. This may include specific Contributor Teams, roles, individuals, etc.)

Have a wonderful holidays and a good rest, team. See you in 2023.

#summary

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

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

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

Summary of Docs Team Biweekly Meeting August 16, 2022

Housekeeping

Attendance: @milana_cap, @chaion07, @javiercasares, @ashiquzzaman, @atachibana, @femkreations, @greenshady, @piermario, @brightemeka, @krupalpanchal, @emmaht. Asynchronous updates from @lucp 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: https://make.wordpress.org/docs/2022/08/16/agenda-for-docs-team-meeting-16-august-2022/
Meeting Facilitator: @chaion07
Note Taker: @webcommsat. Review: @milana_cap and @femkreations
Next Meeting Facilitator (in two weeks): @brightemeka
Next Note Taker (in two weeks): @greenshady
Next Triage Meeting Facilitator (next week): @milana_cap

Project Updates

Documentation Issue Tracker Updates

@milana_cap shared: there have been a lot of updates for Team roles tickets. This is hoped to be completed by end of next week: GitHub ticket #385

WordPress 6.1 release

WordPress 6.1 release has started, docs focus folks working in triage and collecting tickets for documentation.

Useful links for documentation

Anyone who wants to join in or learn how a release is documented, can contact @milana_cap in the documentation release team. She will 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.” contributors once there is work available. Currently, everything is being prepared. A checklist is being created. An additional volunteers tracker for WordPress 6.1 release docs contributors has been set up too.

The post from the first meeting of the WordPress 6.1 release docs team: @bph, @milana_cap, @femkreations, @webcommsat, @mburridge. YouTube video from the meeting.

Project boards updates

@femkreations shared an update from the projects boards:

Reclassification project

@estelaris: no new updates

Other updates

@emmaht: we are working on (waiting to be reviewed)

The following items should be finished next week

@femkreations: highlighted contributions from @wigno and @leonnugraha who have been doing a great job with the 6.0 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 documentation. Thanks for their contributions.

@themiked: fixed a few minor issues, found a problem with the GitHub importer and logged it.

Collaborations between docs and hosting team

@javiercasares: last week Milana was on the #hosting-community channel explaining this new project / handbook / documentation about separating some of the most technical documentation from the Hubs.

There is a new label in the Issue Tracker ‘advanced administration’.

Initial check of the tickets, first idea on categorization can be found in this Google doc. This is a first “structure” with all the links and everything I found on those tickets. As this is a first idea, it will probably change a lot.

Thanks to @JavierCasares for structuring the new handbook.

First pull request for the Advanced Administration Handbook

#1 Create a first possible File Structure – a first level possible structure, with the “big categories”. This may change as we start creating and updating content, but this is a place to start.

Second pull request (technical one, for the #meta team)

#2 First Manifest file – a first manifest file, created manually because we will need to have the WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ software configured… but we will have that when 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. creates it.

Those files will help us start creating new content and migrating the actual one. Then sync everything with the site automatically (so every time we do a merge, the content will be updated). These are first ideas, help and suggestions welcome.

@lcup sent an update to the meeting:
– added articles to move from HelpHub to DevHub docs for the new advanced administration handbook in: Documentation Issue Tracker, ticket 388 in GitHub. Thanks to @estelaris and @femkreationsfor doing all of the look-up work on this.

@milana_cap shared context: parts of “too technical” docs from HelpHub will end up in this new handbook. 

Open Floor

Updates on the Five for the Future program and proposed improvements – post from July 28, 2022.

@shetheliving shared async: wanted some additional views on Documentation Issue Tracker issue on Tidy up suggested object caching plugins #410, for @tillkruess and the Performance team.

#meetings, #summary

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 August 2, 2022

Housekeeping

Project Checks

Documentation Issue Tracker Updates

  • @leonnugraha is almost finished with #315 and #270
  • @lucp is still working on #375
  • @milana_cap
    • created two 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/ workflows: 1. automated adding issue to the project based on applied labels; 2. automated comment on the issue, mentioning project reps based on applied labels
    • moved docs handbook project to new ones to make above automation possible: https://github.com/orgs/WordPress/projects/43/views/1
    • continue working on team roles docs: https://github.com/WordPress/Documentation-Issue-Tracker/issues/385
  • @colorful-tones is adding lots of feedback to the Patterns doc for the Theme Developer Handbook #342
  • @femkreations
    • 19 items  in the 5.9 issues have been closed (all of them have been updated now for 6.0 as well)
    • 2 new pages were created and updated for 6.0. 12 pages are a work in progress currently
    • the 5.9 issues project board and merging it into the 6.0 soon. New contributors please refer to the 6.0 issue board 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 docs

Inventory of technical Parts from End-User docs

@estelaris is updating the Inventory of technical Parts from End-User docs, adding other articles to be reviewed and edited after the second site map revision.

Helphub redesign/reclassification project

@estelaris reported that the last revision of the site map has taken longer than expected and will write a post after the second revision is done. These items are still in the works:

  • Update the template with the developers block
  • Add a link to features and requirements (under the About menu item)
  • Finish updating the tickets for articles to rename, move to DevHub and delete
  • Update the categories/subcategories in HelpHub (per 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. instructions) but not changing categories to any article yet

Updates on the Five for the Future program and proposed improvements

The idea is to track better and more contributions, especially those that are not code. As of last week, there are new items already showing in contributors profiles.

For docs team, it mean that opening/closing/being assigned to an issue in the Issue tracker repo is going to be displayed on your profile. Still we will have to track some things manually, like facilitating meetings in the #props Slack channel. For contributions done in GitHub see issue #178.

Open Floor

@audrasjb asked if anyone is also curating DevHub user contributed notes and he will write a draft on his process to facilitate other contributions.

@lucp raised his hand as team repTeam Rep A Team Rep is a person who represents the Make WordPress team to the rest of the project, make sure issues are raised and addressed as needed, and coordinates cross-team efforts. for the advanced administration handbook and he will take over the Inventory of technical Parts from End-User docs.

#meetings, #summary

Summary of Docs Team Biweekly Meeting July 19th, 2022

Housekeeping

Project Checks

  • @milana_cap re-wrote the homepage and requests feedback in the ticket
  • @milana_cap started working on team roles page.
  • Updated Team page with open positions (see rep positions below).
  • Completed and reviewed 5.9 Block Editor Doc Project tasks:
  • HelpHub design and reclassification project updates from @estelaris:
    • Waiting on a site map review for some articles to move to DevHub.
    • Update two items on the design: change dev docs link for a dev 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. similar to the support block and change items in the menu.
    • Update the images on the post.
    • Plan to release the post with the new design on Thursday, July 21.

DevHub Handbook: Advanced Administration

A 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. TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. ticket is now open for new handbook. Currently, there are developer and end-user docs, but many unsorted docs fall under an “advanced administration” term. Most of the content will be pulled from:

  • HelpHub – Pages that are too technical for end-user docs (see “Technical guides” column in HelpHub sitemap spreadsheet).
  • Codex – Pages that have not been migrated to DevHub/HelpHub because they did not fit into either.

Approving User-Contributed Notes

@lucp linked to a Slack conversation on pending comments on DevHub, some of them dating back for a year. There is ongoing discussion about how to best handle this and a Meta ticket that proposes emailing users when a comment is approved/deleted.

Rep Positions

There are three open rep positions. Those interested should contact @milana_cap.

  • Block Editor Developer Handbook
  • More Info Curator (Code reference)
  • Upcoming Advanced Administration Handbook

See onboarding video for more information. Also, see the complete list of roles.

Open Floor

@colorful-tones started a draft on patterns for the theme developer handbook.

@bph noted that comments on the upcoming developer blog editorial process close on July 20.

#meetings, #summary