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

Github related roles

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 8:01 pm on May 22, 2023
Tags: ,   

Online monthly Docs Team Contributor Day May 23, 2023

The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month. Any one may join who wishes to contribute to the team and who follows the Code of Conduct.

The next Docs Team 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/.

The next monthly online Docs Team Contributor Day will be:

When: Tuesday, 23 May 2023, 1:00-4:00 PM UTC

Where: #docs channel on Slack, and on Zoom.

Please also see Contributor Day — 23 May, 2023 on 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/ for onboarding and other important details.

Onboarding on Zoom

In addition to the details in the GitHub issue for this Contributor Day, folks who are in need of onboarding can ask 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/. or on the Zoom call. In Zoom, a breakout room will be started where contributors can be onboarded.

If at any time you have any questions, please feel free to ask in the #docs channel on Slack or in Zoom throughout the day.

After Contributor Day

Other than celebrating with some 🍪🍪🍪 after Contributor Day is over, please also comment on the corresponding GitHub issue with:

  1. Your 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/ profile username
  2. What you worked on and include links when possible.

Or, just comment anything (such as your WordPress.org username) to let the team know you attended.

#contributor-day, #docs

Leonardus Nugraha 10:03 am on May 22, 2023  

Summary for Docs Team meeting, May 16, 2023

Attendance

@ninianepress @leonnugraha @femkreations @ninthcoder @atachibana @estelaris @vishalmukadam @jominney @sagargurnani @greenshady @tshah0107 @zieladam @ndiego @javiercasares

Housekeeping

Find the complete Transcript of the meeting on Slack.

The next Docs Team 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/.

The next meeting schedule will be dedicated to the online Docs Team Contributor Day with the following details:

When: Tuesday, May 23, 2023, 1:00-4:00 PM UTC

Where: #docs channel on Slack, and on Zoom.

Upcoming meetings

May 30, 2023, will be the fifth week of May, which based on the Docs Team monthly meeting structure, will be used for a catch-up triage meeting. However, with the WCEU coming up, the team has decided to use it for WCEU preparation. 

In addition, the following meeting on June 6, 2023, is cancelled as most of the team will be travelling to Greece for WCEU.

Project checks

@leonnugraha reviewed and closed #685 and created a draft for #269

@tshah0107 reviewed #462

@femkreations created a new page and added content, reviewed and closed #238, and working on reviewing #487

@estelaris organized two working groups for Docs meeting with Polyglots and the feature-notification team

URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org changes in Documentation

@estelaris mentioned that contributors should not make any URL changes. If the title of the article and the URL are different, please open a 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/ issue, and the team will review it. There have been many issues with redirects and broken links with other teams, so we need to make sure that our work doesn’t affect other teams

Open Floor

@greenshady mentioned the need for a dedicated handbook for the WordPress Playground project. The discussion is already ongoing in this GitHub issue. The playground handbook will be made using Markdown markup language in the backend, similar to the Advanced Administration Handbook. @javiercasares will help with the handbook creation.

@jominney proposed an update to the Make Documentation welcome box content. Due to the current size, the important content for onboarding underneath it is hidden from view.#docs, #meetings, #summary

Hari Shanker R 8:11 pm on May 17, 2023
Tags: ,   

X-post: WordPress Contributor Mentorship Program: Pilot Program Proposal

X-comment from +make.wordpress.org/project: Comment on WordPress Contributor Mentorship Program: Pilot Program Proposal

Jenni McKinnon 1:44 pm on May 16, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting May 16, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 16 May 2023, 02:00 PM UTC

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker and facilitator selection for next meeting
  3. Facilitator selection for next triage meeting
  4. Projects checks
  5. URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org changes
  6. Open floor

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

#agenda, #meetings

Jenni McKinnon 1:37 pm on May 16, 2023
Tags: , ,   

Summary for Docs Team meeting, May 2, 2023

Attendance

@ninianepress @milana_cap @hilayt24 @chaion07 @femkreations @sereedmedia @medesigngood @leonnugraha @kafleg @sonalithakkar @ninthcoder @estelaris

Housekeeping

Find the complete Transcript of the meeting on Slack.

