Bug 776 - [Chameleon-Documentation]Add maturity levels concept to user documentation
: [Chameleon-Documentation]Add maturity levels concept to user documentation
Status: RESOLVED FIXED
: Chameleon
Documentation
: 1.99
: PC Linux
: P2 normal
: 2.0 RC 1
Assigned To:
:
:
:
:
: 828
  Show dependency treegraph
 
Reported: 2004-10-26 11:35 by
Modified: 2004-12-20 12:39 (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2004-10-26 11:35:19
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.
------- Comment #1 From 2004-10-26 11:47:23 -------
Changed target to 1.99 RC 1.
------- Comment #2 From 2004-10-26 12:06:45 -------
One clarification:

The information below states the following:

"an error message will be logged stating that the widget could
not be loaded due to maturity level restrictions in place."

Actually there is no error message logged.

------- Comment #3 From 2004-10-26 12:34:46 -------
actually it does log an error message.  You can confirm this by viewing the
source of your application page, all the errors will be listed at the top in an
HTML comment.  The problem is that when you make this change, you are removing
the error widget from the page.  What you need to do to confirm this is to
change the error widget to a higher maturity so it will be included in your app.
------- Comment #4 From 2004-10-26 12:50:25 -------
I saw Chris' comment in bug 701 before.  I tested it again based on comment #3
and everything works as expected.  Thanks Paul.  So comment #2 should be ignored.
------- Comment #5 From 2004-11-08 15:40:10 -------
Darren to decide most appropriate place for this and who should do it.
------- Comment #6 From 2004-11-09 08:11:18 -------
This needs to be in the Application Developers Guide for 1.99. I'll do it. 
------- Comment #7 From 2004-12-18 11:48:15 -------
A first draft of this material was added to a version of the Application 
Developers guide a while ago. I must have forgot to update this bug. 
------- Comment #8 From 2004-12-18 11:50:52 -------
Reassigned to Jeff.
------- Comment #9 From 2004-12-20 12:39:31 -------
this is done, I remember seeing it in the docs.