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

If you have any questions or you’d like to have an “in more detail” session, feel free to leave the comment below.

Agenda for Docs Team Meeting 16 August 2022

Our next Team meeting is scheduled with the following details:

When: Tuesday, August 16, 2022, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

#agenda, #meeting-agenda, #meetings

Kick-off WordPress 6.1 release docs

Thank you for participating in the kick-off meeting for the WordPress 6.1 release documentation team: @milana_cap, @femkreations, @mburridge, @bph (facilitator and notetaker). @webcommsat participated asynchronously and added input from the video. 

The meeting was recorded and is available on YouTube.

Updated August 11: refined the instructions to match the GitHub Tracking issue for 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 PRs.

TL;DR: Follow the progress

Links to relevant information.

Next Steps and process for 6.1

Triage Phase

DevNotes and Developer Documentation

  • Add ‘Needs Dev Note’ label to tickets in milestones, and 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/ 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 releases
  • Trac tickets ‘needs-dev-note’
  • 🙋‍♀️ Triage TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets – Milana
  • GitHub (Gutenberg) needs dev note
  • 🙋‍♀️ Triage Gutenberg plugin PRs – Birgit

End User Documentation

  • Add '[Type] User Documentation' or needs user-doc labels to Trac tickets and Gutenberg PRs and all will be tracked via the 6.1 Project for both (trac + GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/)
  • GitHub Gutenberg [Type] User Documentation
  • 🙋‍♀️ Add labels to PRs on Gutenberg – Femy
  • 🙋‍♀️ Trac Tickets to be labeled with needs-user-docs: Milana

Tracking

  • Add ‘needs dev note’ / ‘needs dev docs’ tickets to the project – Milana
  • Create issues for pages once the scope of user-facing features tracked with [Type] User Documentation is determined – Femy
  • Track Gutenberg needs dev note via the Tracking issue on GitHub and connect with developers regarding delivery – Birgit
  • Reach out to the Component Maintainers for the “But Wait there is more” tickets – Birgit. Abha, if extra hands needed

Delivery and Collecting the Dev Notes Tasks

After BetaBeta A pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process. 1, it will be pretty clear which patch and PR will make it into the WordPress 6.1 release. It would help tremendously if dev notes are drafted between Beta 1 and Beta 2 (for 6.1, this will be between September 20 and 27, 2022). This will help the reviewers have more time to give it a fuller review.

Stand-along Post

If a dev note requires a separate post, the process is slightly different between dev notes concerning the Gutenberg project and developers who provided a patch on trac.
The instructions for dev notes on Editor features are listed in the GitHub Tracking Issue for DevNotes

For developers who provided commits via trac also draft the dev note on Make Blog, and once drafted, the developer should add a message to the docs channel, with the public preview link to let the team know it’s ready for review.

For small dev notes for a combined post

If only a small dev note is required, it will be published with other notes in a combined post (Miscellaneous Block Editor, or Miscellaneous Theme, Miscellaneous Caching). The developer assigned will add the dev notes as a comment to the particular PR or the Trac ticket.
Trac tickets also are then labeled with has dev note.
For the GitHub PRs the developer should post a comment on the GitHub tracking issue
The release documentation team will review and collect those for the Miscellaneous blog posts.

Tasks for release documentation team:

  • provide author privileges to developers who write dev notes
  • collect the small notes from the PRs and organize them on Miscellaneous Dev Note posts
  • collect snippets from the Component Maintainers’ responses
  • compile the Field Guide
  • assist in triaging, prioritizing and recruit writers for End User Documentation

How to get involved? 

End User Documentation updates

With new features coming to WordPress, the majority of help is needed in triaging, scoping and executing changes to the end user documentation for the block editor. Femy Praseeth @femkreations, a documentation team project rep and one of the co-leads of the 6.1 release documentation team, is the contact point if you can help with one of the areas listed below.

  • Triaging: join in on labeling user-facing Gutenberg PRs for End-User Documentation
  • Issue Gardening: once all issues are reviewed, create issues in Documentation Issue Tracker repo for End-User Documentation, adding information from the PRs to the description
  • Writing: add and edit identified pages of  End User documentation 
  • Taking screenshots (Training video)

