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.

Ryan Welcher 5:23 pm on March 28, 2023
Tags: ,   

X-post: Introducing a new block editor handbook scrub

X-comment from +make.wordpress.org/core: Comment on Introducing a new block editor handbook scrub

Jenni McKinnon 6:16 am on March 26, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting April 4, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 4 April 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. Daylight Saving reminder
  5. Projects checks
  6. Open floor

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

Please note: As a reminder, Daylight Saving is quickly approaching. In Europe it began on March 26th and in North America Daylight Saving started March 12th. Regardless, Documentation Team meetings remain at the same scheduled time of 14:00 UTC.

#agenda, #meetings

Jenni McKinnon 6:09 am on March 26, 2023
Tags: ,   

Summary for Docs Team meeting, March 21, 2023

Attendance

@leonnugraha @atachibana @estelaris @ninianepress @thisisyeasin @thomasdevisser @sonalithakkar @welcher @anandau14 @webcommsat @thabotswana @femkreations

Housekeeping

Find the complete Transcript of the meeting on Slack.

Project checks

@anandau14 finished the More options article which is ready for first review.

@estelaris is working on a proposal to 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/, GlotPress, and WordPress.org:

  • This project originated from 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.
  • The aim is for automation of documentation maintenance and a notification feature to keep the Polyglot Teams up-to-date when new articles are added.

@femkreations completed adding tasks to the 6.2 Project Board:

Discussion on an application for the Google Season of Docs

  • The submission deadline is on March 24 at 18:00 UTC.
  • There’s a proposal template available and discussion on ideas for the application will continue asynchronously.

Update on the Docs inventory

@estelaris is working on changing the structure.

Creating documentation for the WordPress app

@thabotswana, a Happiness Engineer at Automattic, joined the meeting to brief us on the need for documentation surrounding the details in the post Refocusing the WordPress App on Core Features:

  • The WordPress mobile app is going to have all Jetpack/Automattic features removed. It will be focused on WordPress coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. features to distinguish it from the Jetpack mobile app.
  • There’s a need for support articles on the WordPress.org site, and for the Documentation Team to take ownership of them.
  • Automattic does have a small team of WordPress.org-sponsored contributors and @thelmachido will be assisting.
  • Currently, there’s some documentation on WordPress.com, and much of it can be repurposed.
  • The sections that don’t apply due to the major changes scheduled for the app will need editing, and some screenshots will need to be updated.
  • Users are now being directed to the new WordPress Mobile App Forums.

Open floor

@thomasdevisser opened a discussion to find a better structure for the 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/ documentation:

Please note: As a reminder, Daylight Saving is quickly approaching. In Europe it begins on March 26th and in North America Daylight Saving started on March 12th. Regardless, Documentation Team meetings remain at the same scheduled time of 14:00 UTC.

Props to @sonalithakkar for writing this meeting’s summary.

#meetings, #summary

Jenni McKinnon 9:48 am on March 16, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting March 21, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 21 March 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. Daylight Saving reminder
  6. Discussion on a proposed application for the Google Season of Docs
  7. Update on the Docs inventory
  8. Creating documentation for the WordPress app
  9. Open floor

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

Please note: As a reminder, Daylight Saving is quickly approaching. In Europe it begins on March 26th and in North America Daylight Saving started March 12th. Regardless, Documentation Team meetings remain at the same scheduled time of 14:00 UTC.

#agenda, #meetings

Jenni McKinnon 9:42 am on March 16, 2023
Tags: , ,   

Summary for Docs Team meeting, March 7, 2023

Attendance

@ninianepress @ninthcoder @leonnugraha @femkreations @atachibana @emmaht @estelaris @thisisyeasin @javiercasares

Housekeeping

Find the complete Transcript of the meeting on Slack.

Please note: @ninianepress wrote this summary as @femkreations was unavailable due to other high-priority Documentation Team tasks, and will also write the next summary for similar reasons in place of @estelaris.

Project checks

@wigno updated #497 and #496.

@emmaht reviewed the above tasks, and @leonnugraha published them.

@wigno also finished the draft for #283.

@leonnugraha added links in the End-User Inventory.

@femkreations added related tasks to the 6.2 Project Board 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/:

@atachibana completed task #13.

@estelaris mentioned that the Documentation Sitemap was implemented on March 6th.

Discussion on application for Google Season of Docs

The discussion surrounding the application for the Google Season of Docs has been rescheduled to the next meeting.

Check out the additional details in the summary from the previous bi-weekly Docs Team meeting under the same heading.

Collaboration on HelpHub and DevHub redesign request

@estelaris noted the following for translating documentation:

  • The HelpHub and DevDocs redesign request post was published to gather information on processes and needs from locale teams.
  • @estelaris is presenting and discussing the new documentation sites (HelpHub and DevHub) in a recent 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. and will work with the Spanish team.
  • @javiercasares has ideas on how to test/try out ways of translating.
  • @estelaris is working on figuring out if we can use the Inventory as a tracker for polyglots so they are aware when we upload new articles.

How to improve the Glossary in WordPress

Also, in terms of collaboration with the marketing team:

  • @estelaris is looking into the marketing team’s initiative to move the WordPress Glossary to a different place as a single source of reference for WordPress terms.
  • The idea is to replace the many glossaries in the handbooks and make sure we are using the same definition for matching terms.
  • Make teams should be in charge of updating and adding new glossary terms, as needed.
  • @chanthaboune is aware of this initiative and has requested to be updated so support can be provided.