Project checks

@milana_cap closed 7 issues.

@femkreations completed issue 485.

@leonnugraha reviewed #695.

@larassattidn and 281.

Reminder about Docs Team 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/.

For all those that attended the last Docs Team Contributor Day, please be sure to comment on the corresponding GitHub issue with what you worked on that day.

The next Docs Team Contributor Day is May 23, 2023 from 1 PM UTC to 4 PM UTC.

Open floor

@milana_cap asked if there was any feedback from our last Contributor Day.

@ninianepress suggested breakout rooms in Zoom so that contributors who need it can be onboarded. At the next contributor meeting, we will ask if any one is in need of onboarding, then open a breakout room, as needed.

The team decided to continue with a 3-hour long Contributor Day and that the fifth Tuesday in May will be a triage meeting, following the week after our next Contributor Day.

@estelaris wrote Explorations for a notification form between documentation and Rosetta sites and would love contributor feedback in the comments.

#docs, #meeting, #summary

Javier Casares 4:07 pm on May 15, 2023
Tags: ,   

Proposal: Handbook for Local Teams

Note: tl;dr – Local teams, such as [es.wordpress.org] will be able to have their Handbook for a complementary use of the global Handbooks, but adapted to the particularities of the local culture instead of relying solely on a translation of the English version.

Currently, we could group the Handbooks into three types:

All these documents are in English and are maintained globally by some members of the WordPress Community.

But, in some cases, especially the local teams of each country, region or locale, there are specific documentation needs that cannot be added to the global Handbook. The clearest example is a contextual documentation of translations (the differences between English and Spanish, or between Spanish from Spain and Spanish from Mexico), or onboarding documentation for a Local Community (for example, access to their Slack).

To this, we can also add documentation from other teams that affect local elements, such as events, being able to share presentations or WordCamp information from a territory.

Three years ago, a pilot project was started in the WordPress edition of Spain for the installation of the same Handbook plugin that is used in Make/WordPress teams.

This technology is available on several sites, but with very different results. One of the biggest problems is who has access to the site and who can propose improvements or make changes, with blocking or access limitations.

That is why the following proposal is raised, based on how is already working on the Make/Hosting.

The Hosting team has a Handbook that for more than 2 years has been managed entirely from GitHub. This allows its management within WordPress to be limited to the Team Reps of the team, who perform operational tasks (ordering and reviewing content.) Because the management user is WordPress.org, the attribution of the contents is not made to any contributor.

How is content attributed to contributors? Through GitHub, since anyone who collaborates in the repository will have a versioning of the changes, and their attribution in the Activity Tab of their Profile, thanks to the synchronization between WordPress Profile and GitHub. Contribution to WordPress Documentation can be gamified.

And, an advantage and disadvantage at the same time, is how it is documented on GitHub: with the Markdown markup language. This language is a de facto standard used in many projects and allows the creation of textual content in a simple way from the keyboard (and easily convertible to HTML). It is also the native text language of GitHub, which allows editing directly from the platform itself, without the need to install an external program. And although it is simple to learn, it has the disadvantage that you have to learn the basic syntax, and that you have to know how to use GitHub, although it has already been proposed that this is the tool for massive use of the WordPress Community.

From here, through a simple configuration, considering that the Block Editor can interpret Markdown natively and that there is a tool (already tested in the Hosting team) that synchronizes every 15 minutes any approved change in the Handbook repository with the WordPress site, being able to anyone in the world contribute to a team with a standard tool, whether you have a WordPress account.

As a starting point, the WordPress Community Spanish Team has been working for some time on a Handbook in which team folders and other useful folders for the Community have been created (such a general GitHub manual), and to which anyone can contribute.

This repository must be under the WordPress organization of GitHub, and apply the synchronization tool between that repository and the Handbook plugin, already installed on the [es.wordpress.org] site.

From there, anyone who wants it can contribute to the Handbook with new content, new ideas or suggestions through the automated system.

This should extend to the current Locale Managers of a management team of the edition of the locale sites, called Local Team Reps, and following the same philosophy of the Global Team Reps, being the Documentation Local Team Reps responsible for the approval and management of the publication.

