SlideShare a Scribd company logo
1 of 8
Download to read offline
Sprinting for successThe story of an open source doc sprint | @sarahmaddox
Goals of doc sprint
● Create useful docs and fix bugs● Engage the Kubeflow community
○ Yes, we have docs
○ No, the docs are not perfect/complete
○ Yes, you can update the docs - here’s how
Lightning talks
People like to learn new stuff
People are interested in the patterns of effective tech writing
The lightning talks at the Kubeflow doc sprint:
● How to address the reader in technical documentation
● Passive resistance
● A short guide to writing well
● Kubeflow: a first impression
● Guiding users through a journey
Results of doc sprint
Stats:
● 31 pull requests (PRs) closed
● 32 issues fixed
● 6 more PRs under review
● 50 participants (out of 67 registrations)
● Participants already contributing to docs outside
the sprint
More:
● Gave colleagues the opportunity to show impact
● Generated buzz around Kubeflow and docs
Results of doc sprint
Kubeflow blog post: bit.ly/2H3Bw5g
Contributors to docs repository
Kubeflow Doc Sprint was July 10-12
Activity picked up from that date and has continued strong:
https://github.com/kubeflow/website/graphs/contributors
Commits to docs repository
Kubeflow Doc Sprint was July 10-12
Activity picked up from that date and has continued strong:
https://github.com/kubeflow/website/graphs/commit-activity
Want to run a doc sprint yourself?
Top tips:
● Start planning early
● Create and collaborate on a wish list / backlog
● Pay attention to the humdrum stuff
● Extra: Learning on the sprint
● Prizes and food
How to run a doc sprint: bit.ly/2H6lt6Z

More Related Content

Similar to Sprinting for success - the story of an open source doc sprint

DockerCon US 2016 - Scaling Open Source operations
DockerCon US 2016 - Scaling Open Source operationsDockerCon US 2016 - Scaling Open Source operations
DockerCon US 2016 - Scaling Open Source operationsArnaud Porterie
 
apidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylas
apidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylasapidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylas
apidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylasapidays
 
Engaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source ContributhonEngaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source ContributhonYoungbin Han
 
Overcoming the Fear of Contributing to Open Source
Overcoming the Fear of Contributing to Open SourceOvercoming the Fear of Contributing to Open Source
Overcoming the Fear of Contributing to Open SourceAll Things Open
 
Digital Art History: From Practice to Publication
Digital Art History: From Practice to PublicationDigital Art History: From Practice to Publication
Digital Art History: From Practice to PublicationSusan Edwards
 
Sustainability for Project-Based Collaborative Work: Leveraging Service Level...
Sustainability for Project-Based Collaborative Work: Leveraging Service Level...Sustainability for Project-Based Collaborative Work: Leveraging Service Level...
Sustainability for Project-Based Collaborative Work: Leveraging Service Level...Franny Gaede
 
Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...
Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...
Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...Prasid Pathak
 
Why Drupal Is Not a Word Processor
Why Drupal Is Not a Word ProcessorWhy Drupal Is Not a Word Processor
Why Drupal Is Not a Word ProcessorCaroline Roberts
 
Drupal UAL Pechakucha CSM UAL CoP event 16-9-13
Drupal UAL Pechakucha CSM UAL CoP event 16-9-13Drupal UAL Pechakucha CSM UAL CoP event 16-9-13
Drupal UAL Pechakucha CSM UAL CoP event 16-9-13Chris Follows
 
Creating and Managing Technical Content for Open Source Products
Creating and Managing Technical Content for Open Source ProductsCreating and Managing Technical Content for Open Source Products
Creating and Managing Technical Content for Open Source ProductsWSO2
 
Gsoc2012 checklist
Gsoc2012 checklistGsoc2012 checklist
Gsoc2012 checklistDavid Bain
 
The future of the OCA, Odoo Community Association
The future of the OCA, Odoo Community AssociationThe future of the OCA, Odoo Community Association
The future of the OCA, Odoo Community AssociationMaxime Chambreuil
 
K-2 Building Bridges to Tomorrow 14-1 Kickoff
K-2 Building Bridges to Tomorrow 14-1 KickoffK-2 Building Bridges to Tomorrow 14-1 Kickoff
K-2 Building Bridges to Tomorrow 14-1 KickoffFlat Connections
 