Update on the Docs inventory

This part of the meeting was unintentionally missed so it will be added to the agenda for the next bi-weekly Docs Team meeting.

Open floor

@estelaris has already reached out to 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, but asked if any one had suggestions on how to get a page listing for the Support Articles page in Spanish. There are currently no sitemaps on the Rosetta sites:

  • @javiercasares suggested an alternate solution if other options aren’t available: Creating a page with the link list by using an APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways.. One currently exists, though, it’s empty.

Please note: As a reminder, Daylight Saving is quickly approaching. In Europe it begins on March 26th and in North America Daylight Saving started on March 12th. Regardless, Documentation Team meetings remain at the same scheduled time of 14:00 UTC.

#docs, #meetings, #summary

Femy Praseeth 10:12 pm on March 15, 2023
Tags: 6.2, ,   

Call for volunteers to help with 6.2 end user documentation

The Docs team needs your help to update and revise the End User Documentation (HelpHub) for the upcoming WordPress 6.2 release, expected on March 28, 2023.

You can find a list of all the tasks in the 6.2 project board in the Documentation’s repo 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/.

The tasks have been sorted into medium priority tasks and high priority tasks. The team plans to complete the high priority tasks by the 6.2 scheduled release date.

How you can help

If you are new to the Docs team, you can select from the list of good first issues.

If you are new to contributing to WordPress, you can review this onboarding post with training videos and links to help you get started.

Based on what you are interested in, review the medium priority tasks, high priority tasks or good first issues.

Mention in a comment on the GitHub issue you would like to work on and someone on the Docs team will assign it to you.

Once a task is assigned to you, the following two videos show how to help with updating the existing articles in End User Documentation (HelpHub).

Video onboarding to End User documentation

Video showing how to help with updating the existing articles on GitHub

If you have questions or need help, ask in the docs channel on the 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/. or directly in the GitHub issue itself. If your meetupMeetup All local/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https://www.meetup.com/. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for ‘WordPress’ on meetup.com will help you find options in your area. or firm can give a 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. of time to help, do include the Release co-leads for 6.2 documentation in your message: (Slack IDs) @bph, @zzap, @Femy, and @abhanonstopnewsuk.

Resources

If you need a test site with WordPress 6.2 pre-installed, you can use this app provided by InstaWP to spin up a new temporary website set. It is preloaded with Theme Test data and other pre-configuration, ready to go. This new site will be available to use for four hours. After that, if you need another test site to contribute to docs, you can visit the link again and create a new temporary site.


Props to @bph @webcommsat @milana_cap for collaborating and reviewing this article.

#6-2, #docs, #helphub

Jenni McKinnon 2:37 pm on March 6, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting March 7, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 7 March 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. Discussion on a proposed application for the Google Season of Docs
  6. Starting collaboration with 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/. on HelpHub and DevHub redesign request
  7. How to improve the Glossary in WordPress
  8. Update on the Docs inventory
  9. Open floor

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

Please note: As a reminder, Daylight Saving is quickly approaching. In Europe it begins on March 26th and in North America Daylight Saving starts March 12th. Regardless, Documentation Team meetings remain at the same scheduled time of 14:00 UTC.

#agenda, #meetings

Jenni McKinnon 2:24 pm on March 6, 2023
Tags: , ,   

Summary for Docs Team meeting, February 21, 2023

Attendance

@ninianepress @ninthcoder @femkreations @estelaris @sereedmedia

Housekeeping

Find the complete Transcript of the meeting on Slack.

Project checks

@leonnugraha worked on the Navigation block article during the WC Asia Contributor Day. Because it’s so outdated, it requires a new document once the WordPress v6.2 release candidateRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. is out. Work on this article will continue then.

@femkreations completed gardening the closed pull requests 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/ from 14.2 through 15.1, and added the “User Documentation” label.

Additionally, 4 issues in 6.0 and 1 issue in 6.1 were closed.

@estelaris mentioned that the biggest ticket for the categorization project – moving technical articles to DevHub with issue #388 – is now closed. A big thank you goes out to @JavierCasares.

Discussion on application for Google Season of Docs

The discussion for a proposed application for the Google Season of Docs has been rescheduled to the next meeting.

Google has a program where you can apply as an open sourceOpen Source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL. project. If you get chosen, Google will help you with the project’s documentation.

In 2020, the Documentation Team participated, and our style guide was completed. We need to think of a good project in order to be chosen since the competition is high. @milana_cap is already making inquiries to see if we can participate again this year.

It’s important to note that the application process has changed so this will also need to be considered in future discussion.

@sereedmedia mentioned asynchronously that the glossary may be a great project to apply for and @estelaris agreed.

Open floor

@estelaris is meeting with the 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/. to discuss collaboration on documentation updates.

#docs, #meetings, #summary

Erica Varlese 4:44 pm on February 21, 2023
Tags: ,   

X-post: HelpHub and DevDocs redesign request

X-post from +make.wordpress.org/polyglots: HelpHub and DevDocs redesign request

Jenni McKinnon 11:03 pm on February 10, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting February 21, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 21 February 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. Discussion on a proposed application for the Google Season of Docs
  6. Open floor

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

#agenda, #meetings