Tag Archives: documentation-sprint

Hari Shanker R 1:00 pm on September 20, 2021
Tags: documentation-sprint, , ,   

Kicking off the Community Documentation/Translation Sprint from September 20 to 24

As announced previously, the Community Team is launching a week-long documentation sprint (focussed on translations), as part of the International WordPress Translation Day celebrations! From today (September 20) through September 24, community contributors and deputiesProgram Supporter 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 work together to update Community team handbooks, with a focus on translating them (and related Community Team documentation pages) to local languages! The sprint is open to all, and we warmly welcome everyone to participate!

Of the highest and most immediate impact, the 2021: Return to In-person meetups handbook section and the recent announcement on the return of in-person WordCamps and updated guidelines need attention. If you are looking for a document to start translating, we recommend that you prioritize these pages, due to the importance of these updates.

Want to find out more about the event and learn how to participate? Check out the announcement post for more context and details:

Announcing a WordPress Community Translation Sprint on September 20 – 24!

We also have an excellent Tuesday Training which will guide you on how to translate community team documents:

Tuesday Trainings: How to Translate Community Team Resources

How do I participate in the translation 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. You can also share your updates in the #polyglots-events channel to connect with fellow Polyglots.

If you are new to translating handbooks, check out this Tuesday Training that will answer all your questions. Anyhow, here is a suggested workflow for contributors:

  1. Find a documentation page from the Community Team handbook that you wish to translate.
  2. Check the tracking sheet if anyone else is working on it for your locale. If your locale has already translated handbook pages, check your locale’s Rosetta site to see if anyone has already translated the page – you might also want to check with other community members to see if anyone is working on the docs. If no one is working on the doc and it has not been translated, log it in the sheet. Don’t forget to add the handbook and page names, and 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/ username!
  3. Copy the contents of the page over to a new Google doc. Ensure that its sharing permissions are set to: “Anyone with the link can comment”. If you already have access to your Rosetta site, you can copy the contents over to your locale’s handbook and make changes over there. Feel free to ask in #community-team if you have any questions about any contents in the documentation.
  4. Once you have finished translating the document, you can optionally 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.” one or more of your team members to ask for review. Once the document is finalized, you can go ahead and publish the same in the handbook. If you prepared the translations in a Google Doc, don’t forget to share the same with your Locale Manager(s) or GTEGeneral Translation Editor General Translation Editor – One of the polyglots team leads in a geographic region https://make.wordpress.org/polyglots/teams/. Further information at https://make.wordpress.org/polyglots/handbook/glossary/#general-translation-editor.(s) so that they can update the same on your behalf.
  5. Fill up the spreadsheet to record the changes that you have made and update the field if the translated page was merged.
  6. That’s it, you have successfully made your first contribution to the Docs translation sprint! You can now proceed to work on the next document!

Remember: Every contribution, however small, is valuable!

But… I’m not a Polyglot and I would like to participate! What do I do?

We are glad you asked! While the focus of this sprint is translation, we need your help in reviewing our existing documentation, suggesting changes, and even creating new documentation pages. Even though the tracking Google sheet is aimed at translations, you can use the same to track your documentation updates too.

Of the highest and most immediate impact, the recent announcement on the return of in-person WordCamps and updated guidelines needs attention. You can help us out by creating a handbook page out of the announcement and making the guidelines more visible.

Check out the announcement post of the original docs sprint to learn more about how to update Community Team documentation:

Join the Community Team for a Documentation Editing Sprint on May 25!

I warmly welcome you all once again to join us in this initiative and to help us update our documentation and translate it into as many languages as possible. It will go a long way in supporting the WordPress community!

#documentation-sprint #translation-sprint #sprint #wptranslationday

+make.wordpress.org/polyglots

Hari Shanker R 12:30 pm on August 27, 2021
Tags: documentation-sprint, , ,   

Announcing a WordPress Community Translation Sprint on September 20 – 24!

One of our Community Team goals for 2021 was to translate our Community handbook into different languages. We officially started work on translating our handbooks to different languages as part of past documentation sprints. I would like to extend our efforts by using the Translation Day Celebrations as an opportunity to translate our handbooks to as many languages as possible. 

