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, 2 April 2024

Attendance

@milana_cap @leonnugraha @sagargurnani @lumiblog @noumantech @pooja9712 @matteoenna @calolan @ppeeranatd @flexseth @estelaris

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Biweekly Meeting

Project Checks

@sagargurnani completed #954.

@milana_cap mainly focused on Playground – reading existing docs and making plans with @zieladam and @flexseth on how to improve it. @milana_cap also closed a couple of used docs issues 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/..

@lumiblog shared the progress of #1492.

@Leonnugraha expressed commitment in working on the ‘needs review’ this coming week 

@calolan shared the progress of #1291 and #1198. @estelaris shared the list of open issues for the 6.5 release – HelpHub: #1490, #1491, and #1492.

Open Floor

@estelaris   shared an update that The Spanish community had begun updating their style guide and had established weekly meetings on Fridays at 9 UTC. A post is already in draft and will be published soon (both in Spanish and English).

@flexseth sought clarity on documentation issues within WordPress Playground, facing challenges with PR submissions. @milana_cap suggested specific 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/. channels for support.

@estelaris highlighted ticket management, referencing #1525, and stressed understanding team procedures to avoid burnout.

@milana_cap advised @flexseth to attend relevant meetings, suggesting the #marketing team for SEO concerns. 

props to @lumiblog for taking notes during the meeting.

#meetings

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

During the 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 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. Torrelodones 2024, the Spanish documentation team started the translation for the end-user documentation.

The initial objectives were:

  • Decide the day and time for the weekly team meeting
  • Define responsibilities for meeting facilitators
  • Technical requirements for a documentation team member
  • How to effectively coordinate with the Spanish translation team
  • Review the Style Guide for translation
  • Define the translation process
  • Suggest new words to the Spanish (Spain) Glossary

Conclusions of the Spanish documentation team

Weekly meetings

Responsibilities for meeting facilitators

  • The team agreed that @estelaris will run the first few meetings and then it will be rotated among contributors
  • Whoever runs the meeting must prepare the agenda based on the previous meeting

Contributor technical requirements

  • Know sufficient English to understand the content that is being translated
  • Be familiar with the Spanish style guide and glossary
  • Basic understanding of 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/

Translation Style Guide

Another goal is to improve the Spanish Style Guide to be able to write the documentation, following the rules already instilled by the translation team. This work will be based on the Documentation Style Guide written by the global team. Follow the work in GitHub Spain Handbook #288.

Translation process

The translation process the team will follow includes:

  • Update the style guide and have it reviewed and approved by the translation team
  • Prioritize articles for translation (high, medium, low) as well as add tasks to the issues (content, screenshots, videos, etc)
  • Work with #meta team to open the es.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//documentacion site
  • Translate the articles and pass them to the Spanish polyglots teamPolyglots Team Polyglots Team is a group of multilingual translators who work on translating plugins, themes, documentation, and front-facing marketing copy. https://make.wordpress.org/polyglots/teams/. for review
  • Make the documentation available in Spanish from Spain as soon as the site is set

This post will be updated accordingly and it is a translation of the post in Make Spain Blog.

props to @josepmoran for taking notes during contributor day and to help write this post in Spanish

#contributor-day

