Skip to content

Kubeflow Doc Sprint

Jump to bottom
Sarah Maddox edited this page Jul 5, 2019 · 34 revisions
Kubeflow logo

We're holding a Kubeflow doc sprint. That's like a hackathon for docs. Over the course of three days, we'll develop tutorials and fix documentation bugs. You can join us at the Google office in Kirkland, or work remotely from anywhere.

Date and place

When: July 10-12, 2019 (three days, Wednesday to Friday).
Where: Google's offices in Kirkland, WA (across the lake from Seattle) and online (from your computer, anywhere).
Who: You! Kubeflow community, engineers, tech writers, product managers, UX researchers, designers, ...

Getting to the Google Kirkland office:

Address: 777 6th St South, Kirkland, WA 98033, USA

  • It's best to travel via rideshare or public transport. Parking on site is very limited.
  • Sign in at Google reception in building A then wait for someone to escort you to building D.

Agenda

  • Wednesday July 10: Welcome; docs/code development; learning sessions.
  • Thursday July 11: Sprint updates; docs/code development; learning sessions.
  • Friday July 12: Docs/code development; sprint demos.

Take a look at the day-by-day agenda.

Signup

Complete the registration form to let us know you're interested.

In a doc sprint, every day is launch day. So join us at the inaugural Kubeflow Doc Sprint if you can!

Spreading the word

Tweet #KubeflowDocSprint.

Defining what we want to achieve

We'll build new tutorials and fix bugs during the doc sprint.

  • The doc-sprint Kanban board includes issues tagged with the label doc-sprint. The board also includes some note cards that haven't yet been analysed to produce individual issues. We'll do that analysis and discussion during the sprint, or you can feel free to start earlier too.

  • The tutorial wish list (spreadsheet) is a discussion doc from which many of the above issues are drawn.

Please do add issues or spreadsheet entries at any time. We'll discuss the resulting doc tasks before and during the doc sprint.

Sprinter's guide

Read the doc sprinter's guide.

Learning while you sprint

We’re planning some mini 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. See the mini-talk overviews in learning on the sprint.

Talking to each other

  • Live in the room and over video conference
  • In Kubeflow Slack: #doc-sprint
  • Comments on issues and PRs

Remember:

  • Include remote participants
  • Be aware of multiple time zones
Clone this wiki locally