You need to log in before you can comment on or make changes to this bug.
The first draft of the "CWC2 Service Instance" has been checked into CVS. The source is in docs/xml/ServiceInstance.xml and the HTML version is in docs/html/ServiceInstance.html. Please read through it and make any changes/deletions/additions you feel are necessary. You can either change the *source* yourself (DO NOT CHANGE THE HTML), or make a comment in this bug about what you feel needs changing. Everyone is welcome to comment, but I need at least the following people to review the document: * Paul Spencer * Chris Thorne * Jeff McKenna * Jason Fournier Paul, if you feel that there's anyone else you definitely want to review this document, please contact them. Bug #829 is the tracking bug for this document and lists the preceding and following steps to this bug.
Set target to 1.99 RC 1.
What is the CWC Service Instance: do we need to say that it does this without requiring you to install CWC2 and Chameleon locally? (described in Basic Concepts in Users Guide ... perhaps provide a link to that section or doc from here?) Configuration File Changes: second para, second last sentence, cwc2.xml is not in the same font as chameleon.xml Installing the CWC2 Service Instance: it says the configuration is described in the Installation Guide. This relates to Darren's second question in the bug for reviewing that. Either the Aliases need to be described there (in which case this is fine) or described in this section. System Configuration: um, this is the answer to the above question I guess :) Service Instance Configuration: this could refer to the chameleon admin tool since it is possible (and preferred) to edit the configuration file through that tool. Probably it should tell the user to use the admin tool to edit the file by clicking on the CWC2 Configuration link. The table of values is fine but could be replaced with a graphic of the admin tool ... We should also state that use of the admin tool is described in the admin guide. Testing the Service Instance: last example URL has quotes embedded around "request=GetApplication" and is missing the & ... url should be: http://{myserver}/cwc2/cwc2.php?service=VCG&version=0.1.0&request=GetApplication User's Guide Should this be a separate doc? Setup and Installation could be placed in the InstallationGuide? Basic Concepts: "specially built URL" - is there a better word than built? Constructed? Crafted? Service Exceptions: there is an example in the testing part above :) Common Invocation Parameters: my first thought is what do I set these to? This is described below but I think we need to state that in the first sentence. Something like "Valid values for these parameters depend on how the service instance is being invoked, and are described in the Supported REQUESTs section below"
Made changes/additions based on Comment #2. New XML and HTML version committed to CVS. > Installing the CWC2 Service Instance: > > it says the configuration is described in the Installation Guide. This > relates > to Darren's second question in the bug for reviewing that. Either the Aliases > need to be described there (in which case this is fine) or described in this > section. I decided to put the configuration details together with the other ones in the Installation Guide. > User's Guide > > Should this be a separate doc? Setup and Installation could be placed in the > InstallationGuide? At this time, I'd like to keep the bulk of the Service Instance material together in one document. For 2.0, this may very well change, depending on the suite of documents being produced.
Cleared whiteboard
done.
