Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Details on the documentation needs for ACS Apache CloudStack 4.1. 

Table of Contents
maxLevel3

...

The Documentation plan is derived from the 4.1 Release Page and the Apache CloudStack 4.1 QA Plan. The following table lists the new features and how they affect documentation.  We are committed to provide documentation for features marked P1 and P2This is a superset of the list in the 4.1 Release Page.

Update Docs for New Features

...

Installation Guides: Update

Each new releases release requires an update of the existing Installation Guide. A rewrite is required for "build from source" installation procedure. Looking for community contribution.Hours: Up to 32 hours

Release Notes

Each new release requires an update of existing Release Notes. New features, Known issues, and Fixed issues sections require major rewrite.

Hours: Up to 32 hours including the review cycle.

API Reference: Update

Each new release requires an update of the existing API Reference man pages. These are auto-generated and require only posting to the website.

Hours: Up to 8 hours maximum if no rewrite is planned.

Documentation Bugs

It is assumed that bugs will be filed against documentation and some will be prioritized for this release. Currently known doc bugs per release can be obtained by querying the bugbase. Triage of existing bugs is needed to determine which are required in this release. The goal is to address as many as possible of the bugs that reflect inaccuracies in the documentation. Enhancement requests can be targeted to a later release.Hours: Dedicating up to 60 hours for defect closure.This might vary based on the feature requirements.

Translation

Publican can output .po files which we can use to translate documentation into any desired language. DECISIONS REQUIRED:

...