What's this?

Details on the documentation needs for ACS 4.1. 

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. The list of features to be included in the release is in flux, making it difficult to plan which features to write about first.

Documentation Deliverables and Outlines

The Documentation plan is derived from 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 P2.

Update Docs for New Features

Installation Guides: Update

Each new releases 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:

• 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 time frame.

• Community outreach activities: presentations at professional gatherings, presence on mailing lists and social media, organizing CloudStack meetups etc.

Timeline

Feb 4-11

Persistent Network

Status: Shared for review (Sailaja and Likitha)

Doc impact: Admin Guide, Developer Guide, and Release Notes

Feb 11-15

Persistent Network

Status: Patch submitted (Admin Guide, Dev Guide)

AWS-Style Regions

Status: Research state

Doc impact: Admin Guide, Developer Guide, and Release Notes

Event Notification Framework

Status: First draft of conceptual info ready

Developer Guide

Status: Patch is submitted ( initial set of API changes included)

Feb 18-22

Event Notification Framework: Tech review done. Incorporating comments. Awaiting info on configuration part.

CLOUDSTACK-1313: Patch submitted. Need to merge on Master and 4.0 (https://reviews.apache.org/r/9492/)

CLOUDSTACK-991: Patch merged (https://reviews.apache.org/r/9490/)

Resize Volume: Patch submitted. Ready to review (https://reviews.apache.org/r/9520/)

S2S VPN: Patch submitted. Need to merge (https://reviews.apache.org/r/9514/)

Feb 25- March 1

Event Notification Framework: Second round of reviews after adding the configuration info

Resubmitted the patch https://reviews.apache.org/r/8636/