Bug 110504

Summary: WAF and CMS Configuration documentation incomplete
Product: [Retired] Red Hat Enterprise CMS Reporter: Steve Etherington <steve.etherington>
Component: documentationAssignee: ccm-bugs-list
Status: CLOSED WONTFIX QA Contact: Jon Orris <jorris>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.0   
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2006-09-05 17:51:18 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Steve Etherington 2003-11-20 12:35:36 UTC
Description of problem:

Chapter 12 consists of

"WAF Configuration Details
12.1. WAF Parameters
As part of ongoing dvelopment efforts, the Red Hat Applications 
engineering team has created a new scheme for handling initialization 
parameters. The first application to be changed is the Web
Application Framework itself. Reference I, WAF Configuration 
Reference details the configuration parameters for WAF."

This tells me that there is a "new scheme" but doesn't tell me what 
it is. Or what the old one was for that matter. The "WAF 
Configuration Reference" contains a list of parameter names and 
documentation on them. But it doesn't say how to use them, eg in what 
file or files they are, how we go about setting or changing them, or 
a reference to where this is explained. 

The same problems also exist for the following chapter on CMS 
configuration details.

An example entry in the WAF Configuration reference:

"waf.lucene.location
Name
waf.lucene.location-
Description"

This tells me that the parameter waf.lucene.location exists, but 
nothing more. Many of the parameters do have a description and an 
example but even then the documentation is a bit sparse. Eg,

"waf.pagemap.workspace
Name
waf.pagemap.workspaceƂ Workspace Page
Description
Enter the relative URL for the Workspace Page
Format
[string]"

This could have said what the workspace page was, or where I could 
find out more info on it, what happens if it is not set correctly, 
etc...


Version-Release number of selected component (if applicable):
rhea-ig-waf-en(EN)-6.1-Print-RHI (2003-11-14-T14:20)

How reproducible:


Steps to Reproduce:
1.
2.
3.
  
Actual results:


Expected results:


Additional info:

Comment 1 Jon Orris 2006-09-05 17:51:18 UTC
Closing old tickets