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

Open-Source Content Development in OpenDaylight

Paul Zimmerman

Manager, NOSTG Developer Content

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

Agenda

• The Story So Far

• Moving Forward

• Challenges

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

What is OpenDaylight?

© 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

The Story So Far

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

In The Beginning…

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

More Projects…

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

Hydrogen Release

Moving Forward

© 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

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

Example: OpenStack

• Similar doc types

• Robust instructions

• Tooling

• Lessons learned

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

© 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

© 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

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

Voila!

© 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

Challenges

• “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”

© 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

© 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

Thank you.