Abha will support Femy in triaging, prioritizing and recruiting writers for End User Documentation.

Write and review 6.1 Dev Notes

In the next few weeks, Abha will co-ordinate additional steps to help those writing dev notes, including information on adding excerpts, a summary paragraph at the top of the post, the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. style guide, and avoiding using ‘here’ for links which are difficult for accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility), etc.

Developers of release features which will be relevant for other developers will write the dev notes or the relevant section to include into a collection of dev notes. If you are assigned a dev note, drafting it on the Make blog between Beta 1 and Beta 2 would be great. Please do not publish the dev note until it has been through its review stages. It will be published by the Release Documentation Team and the GitHub entry updated.

Each dev note requires two people to review, plus final review by the documentation release team. If you like to review other people’s writing, reviewing dev notes could be for you! 

Find out more

As the team is just starting to get all the pieces in place, they might not have all the answers yet.

Please don’t hesitate to comment below or send a message via 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/. #docs channel and pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” either @femkreations, @milana_cap or @bph.

Props for reviewing the post: @webcommsat, @milana_cap, @femkreations, @audrasjb

#6-1, #dev-note, #meetings, #summary

Summary of Docs Team Biweekly Meeting August 2, 2022

Housekeeping

Project Checks

Documentation Issue Tracker Updates

  • @leonnugraha is almost finished with #315 and #270
  • @lucp is still working on #375
  • @milana_cap
    • created two GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ workflows: 1. automated adding issue to the project based on applied labels; 2. automated comment on the issue, mentioning project reps based on applied labels
    • moved docs handbook project to new ones to make above automation possible: https://github.com/orgs/WordPress/projects/43/views/1
    • continue working on team roles docs: https://github.com/WordPress/Documentation-Issue-Tracker/issues/385
  • @colorful-tones is adding lots of feedback to the Patterns doc for the Theme Developer Handbook #342
  • @femkreations
    • 19 items  in the 5.9 issues have been closed (all of them have been updated now for 6.0 as well)
    • 2 new pages were created and updated for 6.0. 12 pages are a work in progress currently
    • the 5.9 issues project board and merging it into the 6.0 soon. New contributors please refer to the 6.0 issue board for 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 docs

Inventory of technical Parts from End-User docs

@estelaris is updating the Inventory of technical Parts from End-User docs, adding other articles to be reviewed and edited after the second site map revision.

Helphub redesign/reclassification project

@estelaris reported that the last revision of the site map has taken longer than expected and will write a post after the second revision is done. These items are still in the works:

  • Update the template with the developers block
  • Add a link to features and requirements (under the About menu item)
  • Finish updating the tickets for articles to rename, move to DevHub and delete
  • Update the categories/subcategories in HelpHub (per 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. instructions) but not changing categories to any article yet

Updates on the Five for the Future program and proposed improvements

The idea is to track better and more contributions, especially those that are not code. As of last week, there are new items already showing in contributors profiles.

For docs team, it mean that opening/closing/being assigned to an issue in the Issue tracker repo is going to be displayed on your profile. Still we will have to track some things manually, like facilitating meetings in the #props Slack channel. For contributions done in GitHub see issue #178.

Open Floor

@audrasjb asked if anyone is also curating DevHub user contributed notes and he will write a draft on his process to facilitate other contributions.

@lucp raised his hand as team repTeam Rep A Team Rep is a person who represents the Make WordPress team to the rest of the project, make sure issues are raised and addressed as needed, and coordinates cross-team efforts. for the advanced administration handbook and he will take over the Inventory of technical Parts from End-User docs.

#meetings, #summary

Agenda for docs team bi-weekly meeting 2 August 2022

The next meeting is scheduled with the following details:

