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.

X-post: Embracing Matrix for Enhanced Communication

X-comment from +make.wordpress.org/project: Comment on Embracing Matrix for Enhanced Communication

X-post: Create Tours for Make P2s

X-comment from +make.wordpress.org/meta: Comment on Create Tours for Make P2s

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

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

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

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

X-post: Redesigning Developer Resources and a call for testing

X-post from +make.wordpress.org/meta: Redesigning Developer Resources and a call for testing

Agenda for Docs Team meeting November 21, 2023

The next meeting is scheduled with the following details:

WhenTuesday, 21 November 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. Project check
  5. Open floor

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

#agenda, #meetings

Summary for Docs Team Meeting (7-Nov-2023)

Attendance

@milana_cap @leonnugraha @sagargurnani @ninianepress @anandau14 @webcommsat @rashiguptaa @zunaid321. Async: @nalininonstopnewsuk, @611shabnam, @femkreations

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Project Checks

@milana_cap had created 48 good first issues for WordPress 6.4 documentation and ran 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/ roles onboarding session. The recording is uploaded to wordpress.tv but not published yet.

@webcommsat gave an update on WordPress 6.4 release documentation:

(Update – link to full update in the meeting and how contributors can help, including working on or reviewing screenshots, video, new explanations. Highlighted the value of docs in this area to the end user.)

  • Documentation tracker for 6.4
  • Dev notes: one additional dev note has been added to the Editor Miscellaneous Dev Notes today
  • There is one remaining Dev Note which will be done after the release by one of the committers
  • Call for contributors to work on HelpHub
  • Props for all those who had contributed by the beginning of last week have been collated, checked against the main list, and submitted
  • A further props update will be sent once the End User docs (HelpHub) have been updated
  • Ongoing outreach and promotion, particularly the HelpHub end user docs
  • Onboarding / support to cohort and additional volunteers
  • Following up work on End User docs.

@atachibana reviewed one issue #1204, and tackled high priority 6.4 issue #1204, the Site Editor Pattern.

@anandau14 worked on one high-priority task and has 2 more assigned.

Open Floor

@webcommsat raised from experience of the last couple of releases and involvement in CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress., Marketing, Docs, and Training, a resource to help meetups devote a session to helping with User docs would be very useful and raise awareness about docs. More on this suggestion, what has been started in 6.4, and the fuller discussion 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/.. (link to Slack discussion added)

The ideas included to get meetups and companies to sign-up to help earlier in the release cycle, show how fun it can be, and promote our contributor events.

#docs, #meetings, #summary

Summary for Docs Team Meeting (31-Oct-2023)

Attendance

@milana_cap @leonnugraha @sagargurnani @ninianepress @anandau14 @huzaifaalmesbah @femkreations

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Project Checks

@milana_cap had created:
1. Good first issues templates https://github.com/WordPress/Documentation-Issue-Tracker/issues/new/choose.
2. New good first issues, the real ones https://github.com/WordPress/Documentation-Issue-Tracker/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3A6.4.
3. A page about good first issues https://make.wordpress.org/docs/handbook/get-involved/getting-started-at-a-contributor-day/good-first-issues/.
4. A video for checking ALT attributes for the page in the link above.

@anandau14 had worked on #1206 from 6.4 board.

@leonnugraha had reviewed, updated, and closed #1207. He had also reviewed and updated #491 but because there’s still one item needs to be done, so he has not closed the issue.

@femkreations had looked through approximately 150 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/ 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/) that were labeled “Need User Documentation” and identified 34 tasks that need to be worked on, for 6.4 in the end-user documentation. She had also completed adding those tasks to this Project Board. The tasks were then divided into: High Priority, Medium Priority and Good First Issues. She also wrote a Call for Volunteers to help out with the update.

Open Floor

@milana_cap discussed about new GitHub roles i.e. issue coordinator and reviewer. Both of these roles could be performed by anyone, regardless the experience with docs or WordPress and which would require about 1 hour per week or may be less.

Issues Triage

This was the 5th week meeting which turned out to be a combination of the weekly triage and the regular weekly meeting. To look at the issues in WordPress 6.4 High Priority Issues click here.

#docs, #meetings, #summary

Agenda for Docs Team Biweekly Meeting (November 7, 2023)

The schedule of the next meeting is as follows:

When: Tuesday, 07-Nov-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

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

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

Agenda for Docs Team Meeting (October 31, 2023)

This will be the 5th week meeting with a combination of triage and the regular meeting. The schedule of the meeting is as follows:

When: Tuesday, 31-Oct-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. Project check.
3. 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/ roles discussion (issue coordinator and reviewer).
4. Triage.

#agenda, #docs, #meetings