Onboarding to Documentation team – DocsWP

Note: If you contributed to the Documentation team, please submit the form on the right 👉
Thank you for contributing 🍪🍪🍪

Here is some quick info you need in order to start contributing to Documentation team.

Accounts:

WordPress.org account.
WordPress Slack account (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/ account is needed).
GitHub account – connect your GitHub account to your WordPress.org profile.

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 by 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

internally called HelpHub
Located at https://wordpress.org/support/
Recording: https://wordpress.tv/2022/06/21/milana-cap-end-user-documentation-onboarding-for-wordpress-documentation-team/

Developer documentation

Internally called DevHub
Located at https://developer.wordpress.org/

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.