December 6-8, 2017 - Austin, Texas
Click Here for More Information + Registration 

Customize your schedule by session topic and skill level:
Session Topic - Refer to the "Type" filter list to the right to find a session based on topic. Talk Difficulty - Sessions are categorized as [B]eginner, [I]ntermediate or [A]dvanced at the end of each talk title. No letter indicates an “Any” level. 
View analytic
Wednesday, December 6 • 11:55am - 12:30pm
DevOps Friendly Doc Publishing for APIs & Microservices - Amanda Whaley, Cisco DevNet

Sign up or log in to save this to your schedule and see who's attending!

Microservices create an explosion of internal and external APIs. These APIs need great docs. Many organizations end up with a jungle of wiki pages, swagger docs and API consoles. Keeping docs updated and in sync with code can be a challenge. We’ve been working on a project to help solve this problem for engineering teams internally across Cisco. The goal is to create a forward looking developer and API doc publishing pipeline that:

- Has a developer friendly editing flow
- Accepts many API spec formats (Swagger, RAML, etc)
- Supports long form documentation in markdown
- Is CI/CD pipeline friendly so that code and docs stay in sync
- Is flexible enough to be used by a wide scope of teams and technologies

This session will share many lessons learned about tooling and attendees will learn how to solve documentation challenges for internal and external facing APIs. We have found that solving this doc publishing flow is a key component of a building modern infrastructure.

avatar for Amanda Whaley

Amanda Whaley

Director of Developer Experience at Cisco DevNet, Cisco DevNet
Amanda Whaley is Director of Developer Experience & Developer Evangelism for Cisco DevNet. She spends most of her time thinking about how developers use Cisco APIs, and about how to make their job easier. She also leads a team of developer evangelists who work with Cisco partners... Read More →

Wednesday December 6, 2017 11:55am - 12:30pm
Meeting Room 8ABC, Level 3
  • Difficulty Level Any

Attendees (184)