Milana Cap 8:00 am on June 13, 2022  

Onboarding to Documentation team

Here is some quick info you need in order to start contributing to Documentation team.

Accounts:

Places:

  • Blog – for meeting agendas and summaries (and anything related to Docs team).
  • Slack channel #docs – where meetings are happening (and all communication regarding the team itself).
  • GitHub repository – where issues for all documentation are reported, discussed and worked on.
  • Handbook – how to contribute to the Documentation team (it’s a bit out of date).
  • Style guide – for how to write WordPress documentation.

Meetings (alternating every week) on Tuesdays at 2PM UTC:

  • Regular meeting with agenda published on our blog.
  • Issues triage where we discuss issues from the 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/ repository.

Live onboarding sessions

We recorded onboarding sessions for everyone interested in getting started with the Documentation team. We know that our “Getting started” documentation is out of date and getting involved can be very confusing and frustrating so we hope to ease the process with these sessions.

Overview

Recording: https://wordpress.tv/2022/06/21/milana-cap-overview-onboarding-for-wordpress-documentation-team/

End user documentation

Developer documentation

Developer documentation – PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party handbook

Developer documentation – Common APIs handbook

Developer documentation – Code reference handbook

Developer documentation – BlockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. editor handbook

Developer documentation – Themes handbook

Contributor documentation – Documentation team handbook

If you have any questions or you’d like to have an “in more detail” session, feel free to leave the comment below.

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

estelaris 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

Steve Dufresne 5:52 am on September 5, 2022
Tags: ,   

X-post: Improving DevHub Code References

X-post from +make.wordpress.org/meta: Improving DevHub Code References

Milana Cap 1:00 am on September 5, 2022  

Documentation team meeting postponed to WCUS Contributor Day

The next Documentation team meeting was supposed to happen on Tuesday, September 6th. This same week is the first post-Covid in-person WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. US happening. Some folks will be traveling or busy otherwise so it’s been decided to cancel the regular meeting and move any team related discussion to WordCamp US Contributor Day instead.

Date: Sunday, 11th September, 2022

Time: 5PM – 10PM UTC

Place: #docs SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel

If you have any questions or topics you’d like to discuss during 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/. but can’t attend feel free to post it in the comments below.

You are also welcome to join us in Slack during Contributor Day and just contribute, we don’t have to discuss anything.

LucP 4:19 pm on August 30, 2022
Tags: , 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.

estelaris 12:33 pm on August 30, 2022  

Agenda for docs team bi-weekly meeting 30 August 2022

Our next Team meeting is scheduled with the following details:

When: Tuesday, August 30, 2022 at 04:00 PM GMT+2

Where: #docs channel on Slack.

Meeting Agenda

  • Attendance
  • Note-taker & Facilitator selection for Next Meeting
  • Project Updates
  • WCUS contributors day facilitator
  • Open Floor

#agenda, #meeting-agenda, #meetings

webcommsat AbhaNonStopNewsUK 11:30 am on August 17, 2022
Tags: ,   

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