What's this?

Below is a starting point. This needs to be modified for Apache CloudStack 4.0.

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 as of mid July

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

VM Tiers : REMOVED

LOE: Small
Writer: Jessica
SME: Alena P, Anthony, Chiradeep
Affects: Admin docs
FS: VM Tiers functional spec
PM: VM Tiers
Test Plan:

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 Burbank UI.

Writer: Radhika

Installation Guides: Update

Each new releases requires an update of the existing Installation Guide. A full rewrite should not be required, but some update is planned both for Doc Bugs and for the New Features table at the end of this plan.

Release Notes

Includes updated Upgrade steps, New Feature summaries, fixed and known issues, API change summary

API Reference: Update

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

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 Bugzilla. 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.

38 bugs are currently triaged as a definite "go" and further triage is needed to finalize this plan.

Source Files in XML

Move the Installation and Administration Guides from Microsoft Word to Docbook XML. WORK IN PROGRESS

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 Team Activities

In addition to the deliverables noted, the documentation team is engaged in addtional activities during this timeframe. These are not included in the Timeline section below, since they are not directly related to the release.

• Set up documentation repos and other activities related to Apache project incubation
• Write requirements for automation tools to build and publish documentation sets, then work with engineers to implement. See Functional Requirements for Documentation Publishing Tool
• Community outreach activities: presentations at professional gatherings, presence on mailing lists, etc.
• Create video tutorials: joint project with summer intern
• Prepare the slides for a presentation on Apache CloudStack Documentation to be presented to the STC and other audiences
• Prepare an article on moving to an Open-Source model (include preparatory steps etc.) for publication in STC proceedings and other channels. We can cover details on Apache Process.

Timeline

July 8 - 14

• Review Draft: Site to site VPN. READY

July 15 - 21

• Preliminary Review Draft (code not complete, base on FS only): Inter VLAN Routing DONE
• Comments due on: Site to site VPN. RECEIVED 8/22
• Auto scaling user interface ready by 8/1 (previously planned 7/20) Jessica Wang implementing

July 22 - 28

• Review Draft: vSwitch NO EFFECT ON DOCS, NetScaler auto-scaling DONE

July 29 - Aug 4

• 2nd Review Draft: Inter VLAN Routing DONE
• Review Draft: AWS API (early in week) NOW PART OF TAGS
• Information needed by early in this week: Upgrade Procedure RECEIVED 8/16
• Comments due on: Inter VLAN Routing (end of week) RECEIVED 8/15

Aug 5 - 11

• 1st Draft (end of week): Release Notes DONE 8/20

Aug 12 - 18

• Continue incorporating review comments on drafts
• Review Draft: Tags (was due July 15). UI is now ready as of 7/26. Includes AWS API changes for tags (these are the only AWS API changes for Burbank). DONE 8/22

Aug 19 - 25

• Review Draft: Release Notes (end of week)
• Review Draft: Data disk on local storage (Koushik) NEW FEATURE ADDED
• Release candidate, (that means no p1 p0 bugs), due by august ??
• Doc bug fix

Aug 26 - Sept 1

• Final Draft: Release Notes

Sept 2 - 8

• GA Sept 5