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/

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.

Milana Cap 2:06 pm on September 25, 2023  

End-user docs repo – workflows and settings

As you may know, the Documentation team is starting a collaboration with other teams, mainly Polyglots, in translating complete end-user documentation (HelpHub). This documentation and its many translations will have a new place to live: 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 WordPress/documentation-end-user.

Before we start translating, we must move all existing docs to the repo. After that is done, all translations, as well as creating new documentation in English and updating the existing one, will happen in that same repository.

This means a lot of new contributors, new contributor roles, different workflows, and different processes… Rather than letting the mess dictate our repo settings and workflows, let’s try to use our experience with Issue Tracker and predict possible problems and needs.

For this purpose, a new GitHub project is created: End-user docs repo – workflows and settings.

As a starting point, let’s identify different user roles contributing to the end-user docs repo and what would make their contributions easier and more streamlined.

All the issues are created as user stories and are only concerned with a single problem.

At this point, there are the following settings in the project. These might be incomplete and/or wrong, which we will know in time.

Persona

  • First-time contributor
  • Experienced contributor
  • Repo maintainer
  • Issues coordinator
  • First-time reviewer
  • Experienced reviewer
  • Translator
  • Translation editor
  • Any contributor

The life cycle of an issue

  • Creating issue
  • Updating screenshots
  • Creating new documentation
  • Reviewing issue
  • Managing issue
  • Working on issue

Type of workflow

  • Automation
  • Manual
  • Template (issue and pull request)

The end result of this effort should give us the idea of the following:

  • How the issue/pull request is named – template
  • What is the structure of the issue/pull request
  • The list of labels with descriptions and explanations of when to use them
  • Automated tasks
  • The life cycle of the issue/pull request
  • Well-defined user roles and their responsibilities

Feel free to start adding new stories and keep in mind to focus on a single problem per issue.

Leonardus Nugraha 1:03 am on September 22, 2023
Tags: ,   

Online monthly Docs Team Contributor Day September 26, 2023

The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month. Anyone 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 September 2023, 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 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

Julia Golomb 8:52 pm on September 21, 2023
Tags: ,   

X-post: Community Summit 2023: Your Role in What’s Next

X-comment from +make.wordpress.org/summit: Comment on Community Summit 2023: Your Role in What’s Next

noumantech 6:53 am on September 18, 2023  

Agenda for Docs Team Biweekly Meeting (September 19, 2023)

The schedule of the next meeting is as follows:

When: Tuesday, 19-Sep-2023 14:00 UTC

Where: #docs channel on 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/.

Agenda:

1. Attendance.
2. Selection of a Note-taker and facilitator for the next docs team meeting.
3. Facilitator selection for the next triage.
4. Project check.
5. Open floor.
Please feel free to leave a comment to add to the Open floor discussion

noumantech 7:44 pm on September 6, 2023
Tags: , ,   

Summary of Docs Team Biweekly Meeting (September 05, 2023)

Attendance

@noumantech @cold-iron-chef  @sagargurnani @marcio-zebedeu @leonnugraha @milana_cap  @estelaris @611shabnam @javiercasares @devmuhib @jyolsna @atachibana 

Housekeeping

Find the complete Transcript of the meeting on Slack.

Next Meetings Facilitators and Note Takers

Project Checks

@milana_cap added contributing docs and Serbian language to the new HelpHub repo. She has also started working on #1102 and started retiring old articles that are moved to the Advanced Administration Handbook. @milana_cap created a new project board for inventory of end user docs and collected all HelpHub articles and categories via REST APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/.

@sagargurnani completed the #935, self-assigned #203, and asked @milana_cap about the status of #935.

@611shabnam is still working on #678 and her progress is slow due to deadlines in the current month.

@leonnugraha shared the progress of US Contributors Day. He completed and closed #694, #973, #947, #936, #937, #941, and #975.

@jyolsna completed #974 by updating the screenshots.

@marcio-zebedeu is working on #978 and needs more time to complete it.

@cold-iron-chef is behind on one issue and will complete it by next week.

@estelaris shared his plans to start work on Future plans for HelpHub, the documentation team handbook, and finish the WP End-user docs inventory. @milana_cap and @estelaris discussed the schedule to collaborate on various days on these tasks.

Open Floor

@estelaris shared the Figma design for the proposed design of HH’s landing page and asked the Docs Team to have a discussion for approval. Matt is not happy with the design and needs improvement in fonts and spacing. @milana_cap raised a concern about the wasting of space in the categories section of the landing page design.

@leonnugraha shared screenshots from the Figma design and suggested an increase in the font size of headings. @estelaris mentioned that the current heading font size in the template should be suitable for all languages. @cold-iron-chef supported the point of general rules for different languages by sharing her experience with French/English Websites.

@estelaris asked everyone to leave comments on the Figma File and told team members to Click on the :speech_balloon: icon if anyone has a problem leaving comments.

@estelaris shared another proposal for the translation and localization of docs for review. The design is not final and it will be published on the next day after the meeting.

#docs, #meeting, #summary

Jeffrey Paul 5:34 pm on September 6, 2023
Tags: ,   

X-post: Community Summit Discussion Notes: Ad hoc session on iterating on the Field Guide

X-comment from +make.wordpress.org/summit: Comment on Community Summit Discussion Notes: Ad hoc session on iterating on the Field Guide

Javier Casares 4:21 pm on September 6, 2023
Tags: ,   

X-post: Proposal: Documentation translation / localization

X-comment from +make.wordpress.org/project: Comment on Proposal: Documentation translation / localization

Benjamin Evans 8:30 am on September 2, 2023
Tags: ,   

X-post: What’s new on Learn WordPress in August 2023

X-comment from +make.wordpress.org/updates: Comment on What’s new on Learn WordPress in August 2023

Sagar Gurnani 7:41 pm on September 1, 2023
Tags: , ,   

Agenda for Docs Team Biweekly Meeting (05-Sep-2023)

The next meeting is scheduled with the following details:

When: Tuesday, 05-Sep-2023 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. Open floor.
    • Review of the latest docs redesign in Figma.
    • The proposal for documentation translation/localization.

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

#docs #meetings #agenda

Jenni McKinnon 7:29 pm on August 21, 2023
Tags: ,   

Online monthly Docs Team Contributor Day August 29, 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, 29 August 2023, 1:00-4:00 PM UTC

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

Please also see Contributor Day — 29 August, 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.

Date switched from regular schedule

It may also be important to note that the regularly scheduled Docs Team Contributor Day was on August 22, but the Docs Team decided in a meeting that it would be switched to the following week to account for WCUS.

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