Towards this, let’s plan another Documentation sprint (focusing on translating Community team content) from September 20 – 24, 2021, in conjunction with the WordPress Translation Day celebrations organized by the Polyglots team! (Thanks for the idea, @evarlese!)

What is the Community Translation sprint?

From September 20 through 24, community contributors and deputiesProgram Supporter 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 translate Community team handbooks and any related documentation for the Community Team to their local language. This differs slightly from the traditional docs sprints we have organized before in that our focus will be on translation. If you are proficient in a non-English language, feel free to join us and help translate the Make/WordPress Community handbook to your local language!

Please note: This translation sprint is restricted to the community team handbook pages – we will not be working on the official 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/ documentation as part of this sprint. However, if you wish to translate wordpress.org documentation and need help, please reach out to your local translation team, or simply 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.” in #polyglots

Read on to find out more!

Continue reading →

#documentation-sprint, #sprint, #translation-sprint, #wptranslationday

Hari Shanker R 6:32 am on July 22, 2021
Tags: documentation-sprint,   

Join the Community Team for yet another Documentation Editing sprint on August 6

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 deputiesProgram Supporter 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.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/ 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 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.” 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 deputiesProgram Supporter 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

Hari Shanker R 2:35 pm on May 24, 2021
Tags: documentation-sprint, ,   

Join the Community Team for a Documentation Editing Sprint on May 25!

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 deputiesProgram Supporter 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 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): 

Of the highest and most immediate impact, the Online Events Handbook needs attention since there have been significant changes to the online WordCamps program of late!

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 deputiesProgram Supporter 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. 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!

#sprint

#documentation-sprint

#translation-sprint

Hari Shanker R 2:45 pm on May 11, 2021
Tags: , documentation-sprint   

Proposal: A documentation editing sprint for the Community team

I won’t mince words here – several pages in the Make/Community handbook are outdated and need to be updated. With recent changes to our program – especially with the shift to online events, some documents have become redundant. Many other documents that are still relevant, have not been updated to incorporate the latest changes. In this background, our docs could benefit from a structured, pro-active approach to make sure that they stay current and accurate.

To achieve this goal, I propose a documentation editing sprint for the Community team!

What is a documentation editing sprint?

Community contributors and deputiesProgram Supporter 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 documents in the Community team handbooks and any related documentation pages, so that they provide accurate and up-to-date information for our community members.

What are the documents that we will be editing?

We should audit, review, and edit the following documents in our Community team handbook:

Since the community team actively works on the Learn WordPress project, it would help to review and make changes to the Learn WordPress handbook as well – if we have the bandwidth.

When do we do it?

I propose that we test this out by organizing an initial sprint exactly two weeks later on May 25th – which is also known as the Towel Day (no points for guessing – I’m a Douglas Adams fan! 🙈). If the initial sprint goes well, we can consider organizing multiple sprints throughout the rest of the year. Community members can work on editing the documentation pages at their own convenience throughout the course of the day.

Who can participate/Who edits the docs?

This initiative is open to all! Many Community deputiesProgram Supporter 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. have edit access to the Make/Community site, they can perhaps edit the documents directly. Other community already members can propose changes in a shared Google doc which can later be merged with the main document.

How do we do it?

It would help to keep track of all the documents and their changes in spreadsheets, or using collaboration tools such as TrelloTrello Project management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing.. Perhaps, before the sprint day, a few deputies can do a pre-event sweep to identify the docs that need to be edited, and encourage contributors to work on those selected documents? Contributors can use a shared Google sheet to update the status of the edits they made and the work they did. We can use the #community-team 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/. channel to coordinate the efforts. The efforts can be spread out throughout the day so that folks can work at their own pace.

Following the event, we publish a recap post to share about the changes that were made during the sprint. If it is successful, we can probably repeat the event later and perhaps even consider organizing regular documentation editing sprints (either once per quarter or once every month).

Request for feedback

  • First of all, what do you think about this idea and the proposed format? Is this something the community team should carry out?
  • Do you know of any specific documents from our handbook that need edits? If so, please share them in the comments.
  • The biggest question: How do we track progress – both contributions from individual community members and changes made to the documents?

Please share your feedback by May 20th (Thursday).

#documentation-sprint #community-team