This contribution sprint has concluded! Together contributors made 35 major edits to the docs, including making changes to existing docs, and creating new docs pages. Most changes were made to the Online Event documentation and the Community Deputy Handbook. Thank you all for your contributions. We will be organizing more such docs sprints in the future. Stay tuned!
In light of the positive feedback on the documentation sprint proposal, I’m happy to announce that the Community team is going ahead with our first Documentation Editing sprint, all-day on Tuesday, May 25th! 🎉 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 May 25th, Community contributors and deputies Community Deputies are a team of people all over the world who review WordCamp and Meetup applications, interview lead organizers, and generally keep things moving at WordCamp Central. Find more about deputies in our Community Deputy Handbook. work together to audit and edit outdated pages in the Community team handbooks and any related documentation so that they provide accurate and up-to-date information for community members. Check out the original proposal for more details and context.
What documents need editing?
All Community team handbook contents need auditing, reviewing, and updating. This includes (but is not limited to):
Additionally, one of our goals is to translate our handbooks to different languages. @mpcdigital and @nao will start working on this as part of this sprint (others are more than welcome to join if interested!) If anyone is interested, it would also be great to add some Tuesday Trainings to our handbooks!
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 or translating existing content to new languages. 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 (make sure the changes are highlighted), and link the document to the shared Google tracking Sheet. Deputies will review and merge those changes later. More details in this page!
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 May 25th towards editing documents – even if you only have a few minutes.
Every contribution, however small, is valuable!
What’s next, once the event is over?
Community deputies Community Deputies are a team of people all over the world who review WordCamp and Meetup applications, interview lead organizers, and generally keep things moving at WordCamp Central. Find more about deputies in our Community Deputy 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. If the event turns out to be a success, more of these sprints can be organized in the future!
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!