OpenStack Documentation: RTFM is A Good Thing

Nick Chase - September 17, 2013 -

As programmers we often forget how important documentation is not just to each other, but especially to the people who have to use the software we create. In a massive project such as OpenStack, documentation is all that much more important, which is why there is a dedicated Documentation Team that heads up the effort to make sure that the docs are not just present and accounted for, but also useful.

In fact, the Docs team functions much like the other teams within OpenStack, even going so far as to treat the docs like code, subjecting them to the same types of code review that ensures that OpenStack is as bug-free as possible. And like other teams within OpenStack, the Docs team can always use more members to lighten the load.

To that end, this past week saw Mirantis hosting the very first OpenStack Documentation Boot Camp, designed to provide an easy way for new contributors to start working on docs, and for the old hands to get more familiar with some of the more powerful features of the documentation system.

In fact, the boot camp showed just how powerful that system can be, providing lectures on topics such as how those endless tables of REST API parameters are automatically generated, how Publican creates those beautiful PDFs, and how to use XInclude files, as well as more basic topics such as how to get started making docs patches in the first place.

More than that, the boot camp also provided an opportunity for contributors from different companies, and countries as far as Australia, to get together and meet in person, even heading down to Shoreline park to partake in some fun on the water. (Thank you, Rackspace!)

Most importantly, of course, the goal is to widen the pool of docs contributors, so for those of you who weren’t able to make it to the boot camp, we were able to videotape all of the sessions. In the coming weeks those videos will appear on Openstack.org and we’ll be making them available here on the blog, but in the meantime, we didn’t want to keep you in suspense.

banner-img
test
tst
tst
Deploy Mirantis Secure Registry on any Kubernetes (Minikube, EKS, GKE, K0S, etc.)

Note: this blog post was originally published by Avinash Desireddy on Medium. You can view the original post here. Docker Containers, Kubernetes, CNCF, and many other relevant projects completely changed how we package, ship, and run applications. As you all know, Kubernetes has become a defacto standard for running applications. At the same time, container registries and chart repositories play a …

Deploy Mirantis Secure Registry on any Kubernetes (Minikube, EKS, GKE, K0S, etc.)
Software Supply Chain Security on Any Kubernetes with Mirantis Secure Registry 3.0

Security and cloud infrastructure availability concerns have been in the news of late with the recent Log4j vulnerabilities and outages at some of the world’s largest public cloud providers. The security and integrity of your container-based images has never been more important. Many have taken to Kubernetes to assist in the deployment and management of their container-based workloads, and are leveraging …

Software Supply Chain Security on Any Kubernetes with Mirantis Secure Registry 3.0
A Year in Review: A Look Back at the Most Powerful Mirantis Resources from 2021

2021 has been quite the year - and while there have been plenty of not-so-good times, we at Mirantis would like to take a moment to focus on the good. We are thankful for the opportunity to provide our readers with informative, accurate, and, above all, educational content via our company blog. We try not only to include helpful information …

A Year in Review: A Look Back at the Most Powerful Mirantis Resources from 2021
Technical training
Learn Kubernetes & OpenStack from Deployment Experts
Prep for certification!
View schedule
LIVE WEBINAR
Getting started with Kubernetes part 2: Creating K8s objects with YAML

Thursday, December 30, 2021 at 10:00 AM PST
SAVE SEAT
LIVE WEBINAR
Manage your cloud-native container environment with Mirantis Container Cloud

Wednesday, January 5 at 10:00 am PST
SAVE SEAT