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.

Localization and translation of HelpHub during WCEU 2024

The team working on the localization and translation of end-user documentation (HelpHub) will meet again during 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/. at WCEU on Thursday 13 June at 12:30 UTC. Location will be announced at contributor day.

The agenda is as follows:

Goal: Create a plan of how to move forward with the localization/translation of documentation project

  1. Discussion: Cross-team communication
  2. Discussion: What does GlotPress need to move forward. GlotPress has a translation memory, but it’s not context-aware. This makes automated reuse of shorter strings harder.
  3. Discussion: Can we use GH as a docs issue tracker, in the same way global does it? Or can we take advantage of the global docs issue tracker and create labels for languages? How are other teams doing it? Spanish team started with this: https://github.com/orgs/WordPress/projects/195
  4. Request: What does 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. need to prepare Rosetta sites for the documentation page, First discussion: https://meta.trac.wordpress.org/ticket/7637

For background information, please read:

Future plans for HelpHub

Translation of End-user documentation project started at WordCamp Torrelodones (Spain)

Anyone interested in the project is welcome. If you are not attending WCEU, we will be taking live notes in #polyglots-multilingual-community on Slack

Props to @courane01, @javiercasares and @tobifjellner for reviewing the agenda.

X-post: Proposal: Learn WordPress Content Maintenance Process

X-comment from +make.wordpress.org/training: Comment on Proposal: Learn WordPress Content Maintenance Process

X-post: Training Team Update – June 2024

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

Agenda for Docs Team Biweekly Meeting (4-June-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 4-June-2024 14:00 UTC

Where#docs channel on Slack

Agenda:

  1. Attendance.
  2. Note-taker and facilitator selection for the next docs team meeting.
    • Note. There will not be a Monthly Planning Meeting (triage meeting) on June 11, as the team will be on their way to WCEU.
  3. Project check.
  4. Estela’s (@estelaris) updates
  5. Open floor.

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

Agenda for Docs Team Biweekly Meeting (21-May-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 21-May-2024 14:00 UTC

Where#docs channel on Slack

Agenda:

  1. Attendance.
  2. Note-taker and facilitator selection for the next docs team meeting.
    • Note. There will not be a Monthly Planning Meeting (triage meeting) on June 11, as the team will be on their way to WCEU.
  3. Project check.
  4. Estela’s (@estelaris) updates
  5. Open floor.

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

#agenda, #docs, #meetings

X-post: Recognizing Contributions and Acknowledging Challenges

X-comment from +make.wordpress.org/sustainability: Comment on Recognizing Contributions and Acknowledging Challenges

Summary for Docs Team Discussion Meeting (07-May-2024)

Attendance

@milana_cap @leonnugraha @sagargurnani @lumiblog @atachibana @estelaris @samanthaxmunoz @marcio-zebedeu

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting 

Project Checks

@lumiblog expressed commitment to working on #1496 and #1497 this coming week. 

@milana_cap has been writing an article for the code dev blog in the past week. 

@leonnugraha reviewed and closed #1289 and #701.  He combined and updated some unassigned and abandoned issues. He also updated some issues’ labels.

Open Floor

Members voted and finalized that the following would be the new meeting names:

@milana_cap was asked to update the meeting names on the Make WordPress Documentation page. 

@estelaris shared that she has been:

  • Creating the project plan and tickets for the translation project for the Spanish team. She mentioned that the project plan and tickets can be viewed at this link.
  • Reviewing and testing the mobile documentation. She expressed that she had never used the WP app before and found it quite cool, adding that testing takes time.
  • Creating tickets for screenshots/videos for the mobile app articles she reviewed. She mentioned that these tickets will be updated by @samanthaxmunoz and her team at WP Engine, noting that they are good tickets for new contributors.

@estelaris also announced that there will not be a Monthly Planning Meeting on June 11, as the team will be on their way to WCEU (WordCamp Europe) and will have a contributor day on June 13.

The members discussed renaming the “Installation” categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. on the WordPress documentation site, as the articles currently in that category do not really fit under installation. The articles are:

  • Hosting WordPress
  • SEO
  • Automated Installation
  • Troubleshooting Login Issues

@leonnugraha suggested renaming it to “Setup”. @sagargurnani thought “Automated Installation” could stay in that category, but the other articles should move elsewhere.

@milana_cap raised concerns that “Setup” is too broad and other things like installing themes/plugins, customizing, etc. could also fall under that category name.

The team decided to table the discussion for the next meeting to allow folks to think about a better category name. In the meantime, @estelaris moved the “Troubleshooting Login Issues” articles to the FAQs section.

#docs, #meetings, #summary

Agenda for Docs Team Biweekly Meeting (07-May-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 07-May-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.
    • Finalize the new meeting names.

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

#agenda, #docs, #meetings

Summary for Docs Team Meeting (30-Apr-2024)

Attendance

@estelaris @milana_cap @lumiblog @shawncontant @pooja9712 @atachibana @marcio-zebedeu @ashiquzzaman @sagargurnani (async)

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Project Checks

@shawncontant had completed #978 and which is now ready for the 1st review. As per his request @leonnugraha assigned him another issue i.e. #1500.

Open Floor

  1. @shawncontant asked that the issue which is assigned to him is getting updated to WP 6.3 but WP 6.5 is the latest version. So, isn’t 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 itself supposed to be labelled as 6.5, to which @milana_cap answered that sometimes the feature hasn’t changed so updating to earlier versions is still valid for current version. On other times, when we have the same features updates marked for current and earlier versions, then we ignore the earlier version and document only the current one.
  2. @milana_cap had mentioned that in the last 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/. meeting which was held on Tuesday 23-Apr-2024 at 14:00 UTC the attendees had discussed and suggested alternate names for the docs team meetings. And, then she had requested the team members to provide their suggestions or if they have any questions regarding the new meeting names.
    • Biweekly Meeting -> Discussion Meeting
    • Contributor Day -> (We will keep it as it is)
    • Issues Triage -> Monthly Planning Meeting

#docs, #meetings, #summary

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

Attendance

@milana_cap @leonnugraha @sagargurnani @lumiblog @atachibana @shawncontant @estelaris @vishalmukadam @ppeeranatd @jeffr0

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Project Checks

@estelaris is working on all her tickets at Yoast 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/..

@milana_cap has been mostly reviewing Playground docs in anticipation of Yoast’s Contributor Day, where we’re going to help improve them.

@leonnugraha reviewed and updated #1323.  He also reviewed and closed #1342 and #1341.

@sagargurnani is doing a 2nd review of  #490 and will look into other urgent issues. 

@shawncontant expressed commitment to working on #978 this coming week. 

@atachibana shared progress on #464.

@ppeeranatd is working on #1514

Open Floor

@estelaris shared that it’s official that 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. for Documentations will be happening in October 2024. The WordCamp will be a 24-hr online event to cover all time zones.

She will post a general plan on the Make WordPress Docs Blog and then open a website with a call for organizers.

Will officially invite other teams that work on documentation like support, training and anyone that updates a handbook under dev.wp.org to join.

Anyone who wants to be an organizer or a speaker is encouraged 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.” @estelaris.

@estelaris also noted that next time on the agenda will not be an @estelaris update, but a WCDocs update.

On another topic, @estelaris updated that The Spanish community is ready to start translating HelpHub.

@milana_cap shared that Yoast Contributor Day will happen on Thursday, 18th April, and everyone is welcome to join. 

Props to @estelaris and @sagargurnani for helping with reviewing the post.

#docs, #meetings, #summary