Documentation/Checklist
Contents
Documentation checklist
Work-in-progress
When you write documentation, use this checklist to ensure quality.
| Task | Description | Complete? |
|---|---|---|
| pom.xml file | Make sure that your pom.xml file uses the latest cloud-doc plugin and is configured correctly. To find the version number of the latest plugin, go to Clouddocs Maven Plugin Release Notes. | |
| TOC | Make sure the pom.xml file configures a TOC for your book. | |
| Spellcheck | Oxygen has a spellchecker. You can spellcheck all files in a book by choosing | |
| Glossary | Embed the shared glossary and mark terms with the <glossterm> tag in your document. | |
| Doc conventions | Ensure that your content uses the recommended doc tagging. | |
| Preface | Make sure the book has a preface. | |
| Doc history | Make sure the preface includes the doc history. Also make sure that you have included a revision entry for your latest changes. | |
| Title | Is the title correct? Look below for the official titles. | |
| Code samples | Make sure code samples are in separate files. |
Official book titles
Installation guides
Audience: Cloud operators
- Basic Installation Guide for Ubuntu 12.04 (LTS) and Debian Wheezy
- Basic Installation Guide for Fedora 18
- Installation Guide for Red Hat Enterprise Linux, CentOS, and Fedora
- Installation Guide for Ubuntu 12.04 (LTS)
Administration guides
Audience: Cloud operators
- Block Storage Service Administration Guide
- Compute Administration Guide
- Networking Administration Guide
- Object Storage Administration Guide
- Operations Guide
- High Availability Guide
- Virtual Machine Image Guide
- Configuration Reference (in the works)
Application developer and user guides
Audiences:
- Developers who build applications that run in the cloud
- Users who manage resources and services in the cloud
Titles:
- API Quick Start
- Compute API Developer Guide for Shell and Python
- Clients Guide (moving into the new User Guide)
- API Complete Reference (web page)
- Block Storage Service API v2 Reference
- Compute API v2 and Extensions Reference
- Identity Service API v2.0 Reference
- Image Service API v2 Reference
- Networking API v2.0 Reference
- Image Service API v1 Reference
- Object Storage API v1 Reference
- User Guide (title might change)
- Admin User Guide (TBD)
