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/

A more recent onboarding session, recorded on 28th July 2023, can be found here: https://wordpress.tv/2023/08/01/jenni-mckinnon-milana-cap-wordpress-documentation-team-onboarding-july-2023/

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.

Summary for Docs Team Meeting (20-Aug-2024)

Attendance

@milana_cap @leonnugraha @atachibana @sagargurnani @estelaris @dapobabarinde @faguni22 @writinglearning @mitchelokorie

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Project Checks

@milana_cap did a bit of HelpHub feedback triaging and needs to create new issues for the same.

@writinglearning added some android based screenshots to #1552 and #1546.

@estelaris is reviewing all the mobile tickets constantly and drafting posts in WordPress.

Online monthly Docs Team Contributor Day August 27, 2024

The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month, but a little special this month, we’ll do it twice! The focus for this month is to help with the WordPress 6.6 end-user documentation.

Anyone who wishes to contribute to the team and who follows the Code of Conduct may join.

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, August 27, 2024, 1:00-3:00 PM UTC

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

Onboarding on Zoom

In addition to the details in 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/ issue for this Contributor Day, folks who need 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 (TBA) 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

Agenda for Docs Team Biweekly Meeting (August 20, 2024)

The next meeting is scheduled with the following details:

WhenTuesday, August 20, 2024 14:00 UTC

Where#docs channel on Slack

Agenda:

  1. Attendance.
  2. Note-taker and facilitator selection for the next docs team meeting.
  3. Facilitator selection for the next triage.
  4. Project check.
  5. Updates from @estelaris.
  6. Open floor.

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

X-post: WordPress Contributor Mentorship Program Cohort #3 (2024 Q4): Call for Mentees & Mentors

X-post from +make.wordpress.org/project: WordPress Contributor Mentorship Program Cohort #3 (2024 Q4): Call for Mentees & Mentors

Summary for Docs Team Discussion Meeting (06-Ago-2024)

Attendance

@sagargurnani @leonnugraha @estelaris @dapobabarinde @calolan @faguni22 @vishal4669 @atachibana

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting 

Project Checks

@sagargurnani is working on issues 716 y 978.

@leonnugraha created issue for WCUS contributor day (tasks list will still be updated closer to the event). And updated the WordPress version page based on this content review request. He wanted to close it, but he’s waiting for confirmation/approval from the ticket creator.

@vishal4669 is working on ticket 1607.

@atachibana is working on the Grid 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., issue 1615.

@estelaris will continue working on:

  • Finish uploading 6.5 articles (they are ready just need to update WordPress)
  • Rethink a “discussion for a proposal for the “wiki-like” update on documentation (FYI, this is going to affect all the documentation throughout wp.org). There are several items to think about: automated translation, how we can integrate 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/ in a way that doesn’t involve the user (only the people updating the documentation), and how to notify changes.
  • Work on the mobile documentation (get it ready for screenshots)
    • Regarding this, @vishal4669 started working on the Mobile Documentation and completed issues 1609, 1608, and 1606.
  • Please read and comment on the meeting notes for the Localization and translation of HelpHub.
  • There needs to be another design update on HelpHub but we are still on hold until I finish a proposal to make some changes to the sitemap.

Open Floor

  • @vishal4669 asked if for the 6.6 HelpHub tickets he should update the issues like he’s doing it for the mobile documentation. @atachibana replied that if the modifications are small, they can be written in GitHub. As on issue 1617. But if it’s a large amount, it’s better to write it in a Google Document and share the link.
  • @sagargurnani refers to a comment on today’s agenda, regarding the broken images on the posts. Following the agreements in that regard:
    • Everyone who has access to update the article on WP should be notified that the images should be reuploaded into the WP image library to avoid broken images.
    • This should be mentioned in the “General Section” of the issues.
    • There’s an issue with articles that have broken/missing screenshots: 1649.
    • The message that has to be added to the general section is “Upload the images/videos into the WP image library to avoid broken images”. It should be included in the new issues template.

Agenda for Docs Team Biweekly Meeting (06-Aug-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 06-Aug-2024 14:00 UTC

Where#docs channel on Slack

Agenda:

  1. Attendance.
  2. Note-taker and facilitator selection for the next docs team meeting.
  3. Facilitator selection for the next triage.
  4. Project check.
  5. Design updates by @estelaris.
  6. Open floor.

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

X-post: Training Team Update – August 2024

X-comment from +make.wordpress.org/updates: Comment on Training Team Update – August 2024

Summary for Docs Team Meeting (16-Jul-2024)

Attendance

@milana_cap @leonnugraha @sagargurnani @atachibana @calolan @estelaris @lumiblog @khokansardar

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Note: On July 30, 2024 at 14:00 UTC (the 5th Tuesday of the week) will be the 2nd monthly online 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/..

Project Checks

@leonnugraha did a content review and updated the WordPress version page (#1653) and labelled some untagged issues in our repo.

@milana_cap is working on 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/ article for CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. Dev Blog.

@calolan had updated and screenshots and the videos for the 6.5 version to tickets #1503, #1504, #1512 and #1513.

@atachibana had updated the “Keyboard Shortcut” page as per the new 6.6 features (#1617).

Estela’s Updates

    1. She would be posting the notes for the translation and localization meeting in Team Updates.
    2. She needs to confirm an item 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. team that, at the beginning of July, all Rosetta sites were moved to the new template, thus 3 sites (the only ones she could identify) lost their link to the Codex in their language so she needs to know what happened to all of that information.
    3. She is going through the issues from 6.5, updating articles and closing them.

    Online monthly Docs Team Contributor Day July 23 & 30, 2024

    The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month, but a little special this month, we’ll do it twice! The focus for this month is to help with the WordPress 6.6 end-user documentation.

    Anyone who wishes to contribute to the team and who follows the Code of Conduct may join.

    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, July 23, 2024, 1:00-4:00 PM UTC and Tuesday, July 30, 2024, 1:00-4:00 PM UTC

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

    Onboarding on Zoom

    In addition to the details in 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/ issue for this Contributor Day, folks who need 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 (TBA) 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

    X-post: Localization and translation of HelpHub – Meeting notes

    X-comment from +make.wordpress.org/updates: Comment on Localization and translation of HelpHub – Meeting notes