TensorFlow 2.0 Global Docs Sprint
Written by Margaret, reviewed by Sergii & Paige
In case of questions, please contact the following:
Review the global docs sprint plan
Send sign-up form to potential organizers:
ML GDEs, TensorFlow testers and docs contributor.
Organizer sign up deadline (for funding consideration).
Communicate to the organizers about funding decisions.
Organizers training - 1st session
Meetup pages ready for participants to sign up.
Organizers training - 2nd session
Organizers training - 3rd session
Global docs sprints. Margaret/Paige/Sergii will be online to help answer questions.
A doc sprint is a way to improve the documentation for an open-source library.
Here is an example: Pandas documentation sprint.
We are organizing TensorFlow docs sprint to improve TensorFlow 2.0’s documentation.
You can sign up to organize an in-person or remote event, share with attendees:
Saturday June 1, 2019
Ideally the event should take place on June 1, 2019; however, it's OK to be on another day for example, you are planning the doc sprint as part of your GDG I/O Extended event.
Experts and beginners are welcome!
You are great at organizing events.
Please sign up here to indicate your interest of running a doc sprint.
Sign up only if you are organizing an event of more than a few attendees. If you just want to participate in the doc sprint, wait until we publish the list of the events for you to choose the closest one to participate.
Limited funding will be provided to doc sprints organized by ML GDEs or GDG organizers.
Please fill up the sign-up form by 4/25/2019 for consideration of funding. Otherwise you have until the end of April to sign up as an organizer.
Please follow the GDG / GDE funding request / reimbursement process for your region.
By 5/1/2019, please create an event page where participants can sign up. You can create it on meetup or as a session on your agenda if it’s a larger event.
Here are a few examples of the TensorFlow doc sprint:
The doc sprint could be 2 to 3 hours. A typical format for the doc sprint:
You can make it longer (a stand alone event) or shorter if you are adding the doc sprint to an existing event.
You could start with breakfast, kickoff at 10AM, lunch at noon then continue a bit more and wrap up after lunch; alternatively conduct an afternoon session around 2-5PM with light snacks.
There were 3 sessions of organizers training on April 30, May 21 and May 28, 2019.
Refer to the information below:
From our past doc sprints, attendees are much more engaged if there are some interesting TensorFlow 2.0 talks, or at least a “intro to TF 2.0 talk”.
The docs sprint is a very hands-on session so try to keep the number of attendees no more than 50 to 75 people. Make sure your event has a few coaches who are familiar with the doc review and PR process to help answer questions.
While the event has some hands-on practices onsite, most of the activities will happen afterwards. After your doc sprint, make sure the attendees know how to continue to contribute to TensorFlow docs.
Please use #TFDocsSprint in your social media posting.
Please add photos of your docs sprint to this photo album: bit.ly/TFDocsSprint-Photos
Note: in order to make sure the album doesn’t have overwhelmingly too many photos, please limit your photos to 5 to 10 photos per event and add only the best shots.