Are we there yet? Rev up your productivity with project management tools
Are we there yet? Rev up your productivity with project management toolsAre we there yet? Rev up your productivity with project management tools
Are we there yet? Rev up your productivity with project management toolsMargot
 
Are we there yet? Rev up your productivity with project management tools
Are we there yet?  Rev up your productivity with project management toolsAre we there yet?  Rev up your productivity with project management tools
Are we there yet? Rev up your productivity with project management toolsAnnis Lee Adams
 
Google summer of code with drupal
Google summer of code with drupalGoogle summer of code with drupal
Google summer of code with drupalNaveen Valecha
 

Similar to Sprinting for success - the story of an open source doc sprint (20)

Open Source in Real Life
Open Source in Real LifeOpen Source in Real Life
Open Source in Real Life
 
DockerCon US 2016 - Scaling Open Source operations
DockerCon US 2016 - Scaling Open Source operationsDockerCon US 2016 - Scaling Open Source operations
DockerCon US 2016 - Scaling Open Source operations
 
apidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylas
apidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylasapidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylas
apidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylas
 
Engaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source ContributhonEngaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source Contributhon
 
Overcoming the Fear of Contributing to Open Source
Overcoming the Fear of Contributing to Open SourceOvercoming the Fear of Contributing to Open Source
Overcoming the Fear of Contributing to Open Source
 
Google apps and common core
Google apps and common coreGoogle apps and common core
Google apps and common core
 
Digital Art History: From Practice to Publication
Digital Art History: From Practice to PublicationDigital Art History: From Practice to Publication
Digital Art History: From Practice to Publication
 
Sustainability for Project-Based Collaborative Work: Leveraging Service Level...
Sustainability for Project-Based Collaborative Work: Leveraging Service Level...Sustainability for Project-Based Collaborative Work: Leveraging Service Level...
Sustainability for Project-Based Collaborative Work: Leveraging Service Level...
 
Collaboration Tools at the U
Collaboration Tools at the UCollaboration Tools at the U
Collaboration Tools at the U
 
Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...
Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...
Beginner's Guide to Frontend Development: Comparing Angular, React, Ember, an...
 
Why Drupal Is Not a Word Processor
Why Drupal Is Not a Word ProcessorWhy Drupal Is Not a Word Processor
Why Drupal Is Not a Word Processor
 
Drupal UAL Pechakucha CSM UAL CoP event 16-9-13
Drupal UAL Pechakucha CSM UAL CoP event 16-9-13Drupal UAL Pechakucha CSM UAL CoP event 16-9-13
Drupal UAL Pechakucha CSM UAL CoP event 16-9-13
 
McCready and Clark "Project Management in Libraries"
McCready and Clark "Project Management in Libraries"McCready and Clark "Project Management in Libraries"
McCready and Clark "Project Management in Libraries"
 
Creating and Managing Technical Content for Open Source Products
Creating and Managing Technical Content for Open Source ProductsCreating and Managing Technical Content for Open Source Products
Creating and Managing Technical Content for Open Source Products
 
Gsoc2012 checklist
Gsoc2012 checklistGsoc2012 checklist
Gsoc2012 checklist
 
The future of the OCA, Odoo Community Association
The future of the OCA, Odoo Community AssociationThe future of the OCA, Odoo Community Association
The future of the OCA, Odoo Community Association
 
K-2 Building Bridges to Tomorrow 14-1 Kickoff
K-2 Building Bridges to Tomorrow 14-1 KickoffK-2 Building Bridges to Tomorrow 14-1 Kickoff
K-2 Building Bridges to Tomorrow 14-1 Kickoff
 
Are we there yet? Rev up your productivity with project management tools
Are we there yet? Rev up your productivity with project management toolsAre we there yet? Rev up your productivity with project management tools
Are we there yet? Rev up your productivity with project management tools
 
Are we there yet? Rev up your productivity with project management tools
Are we there yet?  Rev up your productivity with project management toolsAre we there yet?  Rev up your productivity with project management tools
Are we there yet? Rev up your productivity with project management tools
 
Google summer of code with drupal
Google summer of code with drupalGoogle summer of code with drupal
Google summer of code with drupal
 

More from Sarah Maddox

A tech writer, a map, and an app
A tech writer, a map, and an appA tech writer, a map, and an app
A tech writer, a map, and an appSarah Maddox
 
