Details on the documentation needs for ACS 4.0. Note this plan was written during transition into Apache infrastructure, so it may still contain outdated links to, for example, Functional Specs on an older wiki.
The time available before the release is short.
The following sections describe the information products for this release.
Update for new features. The following table lists the new features and how they affect documentation.
We are committed to provide documentation for features marked P1 and P2.
P1
LOE: Large
Writer: Radhika
SME: Alena P, Anthony, Chiradeep
Affects: Install, Admin docs
FS: http://wiki.cloudstack.org/display/RelOps/Inter-VLAN+Routing+functional+spec
PM: http://wiki.cloudstack.org/display/PM/Inter-VLAN+Routing
Test Plan:
P1
LOE: Unknown
Writer: Jessica
SME: Prachi, Chiradeep
Affects: Admin docs
FS: EC2 API support in CloudStack
S3 API in CloudStack
PM:
Test Plan:
P1
LOE: minor
Writer: Radhika
SME: Vijay, Kelven, Sateesh Chodapuneedi
Affects: Install docs
FS: Cisco Nexus 1000v Support in CloudStack - Functional Specification
Test Plan:
P1
LOE: Medium
Writer: Radhika
SME: Sheng Yang, Chiradeep
Affects: Admin docs
FS: Site-to-site VPN functional spec
PM: Site-to-Site VPN
Test Plan:
P2
Assign tag to any virtual resource in cloudstack.
Writer: Jessica
LOE: Small
SME: Alena P., Chiradeep
Affects: Admin docs
FS: Tags functional spec
PM: Tags
Test Plan:
P1
LOE: Medium
Writer: Radhika
SME: Ram Ganesh, Vijay Venkatachalam, Deepak Garg
Affects: Admin Doc
FS: http://wiki.cloudstack.org/display/DesignDocs/Auto+Scale+Feature
P1
LOE: Small
Writer: Jessica T
SME: Koushik Das
FS: Local storage for data volumes
Mike Simos points out that some step-by-step procedures no longer match the current UI. Need to make a pass comparing all UI procedures in docs to current UI.
Writer: Radhika
Each new releases requires an update of the existing Installation Guide. A major rewrite is required for "build from source" installation procedure.
Each new release requires an update of the existing API Reference man pages. These are auto-generated and require only posting to the website.
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.
Move the Installation and Administration Guides from Microsoft Word to Docbook XML. DONE
Publican can output .po files which we can use to translate documentation into any desired language. DECISIONS REQUIRED:
In addition to the deliverables noted, additional activities are required during this timeframe.