Agenda for Docs Team Biweekly Meeting (02-April-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 02-April-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 subsequent triage.
  4. Project check.
  5. Estela’s (@estelaris) updates
  6. Open floor.

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 (19-March-2024)

Attendance

@estelaris @milana_cap @leonnugraha @sagargurnani @hellosatya @marcio-zebedeu @lighthouse79 @atachibana @anandau14 @noumantech @sheebaabraham @matteoenna @lumiblog  @Calolan

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Biweekly Meeting

Project Checks

 @sagargurnani completed #430 and #935 and waiting for the review of #954.

@leonnugraha reviewed the drafts of the dev notes and published the Miscellaneous Editor changes in WordPress 6.5.

 @Calolan shared the progress of #1308 and #1476.

@milana_cap shared the update on the CloudFest hackathon contribution but could not contribute to docs projects.

 @sheebaabraham shared the progress of #1371 and showed commitment to complete it soon.

@estelaris started the user documentation for the 6.5 release and needs help from new contributors to get screenshots and a small video

@lumiblog shared the list of in-review issues (#1299, #1313, #1281, and #1280) and closed issues.

Open Floor

@estelaris shared the list of open issues for the 6.5 release – HelpHub: #1490, #1491, and #1492. He would also open more issues.  @sagargurnani and @estelaris discussed the March 5, 2024 updates post; @sagargurnani responded that he contacted Adam to help him document the playground.

@estelaris explained that two main items need help: users’ and developers’ perspectives in the documentation and review on the last item to improve the changelog in the articles. He also plans to write end-user cases after I finish the 6.5 release docs.

@sagargurnani asked a question about a few articles that have change logs and a few haven’t. @milana_cap explained that Changelogs were made when @bph ran 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 end-user docs, and she had them in an article template. The rest of the docs never caught up. @estelaris said changes are happening at design side, will look into it later.

#docs, #meetings, #summary

Agenda for Docs Team Biweekly Meeting (19-Mar-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 19-Mar-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. Estela’s (@estelaris) updates
  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 – February 2024

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

Update for #docs team discussion items March 5, 2024

Please review the issues here as the team will be discussing them during the meeting on March 5.

Consider adding introduction to what is included in the documentation site

The conversation can be followed in GitHub. The proposal is to add a tagline to the headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. and there are some good proposals there. This needs to be decided quick as 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 is getting ready to finish the redesign.

Documenting the Playground for end-users

@zieladam has some ideas to include Playground documentation in HelpHub. The idea is to create use cases for now.

The use cases and recommendations are written in the User Documentation ticket in the GH Playground. Once a docs contributor is interested in working on these articles, we can transfer them to the docs/issue GH.

Documenting the Playground for Developers

There is a ton of documentation that needs to be written for the Playground. If anyone is interested, reach out to @zieladam, follow the conversations in the #meta-playground 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, and https://developer.wordpress.org/playground/

Refining how updates to documentation articles are tracked (improving the changelog) 

Review and comment on proposals. GH/wp-documentation #88

Online monthly Docs Team Contributor Day March 26, 2024

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, 26 March 2024, 1:00-4:00 PM UTC

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

Please also see Contributor Day — 26 March, 2024 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

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

Attendance

@estelaris @milana_cap @leonnugraha @sagargurnani @ninianepress @atachibana @anandau14 @noumantech @rcreators @ranjanrakesh @kafleg @hellosatya @marcio-zebedeu @lighthouse79 @matteoenna @ashishsthanp @devmuhib (async)

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

The next Docs Team Bi-weekly meeting which is supposed to be held on 05-Mar-2024 has been cancelled due to WCAsia 2024. So, the next Bi-weekly meeting would held on 19-Mar-2024 instead.

Project Checks

@milana_cap had updated the WordPress Versions Page.

@sagargurnani had completed #958.

@leonnugraha had completed and closed #958. He also gathered 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/ PRs for 6.5 that require dev notes and created a tracking issue for it.

@atachibana had completed and closed on #291.

@noumantech had completed #1332 and is waiting to get it reviewed.

Estela’s Updates

  1. She (@estelaris) had mentioned that @ninianepress, @anandau14 and herself were chosen as mentors for the mentorship program cohort 2.
  2. She would be mentoring 2 new contributors from Italy and will teach them documentation so they can get involved in translation. She had added them (@lighthouse79 and @matteoenna) to the #docs channel too.
  3. She had shared and requested everyone to read the documentation redesign post and leave comments, if any.
  4. She had also mentioned, It was suggested that the team identifies the documentation as “Docs for Non-Devs” or something similar. Apparently, developers click on the Help Hub documentation and get frustrated to find out it is not what they are looking for.
    • @leonnugraha suggested that it can be called something like – “Help Centre”, “User Guide” or “Intro Copy”.
    • @estelaris suggested – “Documentation – If you don’t code, this is for you” and said the “Help Centre” can be confused with the Support or Forum.

Open Floor

  1. @anandau14 mentioned that he will be guiding 2 mentees on contributing to docs. And, he added them (@ashishsthanp and @ranjanrakesh) to the #docs channel.

#docs, #meetings, #summary

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

The next meeting is scheduled with the following details:

WhenTuesday, 20 February 2024, 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. Project check
  5. @estelaris‘ updates
  6. Open floor

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

#agenda, #meetings