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

1. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public

2. Open-Source Content Development
in OpenDaylight
Paul Zimmerman
Manager, NOSTG Developer Content

3. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
Agenda
• The Story So Far
• Moving Forward
• Challenges

4. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
What is OpenDaylight?

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. The Story So Far

7. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
In The Beginning…

8. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
More Projects…

9. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
Hydrogen Release

10. Moving Forward

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. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
Example: OpenStack
• Similar doc types
• Robust instructions
• Tooling
• Lessons learned

13. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public

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. © 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. © 2014 Cisco and/or its affiliates. All rights reserved.Presentation_ID Cisco Public
Voila!

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

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. © 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. © 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. Thank you.