Planet Open Help

The life and work of the open help community
Join our planet

October 07, 2017

Anne Gentle Anne Gentle

Author of Conversation and Community: the Social Web for Documentation. I’m a writing fiend, technical geek, community doc nut, + Content Stacker for OpenStack.

How Cisco Uses DevOps-friendly Publishing for Dev Docs

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team thinks learning and coding should be fun and exciting.

With the help of Mandy Whaley and the team, I wrote up how Cisco DevNet (developer.cisco.com) created a system called PubHub to publish developer docs. The docs are stored in enterprise Git-based storage, either Bitbucket or Enterprise GitHub. The source files can be Markdown, Swagger/OpenAPI, RAML, or even a Stripe-like source file. Read more on docslikecode.com in DevOps-friendly Docs Publishing for APIs.

by annegentle on October 07, 2017 02:48 PM

September 21, 2017

Anne Gentle Anne Gentle

Author of Conversation and Community: the Social Web for Documentation. I’m a writing fiend, technical geek, community doc nut, + Content Stacker for OpenStack.

Podcast interview talking about docs as code with Ellis Pratt of Cherryleaf

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered.

Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly without too much meandering. I think it’s difficult to determine the depth to go into for docs-as-code techniques. I can go down a deep rabbit hole while explaining webhooks, continuous integration, and bash scripts, not to mention static site generators based in either Python or Ruby. Whew! Great chat, well worth the listen. Would love to hear your thoughts.

Wow, and the last time we spoke on a podcast was in 2009 after Conversation and Community: The Social Web for Documentation was released! Thanks Ellis for another engaging chat. Updated to add: Ellis had stickers made for the Cherryleaf Podcast. Check it out.

by annegentle on September 21, 2017 02:30 AM

Subscriptions

  • Anne GentleAnne Gentle Author of Conversation and Community: the Social Web for Documentation. I’m a writing fiend, technical geek, community doc nut, + Content Stacker for OpenStack.
  • Jim CampbellJim Campbell HRIS admin to the stars, and documentation writer for needy open-source projects. As a Chicagoan, I also know enough to not put ketchup on a hot dog.
  • Lana BrindleyLana Brindley Writes too much, reads too much, talks too much, thinks too much, drinks too much. Generally superlative.
  • Shaun McCanceShaun McCance GNOME documentation team lead. Programmer. Technical writer. XML expert. Community leader. Free software enthusiast.