Developing Docs for OpenDaylight

1,878 views
1,775 views

Published on

A presentation made in the DevNet Zone at Cisco Live, San Francisco, 2014.

Published in: Technology, Education
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
1,878
On SlideShare
0
From Embeds
0
Number of Embeds
5
Actions
Shares
0
Downloads
16
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

Developing Docs for OpenDaylight

  1. 1. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
  2. 2. Open-Source Content Development in OpenDaylight Paul Zimmerman Manager, NOSTG Developer Content
  3. 3. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Agenda • The Story So Far • Moving Forward • Challenges
  4. 4. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public What is OpenDaylight?
  5. 5. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Open Source vs. Corporate • Brand Representation • Quality Standards • Buy-in • Audience • Resources
  6. 6. The Story So Far
  7. 7. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public In The Beginning…
  8. 8. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public More Projects…
  9. 9. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Hydrogen Release
  10. 10. Moving Forward
  11. 11. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public “Professional” Doc Set • Three main types: – Structured product documentation (installation, user guides) – Auto-generated documentation (API references) – Project documentation (specs, plans) • Consistency • Consolidated topics • Better Search • Higher expectations
  12. 12. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Example: OpenStack • Similar doc types • Robust instructions • Tooling • Lessons learned
  13. 13. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
  14. 14. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Tooling Structure Topic Topic Topic Topic Topic Maven BitBucket Repository OpenDaylight Site Develop Review Revise
  15. 15. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Authoring • AsciiDoc mark-up language • Easy markup for developers • Easy to adapt from MediaWiki • Checked in and out like code
  16. 16. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Voila!
  17. 17. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Next Steps • Finalize tooling • Create similar look & feel for autogenerated content • Clean up wiki • Develop community
  18. 18. Challenges
  19. 19. • “Your Life as a Developer” Survey 2013 JFrog Artifactory “65% of developers from over 150 Fortune 500 companies cited documentation as one of the biggest challenges of open-source software”
  20. 20. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Documentation Struggles Open Source • Focus on software • Team effort on docs OpenDaylight • Planning for future distributions • Catch-up • Resources
  21. 21. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public Questions? For additional Q&A, please meet me in the DevNet API Expert Zone
  22. 22. Thank you.

×