The future *is* technical communication
The future *is* technical communicationThe future *is* technical communication
The future *is* technical communicationSarah Maddox
 
Working with an Engineering Team
Working with an Engineering TeamWorking with an Engineering Team
Working with an Engineering TeamSarah Maddox
 
Bit Rot in the Docs
Bit Rot in the DocsBit Rot in the Docs
Bit Rot in the DocsSarah Maddox
 
API Technical Writing
API Technical WritingAPI Technical Writing
API Technical WritingSarah Maddox
 
Doc sprints: The ultimate in collaborative document development
Doc sprints: The ultimate in collaborative document developmentDoc sprints: The ultimate in collaborative document development
Doc sprints: The ultimate in collaborative document developmentSarah Maddox
 
Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012Sarah Maddox
 
Tekom tcworld 2012 - Engaging readers via social media
Tekom tcworld 2012 - Engaging readers via social mediaTekom tcworld 2012 - Engaging readers via social media
Tekom tcworld 2012 - Engaging readers via social mediaSarah Maddox
 
Building a developer documentation wiki
Building a developer documentation wikiBuilding a developer documentation wiki
Building a developer documentation wikiSarah Maddox
 
Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?Sarah Maddox
 
Collaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wikiCollaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wikiSarah Maddox
 
Confluence as platform for technical documentation
Confluence as platform for technical documentationConfluence as platform for technical documentation
Confluence as platform for technical documentationSarah Maddox
 
Summit2012 proposal-sarah maddox
Summit2012 proposal-sarah maddoxSummit2012 proposal-sarah maddox
Summit2012 proposal-sarah maddoxSarah Maddox
 
A little bird told me... about a good page in your user guide
A little bird told me... about a good page in your user guideA little bird told me... about a good page in your user guide
A little bird told me... about a good page in your user guideSarah Maddox
 

More from Sarah Maddox (16)

One word or two
One word or twoOne word or two
One word or two
 
A tech writer, a map, and an app
A tech writer, a map, and an appA tech writer, a map, and an app
A tech writer, a map, and an app
 
The future *is* technical communication
The future *is* technical communicationThe future *is* technical communication
The future *is* technical communication
 
Working with an Engineering Team
Working with an Engineering TeamWorking with an Engineering Team
Working with an Engineering Team
 
Bit Rot in the Docs
Bit Rot in the DocsBit Rot in the Docs
Bit Rot in the Docs
 
API Technical Writing
API Technical WritingAPI Technical Writing
API Technical Writing
 
Api types
Api typesApi types
Api types
 
Doc sprints: The ultimate in collaborative document development
Doc sprints: The ultimate in collaborative document developmentDoc sprints: The ultimate in collaborative document development
Doc sprints: The ultimate in collaborative document development
 
Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012
 
Tekom tcworld 2012 - Engaging readers via social media
Tekom tcworld 2012 - Engaging readers via social mediaTekom tcworld 2012 - Engaging readers via social media
Tekom tcworld 2012 - Engaging readers via social media
 
Building a developer documentation wiki
Building a developer documentation wikiBuilding a developer documentation wiki
Building a developer documentation wiki
 
Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?
 
Collaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wikiCollaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wiki
 
Confluence as platform for technical documentation
Confluence as platform for technical documentationConfluence as platform for technical documentation
Confluence as platform for technical documentation
 
Summit2012 proposal-sarah maddox
Summit2012 proposal-sarah maddoxSummit2012 proposal-sarah maddox
Summit2012 proposal-sarah maddox
 
A little bird told me... about a good page in your user guide
A little bird told me... about a good page in your user guideA little bird told me... about a good page in your user guide
A little bird told me... about a good page in your user guide
 

Recently uploaded

Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Mark Simos
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024Lonnie McRorey
 
Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupFlorian Wilhelm
 
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024BookNet Canada
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii SoldatenkoFwdays
 
Commit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyCommit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyAlfredo García Lavilla
 
Connect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck PresentationConnect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck PresentationSlibray Presentation
 
TrustArc Webinar - How to Build Consumer Trust Through Data Privacy
TrustArc Webinar - How to Build Consumer Trust Through Data PrivacyTrustArc Webinar - How to Build Consumer Trust Through Data Privacy
TrustArc Webinar - How to Build Consumer Trust Through Data PrivacyTrustArc
 
Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptx
Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptxPasskey Providers and Enabling Portability: FIDO Paris Seminar.pptx
Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptxLoriGlavin3
 
