TensorFlow 2.0 Global Docs Sprint

Organizers’ Guide

Written by Margaret, reviewed by Sergii & Paige

Contacts

Schedule

When is the global doc sprint?

What is a doc sprint?

Who should organize a doc sprint?

How to organize a doc sprint?

Sign up as an organizer

Funding & Reimbursement

Create an event page

Helpful links

Best practices

Pair with interesting talks

Have coaches there to help

After the event

Communications

Contacts

In case of questions, please contact the following:

Schedule

Date

Owner

Task

4/9/2019 Tuesday

Margaret

Review the global docs sprint plan

4/10/2019 Wednesday

Margaret

Send sign-up form to potential organizers:

ML GDEs, TensorFlow testers and docs contributor.

4/25/2019 Thursday

N/A

Organizer sign up deadline (for funding consideration).

4/29/2019 Monday

Paige

Communicate to the organizers about funding decisions.

4/30/19 Tuesday

Margaret/Paige/Sergii

Organizers training - 1st session

5/8//2019 Wednesday

Organizers

Meetup pages ready for participants to sign up.

5/21/2019 Tuesday

Margaret/Paige/Sergii

Organizers training - 2nd session

5/28/2019 Tuesday

Margaret/Paige

Organizers training - 3rd session

6/1/2019 Saturday

Organizers

Global docs sprints. Margaret/Paige/Sergii will be online to help answer questions.

What is a doc sprint?

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:

When is the global doc sprint?

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.

Who should organize a doc sprint?

Experts and beginners are welcome!

You are great at organizing events.  

How to organize a doc sprint?

Sign up as an organizer

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.

Funding & Reimbursement

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.

Create an event page

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:

Format

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.

Duration

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.

Helpful links

There were 3 sessions of organizers training on April 30, May 21 and May 28, 2019.

See meeting notes here which also includes the event list and the worldwide Docs Sprint map.

Refer to the information below:

Best practices

Pair with interesting talks

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

Have coaches there to help

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.

After the event

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.

Communications

Social Media

Please use #TFDocsSprint in your social media posting.

Photo Album

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.