[Chameleon-dev] [Bug 776] New: [Chameleon-Documentation]Add maturity levels concept to user documentation

[bugzilla-daemon at www.maptools.org]

http://www.maptools.org/bugzilla/show_bug.cgi?id=776

           Summary: [Chameleon-Documentation]Add maturity levels concept to
                    user documentation
           Product: Chameleon
           Version: 1.99
          Platform: PC
        OS/Version: Linux
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Documentation
        AssignedTo: chameleon-dev at lists.maptools.org
        ReportedBy: nsavard at dmsolutions.ca


The maturity levels information should be added to the user manual.





----------------
Maturity levels:

The intention is to add support in Chameleon for indicating the maturity level
of individual widgets.  This is to serve several purposes:

* provide a level of confidence to a chameleon administrator or application
designer that the widgets being used are reasonably stable (acceptable maturity
level on a per-installation and/or per-application basis)

* provide documentation for application developers to understand the maturity
level of widgets distributed with chameleon.

* provide assistance to widget maintainers (developers, QA and documenters) to
properly track widget status and ensure highest possible quality.

The maturity levels we have decided on are:

* UNKNOWN - the base level at which all widgets start
* ALPHA - in development, incomplete functionality, no documentation (other than
auto generated)
* BETA - in development, functionally complete, no know major bugs, no
documentation (other than auto generated)
* RELEASECANDIDATE - out of development, no know bugs, limited testing, little 
documentation (other than auto generated)
* RELEASE - out of development, no known bugs, thoroughly tested, completely
documented

The Chameleon configuration includes a maturity_level setting that can be set to
one of the above maturity levels.  It controls the lowest 'allowable' maturity
level for all widgets.  In addition, individual applications can explicitly set
a maturity level.

Maturity levels are enforced by the chameleon framework and widgets that do not
meet the configured minimum maturity level will be refused.  For example, an
application may include the SECTPopup widget (maturity level ALPHA).  If the
maturity_level is set to BETA, the widget will not be included in the
application and an error message will be logged stating that the widget could
not be loaded due to maturity level restrictions in place.

---------------

FYI - for admin purposes you can run doc_builder with ?log appended to the URL
to have it automatically output the run log to a file as well as output the
widget/maturity list.

------------------------
How could we set the maturity level in an application?


two choices:

1. change chameleon.xml maturity_level (this is global to all chameleon
applications)

2.
$oApp->CWCInitialize( $szTemplate, $szMapFile  );
$oApp->mnMinimumMaturityLevel = MATURITY_RELEASECANDIDATE;
$oApp->CWCExecute();

* <level> = UNKNOWN, ALPHA, BETA, RELEASECANDIDATE, TECHNICALRELEASE,
PRODUCTRELEASE.... case sensitive as these are 'define'd values.

as per discussion with Darren, the MATURITY_RELEASE level was divided into
MATURITY_TECHNICALRELEASE and MATURITY_PRODUCTRELEASE.

Currently, the application maturity level will be used over the default maturity
level (chameleon.xml).  This means that the application can choose to use a
lower or higher maturity level that the default.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.