Use of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptx
Use of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptxUse of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptx
Use of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptxLoriGlavin3
 
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024BookNet Canada
 
The Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptx
The Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptxThe Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptx
The Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptxLoriGlavin3
 
How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.Curtis Poe
 
SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024Lorenzo Miniero
 
Digital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxDigital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxLoriGlavin3
 
"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr BaganFwdays
 
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek SchlawackFwdays
 
What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024Stephanie Beckett
 
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024BookNet Canada
 

Recently uploaded (20)

Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
Tampa BSides - Chef's Tour of Microsoft Security Adoption Framework (SAF)
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024
 
Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project Setup
 
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: BNC CataList - Tech Forum 2024
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko
 
Commit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyCommit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easy
 
Connect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck PresentationConnect Wave/ connectwave Pitch Deck Presentation
Connect Wave/ connectwave Pitch Deck Presentation
 
TrustArc Webinar - How to Build Consumer Trust Through Data Privacy
TrustArc Webinar - How to Build Consumer Trust Through Data PrivacyTrustArc Webinar - How to Build Consumer Trust Through Data Privacy
TrustArc Webinar - How to Build Consumer Trust Through Data Privacy
 
Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptx
Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptxPasskey Providers and Enabling Portability: FIDO Paris Seminar.pptx
Passkey Providers and Enabling Portability: FIDO Paris Seminar.pptx
 
Use of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptx
Use of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptxUse of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptx
Use of FIDO in the Payments and Identity Landscape: FIDO Paris Seminar.pptx
 
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
 
The Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptx
The Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptxThe Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptx
The Fit for Passkeys for Employee and Consumer Sign-ins: FIDO Paris Seminar.pptx
 
How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.
 
SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024SIP trunking in Janus @ Kamailio World 2024
SIP trunking in Janus @ Kamailio World 2024
 
Digital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptxDigital Identity is Under Attack: FIDO Paris Seminar.pptx
Digital Identity is Under Attack: FIDO Paris Seminar.pptx
 
"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan
 
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
 
DMCC Future of Trade Web3 - Special Edition
DMCC Future of Trade Web3 - Special EditionDMCC Future of Trade Web3 - Special Edition
DMCC Future of Trade Web3 - Special Edition
 
What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024What's New in Teams Calling, Meetings and Devices March 2024
What's New in Teams Calling, Meetings and Devices March 2024
 
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
 

Sprinting for success - the story of an open source doc sprint

  • 1. Sprinting for successThe story of an open source doc sprint | @sarahmaddox
  • 2. Goals of doc sprint ● Create useful docs and fix bugs● Engage the Kubeflow community ○ Yes, we have docs ○ No, the docs are not perfect/complete ○ Yes, you can update the docs - here’s how
  • 3. Lightning talks People like to learn new stuff People are interested in the patterns of effective tech writing The lightning talks at the Kubeflow doc sprint: ● How to address the reader in technical documentation ● Passive resistance ● A short guide to writing well ● Kubeflow: a first impression ● Guiding users through a journey
  • 4. Results of doc sprint Stats: ● 31 pull requests (PRs) closed ● 32 issues fixed ● 6 more PRs under review ● 50 participants (out of 67 registrations) ● Participants already contributing to docs outside the sprint More: ● Gave colleagues the opportunity to show impact ● Generated buzz around Kubeflow and docs
  • 5. Results of doc sprint Kubeflow blog post: bit.ly/2H3Bw5g
  • 6. Contributors to docs repository Kubeflow Doc Sprint was July 10-12 Activity picked up from that date and has continued strong: https://github.com/kubeflow/website/graphs/contributors
  • 7. Commits to docs repository Kubeflow Doc Sprint was July 10-12 Activity picked up from that date and has continued strong: https://github.com/kubeflow/website/graphs/commit-activity
  • 8. Want to run a doc sprint yourself? Top tips: ● Start planning early ● Create and collaborate on a wish list / backlog ● Pay attention to the humdrum stuff ● Extra: Learning on the sprint ● Prizes and food How to run a doc sprint: bit.ly/2H6lt6Z