When: Tuesday, August 2nd, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda

  1. Attendance
  2. Facilitator selection for Next Meeting
  3. Projects checks
  4. Updates on the Five for the Future program and proposed improvements
  5. Open floor

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

#agenda#meeting-agenda

#agenda, #meetings

Summary of Docs Team Biweekly Meeting July 19th, 2022

Housekeeping

Project Checks

  • @milana_cap re-wrote the homepage and requests feedback in the ticket
  • @milana_cap started working on team roles page.
  • Updated Team page with open positions (see rep positions below).
  • Completed and reviewed 5.9 Block Editor Doc Project tasks:
  • HelpHub design and reclassification project updates from @estelaris:
    • Waiting on a site map review for some articles to move to DevHub.
    • Update two items on the design: change dev docs link for a dev 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. similar to the support block and change items in the menu.
    • Update the images on the post.
    • Plan to release the post with the new design on Thursday, July 21.

DevHub Handbook: Advanced Administration

A 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. TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. ticket is now open for new handbook. Currently, there are developer and end-user docs, but many unsorted docs fall under an “advanced administration” term. Most of the content will be pulled from:

  • HelpHub – Pages that are too technical for end-user docs (see “Technical guides” column in HelpHub sitemap spreadsheet).
  • Codex – Pages that have not been migrated to DevHub/HelpHub because they did not fit into either.

Approving User-Contributed Notes

@lucp linked to a Slack conversation on pending comments on DevHub, some of them dating back for a year. There is ongoing discussion about how to best handle this and a Meta ticket that proposes emailing users when a comment is approved/deleted.

Rep Positions

There are three open rep positions. Those interested should contact @milana_cap.

  • Block Editor Developer Handbook
  • More Info Curator (Code reference)
  • Upcoming Advanced Administration Handbook

See onboarding video for more information. Also, see the complete list of roles.

Open Floor

@colorful-tones started a draft on patterns for the theme developer handbook.

@bph noted that comments on the upcoming developer blog editorial process close on July 20.

#meetings, #summary

Agenda for docs team bi-weekly meeting 19 July 2022

The next meeting is scheduled with the following details:

When: Tuesday, July 19th, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda

  1. Attendance
  2. Facilitator selection for Next Meeting
  3. Projects checks
  4. The new DevHub handbook – Advanced Administration
  5. Approving User contributed notes
  6. Open floor

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

#agenda, #meeting-agenda

X-post: Contributor Teams: Submit WCUS 2022 Table Leads Signup Form by July 29

X-comment from +make.wordpress.org/community: Comment on Contributor Teams: Submit WCUS 2022 Table Leads Signup Form by July 29

Summary of Docs Team Biweekly Meeting July 5th, 2022

Housekeeping

Projects checks

DevHub & Learn WordPress development

  • The #meta team is working on improvements to DevHub (the developers documentation). If you have any suggestions, please comment on this post
  • There is also an x-post from the Learn team. Again, if you are interesting in either collaborating or have ideas, please comment. The docs team is actively contributing with the Learn team.

Open Floor

  • @mburridge wanted clarification on whether to continue creating 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 issues in the Documentation-Issue-Tracker. (see issues #379 and #75).
  • While the Block Editor Handbook falls under 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/ team, @milana_cap mentioned in one of the issues that we might as well gather all issues regarding the Block Editor Handbook in the Documentation-Issue-Tracker while the docs team is preparing to send over a larger issue to the Gutenberg team with all sorts of improvements.
  • Similar issues as #379 and #75 should be posted in #docs so the team can take a look at it. @milana_cap later clarified the point on slack

Props to @greenshady for helping with notes.

#summary

Agenda for docs team bi-weekly meeting 5 July 2022

The next meeting is scheduled with the following details:

When: Tuesday, July 5, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Projects checks
  4. Exploration: Improving DevHub
  5. Learn WordPress development: creating a public roadmap for content creation
  6. Open floor

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

#agenda, #meeting-agenda

X-post: Exploration: improving DevHub

X-post from +make.wordpress.org/meta: Exploration: improving DevHub