What's this?

Details on the documentation needs for ACS 4.1. 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.

Documentation Deliverables and Outlines

Update Docs for New Features

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.

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.

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 related to Apache project incubation for non-committers
• 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.