Nowadays, the project for the WordPress Community in Spain is very advanced, and it would be immediate to be able to launch the pilot program of automation of local Handbooks, started 3 years ago.

Proposal by @javiercasares. Reviewed by @amieiro, @anagavilan, @estelaris, @glycymeris, @milana_cap, @mrfoxtalbot.

+make.wordpress.org/meta/

+make.wordpress.org/polyglots/

Pinging all Local Teams with Handbooks available, and Spain.

+es.wordpress.org/team/

+af.wordpress.org/team/

+ar.wordpress.org/team/

+de.wordpress.org/team/

+en-ca.wordpress.org/team/

+es-mx.wordpress.org/team/

+fr.wordpress.org/team/

+id.wordpress.org/team/

+it.wordpress.org/team/

+ja.wordpress.org/team/

+pt-ao.wordpress.org/team/

+br.wordpress.org/team/

+ro.wordpress.org/team/

+sr.wordpress.org/team/

+yor.wordpress.org/team/

+tw.wordpress.org/team/

#handbook, #handbooks

Nomad Skateboarding 12:21 am on May 9, 2023
Tags: ,   

X-post: Day 1: #WP20 From Blogs to Blocks

X-comment from +make.wordpress.org/marketing: Comment on Day 1: #WP20 From Blogs to Blocks

Estela Rueda 9:42 pm on May 3, 2023
Tags: ,   

X-post: Explorations for a notification form between documentation and Rosetta sites

X-comment from +make.wordpress.org/polyglots: Comment on Explorations for a notification form between documentation and Rosetta sites

Jenni McKinnon 12:05 pm on May 2, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting May 2, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 2 May 2023, 02:00 PM UTC

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker and facilitator selection for next meeting
  3. Facilitator selection for next triage meeting
  4. Projects checks
  5. Reminder: Comment contributions on GitHub
  6. Open floor

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

#agenda, #meetings

Jenni McKinnon 2:26 am on April 25, 2023
Tags:   

Monthly online Docs Team Contributor Day starts April 2023

In a bi-weekly Docs Team meeting, a quarterly and independently-led docs team 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/. was proposed, much like the first ever one that was held in 2022.

The docs team decided on a more frequent monthly schedule.

Other details were also discussed and decided on in the following bi-weeky Docs team meeting:

  • These contributor days would be three hours long each,
  • they would be facilitated by any one and every contributor in attendance who wants to do it including team reps, leads, and other key contributors who are able to facilitate,
  • a Zoom link will be made available for contributors to meet as well as the #docs 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/. channel,
  • the contributor day would be announced,
  • an issue would be opened in 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/ with onboarding details similar to the first iteration, and
  • contributors who attend need to comment on the GitHub post with the tasks they will work on during the allotted time or else note that they are in attendance.

New monthly structure to bi-weekly meetings

In the meeting previously mentioned, the docs team agreed upon a new monthly structure that would incorporate the monthly contributor day.

Previously, there was an ongoing rotation of the team and triage meetings week-by-week so that each worked out to be a bi-weekly meeting in Slack.

The new structure for these two docs team meetings are as follows:

  1. Week one: Docs Team meeting
  2. Week two: Triage meeting
  3. Week three: Docs Team meeting
  4. Week four: Online Contributor Day
  5. Week five: If there is a fifth week in the month, the docs team will have an extra week to catch up or it will be a triage meeting, as needed.

Please note: Week five is sometimes referred to as the “overeating” week by docs team contributors. It’s in reference to team meetings and the first online Docs Team Contributor Day where it’s common for kudos to be given when issues are noted by contributors as being completed by them. Kudos is often given in the form of 🍪 (cookie) emojis. Cookies and other desserts are sometimes also offered at the Docs Team table of the Contributor Day for in-person WordCamps.

The next Docs Team Contributor Day

The first monthly online Docs Team Contributor Day will be:

When: Tuesday, 25 April 2023, 1:00-4:00 PM UTC

Where: #docs channel on Slack, and on Zoom.

Please also see Contributor Day – 25th April, 2023 on GitHub for onboarding and other important details.