What's this?

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.

Purpose

• Update documentation for new features.
• Update documentation for UI changes.
• Respond to change request and bug tickets.

Assumptions and Risks

The time available before the release is short.

Deliverables and Outlines

The following sections describe the information products for this release.

Update Docs for New Features

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.

Inter-VLAN Routing

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:

AWS API enhancements: EC2, S3

P1

LOE: Unknown
Writer: Jessica
SME: Prachi, Chiradeep
Affects: Admin docs
FS: EC2 API support in CloudStack
S3 API in CloudStack
PM:
Test Plan:

Nexus vSwitch update release

P1

LOE: minor
Writer: Radhika
SME: Vijay, Kelven, Sateesh Chodapuneedi
Affects: Install docs
FS: Cisco Nexus 1000v Support in CloudStack - Functional Specification
Test Plan:

Site-to-Site VPN

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:

Tags

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:

NetScaler auto-scaling : ADDED to this release

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

Local Storage Support for Data Volumes : ADDED in July

P1

LOE: Small

Writer: Jessica T

SME: Koushik Das

FS: Local storage for data volumes

Update for UI Changes

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

Installation Guides: Update

Each new releases requires an update of the existing Installation Guide. A major rewrite is required for "build from source" installation procedure.

Release Notes

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.

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.

Source Files in XML

Move the Installation and Administration Guides from Microsoft Word to Docbook XML. DONE

Translation

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

• Which languages to translate?
• Use Transifex?
• Use community volunteers? We already have one volunteer for Chinese translation.

Additional Doc Activities

In addition to the deliverables noted, additional activities are required during this timeframe.

• Set up documentation repos and other activities related to Apache project incubation
• Set up tools to build and publish documentation sets on a new doc website
• Community outreach activities: presentations at professional gatherings, presence on mailing lists, etc.