Join us at the next Kubeflow Doc Sprint in February 2020

Sarah Maddox
kubeflow
Published in
3 min readDec 12, 2019

Sarah Maddox, Kubeflow Technical Writer

The Kubeflow community is delighted to announce the next Kubeflow Doc Sprint, coming up in February 2020. Join us to create samples and docs that will help people use Kubeflow. Let’s make the docs show how Kubeflow shines as the ML toolkit for Kubernetes.

Event details

Dates: Monday, February 10, to Wednesday, February 12, 2020.

Location: Google campus in Sunnyvale, CA. For the best experience, join us in person in Sunnyvale. You can also join us online and work remotely from anywhere in the world.

Registration: Complete the doc sprint registration form to let us know you’re interested in attending.

Focus areas

For this sprint, the primary focus is use cases. A November analytics study showed that the use cases section of the docs is increasingly popular. People want to know the most common ways of using Kubeflow, and they need to move on from the getting-started guides to indepth tutorials. But the doc ratings showed that people were disappointed with what they found in the use cases section. We need to fill the gaps.

A related goal is to build more end-to-end tutorials. In a UX study in October, Kubeflow users identified documentation as a top adoption driver, and chose end-to-end tutorials as the area that needs most attention.

We’ll also get in the zone and fix bugs. If you spot a bug in the docs, log an issue now! Include a comment that you think this is a good candidate for the doc sprint. During the runup to the sprint, we’ll add to and refine the Kubeflow Doc Sprint Kanban board. You can start adding issues now!

What happens in a doc sprint?

Want to know what happens in a doc sprint? Check out the results of the highly successful July doc sprint to get an idea of what you’ll be doing during the sprint.

Read the details of the upcoming February doc sprint on the Kubeflow docs wiki.

What will you get out of it?

Camaraderie and…

  • Earn a designer, limited-edition, Kubeflow Docs T-shirt.
  • Light up your GitHub profile: The Kubeflow docs and samples are on GitHub. Your username will appear as author of your contributions.
  • Be part of something big: We’ll write up our results on the Kubeflow blog.
  • Get to know some Kubeflow community members: A doc sprint is a great way of bringing the community together, in the same room and online.
  • Learn while you sprint: We’re planning some lightning talks from UX researchers to help us shine up the way people experience Kubeflow. Technical writers will present tips on writing effectively. You’ll also be able to tap the knowledge of the members of the Kubeflow community who’ll be sprinting with you.
  • Help other people use Kubeflow: We know Kubeflow is great, and we know how to use it. Help other people know too.

How can you take part?

There are many ways you can take part in the doc sprint:

  • Join us on site for one, two or three days, or participate online. You can mix and match: do part of the sprint on site and part online. For the best experience, join us in person so you can chat to the other participants and attend the lightning talks.
  • Write sample code and docs. Fix doc bugs.
  • Review pull requests (PRs).
  • Act as an on-call expert for one or more areas of Kubeflow, to advise sprinters who’re building the tutorials and fixing the docs.
  • Take part in the sprint demos, to show all participants what you’ve achieved and to cheer others on.

Join us!

Help us prove that the July doc sprint wasn’t just a flash in the pan! Fill in the doc sprint registration form to let us know you’d like to join us in person or online. Spread the news and tweet #KubeflowDocSprint.

--

--