Technical writing with Continuous Integration and docs-as-code
I wanted to document the migration journey while we are in the middle of it. Last week the OpenStack Super User site did a great article about the migration, How you can help with the documentation site refresh. We talked about the reasons for it: enable more contributors, offer simpler markup, be more Pythonic. And more […]
For both OpenStack and Rackspace cloud APIs, we use WADL, Web Application Description Language, to build an API reference listing for all REST API calls. In a previous post, I discussed how the reference pages at http://developer.openstack.org/api-ref.html were made with a WADL source and a Maven plugin, clouddocs-maven-plugin. (Updated to add: in 2023, you would use OpenAPI Specification […]
I know a lot of people who want to consume awesome API docs. Let’s talk about what it takes to get started writing them. I’m not talking about completing your API docs. I’m talking about just getting started, what does it take? For API documentation especially REST APIs, I’d advocate a reference-first approach. Like the […]