After a successful documentation sprint on May 25 this year, I would like to announce that we are bringing back the Documentation Sprint for Community Team handbooks on August 6 (Friday). All are welcome to contribute to this initiative. This post contains everything you should know about the documentation sprint, along with details on how you can contribute!
What is a documentation editing sprint?
All day on August 6 (Friday), community contributors and deputies Community Program Supporters (formerly Deputies) are a team of people worldwide who review WordCamp and Meetup applications, interview lead organizers, and keep things moving at WordCamp Central. Find more about program supporters in our Program Supporter Handbook. work together to audit and edit outdated pages in the Community team handbooks and any related documentation for the Community Team so that they provide accurate and up-to-date information for community members. Check out the original proposal for more details and context.
Please note: This documentation sprint is restricted to the community team handbook pages – we will not be working on the official wordpress.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/ documentation as part of this sprint. However, if you wish to contribute to the wordpress.org documentation, please reach out to the documentation team (You can ping 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.” them directly in the #docs channel). They could use all the help they can get!
What documents need editing?
All Community team handbook contents need auditing, reviewing, and updating. This includes (but is not limited to):
Additionally, updating the following handbook pages will have the highest and most immediate impact:
How do I participate in the documentation sprint?
Anyone can participate in this initiative! The team will keep track of edits in a Google Sheet. Please log all the changes you make in that sheet. The team will also coordinate together in the #community-team channel.
There are a few ways to contribute to the sprint:
- Triage: Go through the list of documents, make a note of the pages that need updating (as well as the changes that need to be made), and add them to the tracking sheet.
- Editing: Editing the documentation pages to keep them clear and up-to-date.
- Adding new content: This could include adding Tuesday Trainings to handbooks, translating existing content to new languages, or updating our documentation to include resources on the new guidelines in-person events. Alternatively, if you feel that a new page on a specific topic needs to be added to the handbook, now would be an excellent time to contribute!
To track changes, copy the handbook contents over to a shared Google document, propose the changes over there, and link the document to the shared Google tracking Sheet. Deputies will review and merge those changes later.
Try your best to follow the docs style guide while creating content, as it helps maintain consistency. This is an all-day event, and there is also no time commitment. Try to spend as much time as possible on August 6 editing documents – even if you only have a few minutes. In short, you can contribute at your own pace, as per your convenience and bandwidth.
Every contribution, however small, is valuable!
What’s next, once the event is over?
Community deputies Community Program Supporters (formerly Deputies) are a team of people worldwide who review WordCamp and Meetup applications, interview lead organizers, and keep things moving at WordCamp Central. Find more about program supporters in our Program Supporter Handbook. will review the contributions and merge all the changes that were proposed. The Community team will publish a recap of this initiative requesting feedback from contributors. We also plan to organize regular docs sprints frequently so that our documentation pages stay updated.
I warmly welcome you all once again to join us in this initiative and to help us improve our documentation. It will go a long way in supporting the WordPress community!
#documentation-sprint
#sprint
