This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 219156 - Write COSMOS Installation Guide
Summary: Write COSMOS Installation Guide
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Cosmos (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Pam Kusnirik CLA
QA Contact: Ruth Lee CLA
URL: http://wiki.eclipse.org/COSMOS_Instal...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-02-15 14:54 EST by Richard Vasconi CLA
Modified: 2012-01-03 13:47 EST (History)
11 users (show)

See Also:


Attachments
COSMOS Installation PowerPoint presentation (107.50 KB, application/vnd.ms-powerpoint)
2008-06-10 14:42 EDT, Richard Vasconi CLA
no flags Details
COSMOS installation Guide (61.50 KB, application/octet-stream)
2008-06-19 06:26 EDT, Paul Stratton CLA
no flags Details
COSMOS 1.0 Install Guide (21.47 KB, application/octet-stream)
2008-10-15 16:56 EDT, Jimmy Mohsin CLA
no flags Details
Report showing the broken links in Jimmy's attachment (10.20 KB, text/html)
2008-10-16 11:36 EDT, Ruth Lee CLA
no flags Details
Report showing the broken links in Jimmy's attachment (10.20 KB, text/html)
2008-10-16 11:38 EDT, Ruth Lee CLA
no flags Details
Report showing the broken links in Jimmy's attachment (10.20 KB, text/html)
2008-10-16 11:55 EDT, Ruth Lee CLA
no flags Details
Report showing the spelling mistakes in Jimmy's attachment (21.04 KB, text/html)
2008-10-16 11:56 EDT, Ruth Lee CLA
no flags Details
Installation Guide (22.98 KB, application/x-zip-compressed)
2008-10-31 13:26 EDT, Pam Kusnirik CLA
dlwhiteman: iplog+
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Richard Vasconi CLA 2008-02-15 14:54:16 EST
Write the COSMOS Installation Guide.
Complete outline by 02/28/08.
Complete content by 03/27/08.
Comment 1 Richard Vasconi CLA 2008-02-21 09:11:43 EST
Reassigned bug to Jimmy Mohsin. 
Comment 2 Jimmy Mohsin CLA 2008-05-28 17:56:00 EDT
This ER will be completed once the SDD work is complete for COSMOS 1.0.
Comment 3 Jimmy Mohsin CLA 2008-05-29 16:44:37 EDT
Added Jason Losh as a cc, since this ER depends on the SDD work.
Comment 4 David Whiteman CLA 2008-06-02 14:31:16 EDT
Can parts of this be written in advance of the SDD work being available?  For instance, I would think that installing and unzipping the files off the downloads page would still be an alternative to installing via SDD.  We also need to talk about installing via the update manager, which is outside the scope of SDD; of course that prereqs a different defect (bug 215610).

In the dev. guide, I'm working on a section where we want to reference the Install Guide, but it doesn't exist yet.  Will it only be available online?  Is it reasonable to refer to an online document from our HTML/PDF documentation?
Comment 5 Richard Vasconi CLA 2008-06-06 15:37:23 EDT
The i11 Installation Guide needs to be written as we do install COSMOS today, not using SDD. The Installation Guide can be updated for each iteration.

As for referencing the Installation Guide from the Development Guide,say: 

For information on how to install COSMOS, see the "COSMOS Installation Guide" at the COSMOS Documentation Web site http://www.eclipse.org/cosmos/home/documents/ under the Documentation for users section.  

This is where I will add the link the Installation Guide.  
Comment 6 Jimmy Mohsin CLA 2008-06-10 11:56:45 EDT
Assigned to Paul per our email today.
Comment 7 David Whiteman CLA 2008-06-10 12:22:38 EDT
Note that a start of this guide can come from here (at least the demo part):

http://wiki.eclipse.org/COSMOS_DEMO_i11
Comment 8 Richard Vasconi CLA 2008-06-10 14:42:26 EDT
Created attachment 104366 [details]
COSMOS Installation PowerPoint presentation  

This attachment will be useful in creating the COSMOS Installing Guide. The attachment is from Mark Mccraw in SAS.
Comment 9 Richard Vasconi CLA 2008-06-10 14:46:57 EDT
Paul, 
The following text is from an email I received from Mark Mccraw describing the COSMOS Installtion Instructions presentation. I had asked him if there was an update to his presentation. This is his response. 

Hey Richard,
 
I am afraid the installation presentation you attached to your last email was the final draft, and you are welcome to use any material at all out of it that might be of use.  As you know if you listened to the presentation, I'm not the best public speaker, so I had a lot of notes in the presentation to use as a crutch, and you might find as much information in the notes portion of each slide as in the slide itself (I kind of captured loosely what I hoped to say in conjunction with each slide in the notes section).
 
In particular, the notes for slide 11 might help with the i11 COSMOS demo installation process, but they're a little jumbled, so below is a (hopefully) slightly better and more readable list of steps for installation.  Note that this is just a condensed version of the document that exists already at http://wiki.eclipse.org/COSMOS_DEMO_i11.  Also, note that this only installs the "server" portions of COSMOS.  There's a lot of "client" stuff in the form of eclipse plugins, but installation of those are all the same:  Download the zips and extract them under eclipse-home/plugins. 
 
1)  Create a folder on your hard drive to hold the downloads you are going to need.  Let's call it C:\cosmos and let's assume that Tomcat is installed at C:\Program Files\Tomcat
2)  Install Tomcat if you haven't already 
            http://www.apache.org/dist/tomcat/tomcat-5/v5.5.25/bin/apache-tomcat-5.5.25.exe
3)  Download the following files into C:\cosmos:
                http://download.eclipse.org/birt/downloads/drops/M-R1-2.3M6-200804080800/birt-runtime-2.3M6.zip
            http://download.dojotoolkit.org/release-1.0.2/dojo-release-1.0.2.zip
            http://www.reverse.net/pub/apache/ws/axis2/1_3/axis2-1.3-war.zip
            
 4)  Download the demo from whatever mirror works best for you:
http://www.eclipse.org/downloads/download.php?file=/technology/cosmos/1.0.0/COSMOS-1.0.0-200806041150/cosmos-demo-incubation-COSMOS-1.0.0-200806041150.zip
(Note:  This link reflects the latest build at the time I'm writing this, but it changes often, so check http://www.eclipse.org/downloads for the latest version at any given time)
5)  Unzip the demo into C:\cosmos.  This will create a folder named cosmos-demo
6)  cd to C:\cosmos\cosmos-demo\bin 
 7)  Run configDemo.bat "C:\Program Files\Tomcat" "C:\cosmos\cosmos-demo" "C:\cosmos\birt-runtime-2.3M6.zip" "C:\cosmos\dojo-release-1.0.2.zip" "C:\cosmos\axis2.war" 
8)  Start tomcat:  C:\Program Files\Tomcat\bin\startup.bat
9)  Register data managers:
                cd C:\cosmos\cosmos-demo\cosmos-client
                execute cosmosClient.bat
                type in "broker registerAllDataManagers"
10)  You're done!  Point a browser at http://localhost:8080/COSMOSUI/?page=cosmos
 
 
 
 
Hope this helps.  Let me know if I can provide any more information for you.
 
Mark
Comment 10 David Whiteman CLA 2008-06-10 21:20:41 EDT
Hopefully there wasn't duplicate effort going on... please consult bug 235636 for more installation info.
Comment 11 Paul Stratton CLA 2008-06-19 06:26:13 EDT
Created attachment 105392 [details]
COSMOS installation Guide

First pass at installation guide
Comment 12 David Whiteman CLA 2008-06-19 07:12:10 EDT
Thanks, Paul!

I don't have much time to review thoroughly as I'm on vacation and trying to watch the kids, but here are a couple of quick comments:

* the list of tasks described by the document at the beginning should use consistent word forms.  For example, if most of the words are "*ing", then 1,2,6,7 should also use that form.  Like "planning", "checking", "downloading", etc...

* The chapter headings should match the wording in your list exactly.  E.g. you have "Plan the..." in the list, but "Planning..." in the chapter 2 heading.

* chapter 6, "COSMOS Builds": for consistency with the rest of the docs, should use the U.S. spelling of "utilize"

* Note to Rich: please contact Ali and Saurabh about the build categories, because they are likely to change.  In particular, the last two in that list are probably no longer going to be separate downloads

* Chapter 8, should use "you" instead of "the user" in documentation.  E.g. "To install COSMOS, you need to...".  Note that the list of prereqs will change to remove the RC4 designation when the final versions become available.

* Chapter 9, again write to the user, not about him/her.  I know you copied this from what Saurabh wrote, but the sentences could be a bit less terse.

* Last sentence of chapter 9 worded poorly.

* You have two chapter 9s.
Comment 13 Hubert Leung CLA 2008-06-20 11:14:31 EDT
I see some overlap of information of this document with the rest of the documentation.  The installation of the demo is covered by the "Running the example" chapter of the user's guide.  

Saurabh also has a set of instructions for installing the SDK on http://wiki.eclipse.org/COSMOS_DEMO_i11#Installing_COSMOS_SDK.
(I think the demo page is not the right place for installation instructions for the SDK because the SDK is not part of the end-to-end scenario.)

Another place where we have dependency/installation information is the download page.  

We need to define the scope of the install guide, and make sure information is not duplicated elsewhere.  
Comment 14 David Whiteman CLA 2008-06-20 11:33:42 EDT
(In reply to comment #13)
> I see some overlap of information of this document with the rest of the
> documentation.  The installation of the demo is covered by the "Running the
> example" chapter of the user's guide.

I agree we should not have overlap.  I suggest that the installation of the demo should be removed from the "Running the example" section of the UG, and that section should point to the install guide.
 
> Saurabh also has a set of instructions for installing the SDK on
> http://wiki.eclipse.org/COSMOS_DEMO_i11#Installing_COSMOS_SDK.
> (I think the demo page is not the right place for installation instructions for
> the SDK because the SDK is not part of the end-to-end scenario.)

Yes, I made that comment to him before he wrote it that the SDK and SML installation should be on a separate wiki page from the demo setup.

> Another place where we have dependency/installation information is the download
> page.  
> 
> We need to define the scope of the install guide, and make sure information is
> not duplicated elsewhere.  

Agreed.  The download page too should point the user to the install guide, so we have a single source for information. 

Comment 15 Ruth Lee CLA 2008-08-06 11:01:16 EDT
Moving all open bugzillas that are targeted to iterations in the past to the next iteration (i13).
Comment 16 Jimmy Mohsin CLA 2008-10-15 16:56:33 EDT
Created attachment 115195 [details]
COSMOS 1.0 Install Guide

Please review this version of the Install guide and provide your feedback.
Comment 17 David Whiteman CLA 2008-10-15 17:52:20 EDT
Jimmy, I fixed the mime type of your attachment and also turned off the "patch" flag, as that was making it download incorrectly.  This is not a patch, because that implies that you selected the files in Eclipse and exported the changes using "create patch" from the CVS menu; this creates a text-based diff format.  You instead attached a zip file that completely replaces the current install guide contents.  I also marked Paul's previous version as obsoleted by this one.

Which file do I start with if I want to view the entire install guide?  I was looking for an index.html.

Overview
========
In the Overview, the text "provides information to assist adopters to perform the following tasks:" makes me think the tasks will be phrased as gerunds.  The numbered items should begin with terms like "Downloading...", "Installing...", etc., since they are named as tasks, and "Overview of COSMOS components" is not really a task.  I would also change "to perform" to "in performing".

Starting COSMOS Components
==========================
In "Starting COSMOS Components", the following only applies if your web server happens to be Tomcat.  We can't assume that other web servers like JBOSS will have a "...\bin\startup.bat".  Therefore, we should leave the following out:

"Start the web server by running:

<web-server-dir>/bin/startup.bat"

COSMOS Demo Setup
=================
The numbering is off in this page, as there are two #1 items.  The first #1 <li> needs to be part of the same <ol> as the rest of them

The comments "(download from step 4 above)" and "(downloaded from step 3 above)" make no sense in context since this section has no step 3 or 4, or does it have download steps.

Hubert, do we still pass in the location of the axis2 war jar?

COSMOS Demo Web User Interface
==============================
I'm surprised we have this as part of the install guide, unless it's just a verification step.  Most of this info should be in the UG or DG, I would think.  At a minimum, we likely have information duplication that will cause maintenance problems.

In the list under Data Managers View, it lists the Statistical Data Manager and Logging Data Manager.  Weren't those recently removed due to IP concerns?

In the places where we say "COSMOS UI supports/provides" or something similar, it would probably be best to include the word "The" in front.

cosmosinstall.summary.html
==========================
There is a lot of garbage text referencing .dita files and type information when you view it in a browser.  It seems this file is no longer used.  If it is not, I would suggest removing the file from the zip.

cosmosinstall.toc.html
======================
This appears to be the "front page" I was looking for before.  The "Version i12" needs to change to "Version 1.0".

Overview of COSMOS Components
=============================
We should probably mention MDRs as a specialization of Data Manager here, since those who are coming to this looking for CMDBf support will likely be confused by the Broker / Data Manager talk, or at least will wonder where the MDRs are.

The title of the page doesn't match the heading.

COSMOS Prerequisites
====================
Hubert, do we still recommend people download Axis2 from their web site?  That's what the prereqs list tells them to do.

Downloading COSMOS
==================
"See the COSMOS User Guide for more information about MDR."  Change "MDR" to "MDRs".

Installing and running the COSMOS Demo and Prerequisites
========================================================
The links for BIRT and Axis2 are redundant with the links in the prerequisites page.  We should link people to the prereqs page so that we only have to maintain one set of external links for BIRT and Axis2.

Installing the COSMOS SDK
=========================
We again have some redundant information here.  The bulleted list provided is basically the same as found in the COSMOS Prerequisites section.

For the final sentence, please refer them specifically to chapter 2 of the Developer Guide, since I don't know if we use the term "COSMOS SDK" there.  Even if we do, it's good to point directly to that chapter.

Installing Resource Modeling Tooling
====================================
In this section and the SDK section, shouldn't we also point out the update installer as an alternative means of installing?

Need a space before the 2nd sentence in this section.

Both occurrences of "SMLIF" should be "SML-IF".

In "To install resource modeling tooling" we need to capitalize the R and M.

"Eclipse SDK 3.4RC4" should be "Eclipse SDK 3.4".

Remove the sentence: "Note: An alternative to restarting the workbench is to select File > Switch Workspace and click OK to select the current workspace. This operation causes Eclipse to reload all features and plug-ins."  Instead add the following sentence: "To do this, select File > Restart from the workbench menu."

I'm not sure of the purpose of Manual Installation.  It seems basically the same as automatic, except that you unzip it to the hard drive before copying it over.  Again, I think we want to instead contrast unzipping the download with using the update installer.

"Modelling" should be "Modeling".

Uninstall COSMOS
================
From the TOC, I clicked on "Uninstall COSMOS" and got a page not found.  I think there is a typo in the URL.  Also we should call it "Uninstalling", not "Uninstall" for consistent word usage.



Comment 18 Ruth Lee CLA 2008-10-16 11:22:43 EDT
1. If we have broken links in the TOC, then we need to run some basic verification on the docs such as a broken links checker, spell checker, etc. 
   1.1 If the docs are to be shipped in a plug-in, then we can use the doc verification tool that TPTP wrote to verify our docs. It looks for broken links, orphaned files (i.e., files not referred to by the TOC, which means that their information is not searchable), and I forget what else. This is a basic quality step that we will need to do. 
   1.2 If the docs are to be web based alone, then let's run a quick check on any of the basics using any tool at all. 

2. We need to be careful about the 3rd party code that we list or refer to. We can refer to only the items for which we have a fully approved CQ. For Axis2, for example, we do not have permission to use Axis2 in its entirety; instead, we can refer to the specific versions of the specific JARs that we have permission for. I understand that makes our documentation more clunky but that's all that we have legal clearance for.

3. The "in research" portions of COSMOS have CQs that are not cleared and we might need to move those portions to another guide just for "in research" components. I think that we need to check with Legal on that. 

Comment 19 Ruth Lee CLA 2008-10-16 11:36:23 EDT
Created attachment 115261 [details]
Report showing the broken links in Jimmy's attachment
Comment 20 Ruth Lee CLA 2008-10-16 11:38:21 EDT
Created attachment 115262 [details]
Report showing the broken links in Jimmy's attachment
Comment 21 Ruth Lee CLA 2008-10-16 11:55:13 EDT
Created attachment 115267 [details]
Report showing the broken links in Jimmy's attachment
Comment 22 Ruth Lee CLA 2008-10-16 11:56:28 EDT
Created attachment 115268 [details]
Report showing the spelling mistakes in Jimmy's attachment

Attachments 115261, 115262, and 115267 are identical, so I'm marking two of them obsolete.
Comment 23 David Whiteman CLA 2008-10-16 12:11:41 EDT
For Axis2 installation, we need to specify only the libraries we are approved to prereq.  We can't just point people to the Axis2 web site.  We have to indicate the specific subset of Axis2 that we can legally prereq.  That list can be found here under Pre-req dependencies: http://www.eclipse.org/cosmos/legal/iplog_COSMOS1.0.php
Comment 24 Pam Kusnirik CLA 2008-10-16 16:16:52 EDT
(In reply to comment #22)
> Created an attachment (id=115268) [details]
> Report showing the spelling mistakes in Jimmy's attachment
> Attachments 115261, 115262, and 115267 are identical, so I'm marking two of
> them obsolete. 

Removed unnecessary anchors; corrected two misspellings, as the others listed in the report are correct as-is.
Comment 25 David Whiteman CLA 2008-10-16 17:03:21 EDT
Pam sent me a reply via email.  I will paste the message here along with my replies.

"Kusnirik, Pamela" wrote on 10/16/2008 01:28:11 PM:

> Hi David,
> Thanks for your edits. I’ve incorporated most of them but have a few questions:
> COSMOS Demo Web User Interface
> ==============================
> I'm surprised we have this as part of the install guide, unless it's just a
> verification step.  Most of this info should be in the UG or DG, I would think.
>  At a minimum, we likely have information duplication that will cause
> maintenance problems.
> If everyone agrees this should be moved, please give a more specific indication of 
> exactly where in either the UG or DG that this should go.

I wasn't suggesting moving anything.  I was just assuming (without looking, mind you) that much of this information was already described in those documents, and that we can just refer them elsewhere for more detail like we already do at the bottom of that section.  In general, it is good for us to have a single copy of anything, given that when things change, it's easy to forget (and time consuming) to update all places where the information exists.  But I realize there's a usability tradeoff in making people hop around between different documents.

> In the list under Data Managers View, it lists the Statistical Data Manager and
> Logging Data Manager.  Weren't those recently removed due to IP concerns?
> Remove?

OK, I did some fact checking on this (yes, too much watching debate analysis).  The statistical data manager is likely still in.  Sheldon or Hubert can probably confirm.  The logging data manager includes CBE, which had to be (or will be) removed from the build; Ruth is checking to see if we can reference the CBE plugin itself instead.  I don't know what I'm talking about, so I'll stop there.  I trust someone else will let you know if the logging data manager instructions have to be removed.

> Overview of COSMOS Components
> =============================
> We should probably mention MDRs as a specialization of Data Manager here, since
> those who are coming to this looking for CMDBf support will likely be confused
> by the Broker / Data Manager talk, or at least will wonder where the MDRs are.
> I found this online – can you please add/change anything if it’s not appropriate:
> One classification of a Data Manager is a Management Data Repository (MDR). An MDR 
> provides data about managed 364 resources (for example, computer systems, 
> application software, and buildings) and/or 365 process artifacts (for example, 
> incident records and request for change forms), and the 366 relationships between them.

That sounds good as long as you remove the numbers. :-)

> COSMOS Prerequisites
> ====================
> Hubert, do we still recommend people download Axis2 from their web site? 
> That's what the prereqs list tells them to do.
> Need feedback.

Where did you get the prereqs list from?  If it's based on the old copy of the install guide that Paul wrote, it's out of date.  We learned that we don't have legal approval to prereq all of Axis2, just parts of it.  So what we need to do is provide the list of legally approved Axis2 libraries that they will need to download to use COSMOS.  That's the list I was referring to in Comment #23 of this defect.

> Installing and running the COSMOS Demo and Prerequisites
> ========================================================
> The links for BIRT and Axis2 are redundant with the links in the prerequisites
> page.  We should link people to the prereqs page so that we only have to
> maintain one set of external links for BIRT and Axis2.
> o       Agreed; note that the link on the Prereq page for Axis 2 was different than
> what was on this page. I used the more specific link for the Prereq page: 
> http://ws.apache.org/axis2/download/1_3/download.cgi
> (Select and download the zip file for WAR (Web Archive) Distribution.)
> o       On the Prereqs page, should this be “Business Intelligence and Reporting 
> Tools - BIRT 2.3.1”?
> Business Intelligence and Reporting Tools - BIRT 2.3    http://www.eclipse.org/birt/phoenix/

I'm not sure which is correct.  Hopefully someone from the DV team or QA can clarify this.

> Installing the COSMOS SDK
> =========================
> We again have some redundant information here.  The bulleted list provided is
> basically the same as found in the COSMOS Prerequisites section.
> Yes, but since this is for the SDK specifically, isn’t it better to have both?

It's again the same tradeoff of having to maintain multiple sources vs. user convenience.  If the list is basically the same, could we instead instruct the user to install all prereqs and link them to that section?  And then we just include any unique steps not covered by installing the prereqs.

> Installing Resource Modeling Tooling
> ====================================
> In this section and the SDK section, shouldn't we also point out the update
> installer as an alternative means of installing?
> (and)
> I'm not sure of the purpose of Manual Installation.  It seems basically the
> same as automatic, except that you unzip it to the hard drive before copying it
> over.  Again, I think we want to instead contrast unzipping the download with
> using the update installer.
> Need some clarification on this.

As far as I'm concerned we can remove the Manual Installation section and offer one way of installing. Since time is short, you probably don't want to spend time learning how the update installer works.  I don't have time now to write up a draft of that; maybe Srinivas or Jimmy want to step through writing something about installing RM tooling using these instructions, assuming the update site is still current: http://wiki.eclipse.org/COSMOS_1.0.0_update_site_installation

Srinivas, if it's not already part of your testing, we might want to add a step to iteration testing to ensure the update site is functional and that you can install COSMOS components correctly using that approach.
Comment 26 Pam Kusnirik CLA 2008-10-16 20:40:12 EDT
> > Installing the COSMOS SDK
> > =========================
> > We again have some redundant information here.  The bulleted list provided is
> > basically the same as found in the COSMOS Prerequisites section.
> > Yes, but since this is for the SDK specifically, isn’t it better to have both?
> It's again the same tradeoff of having to maintain multiple sources vs. user
> convenience.  If the list is basically the same, could we instead instruct the
> user to install all prereqs and link them to that section?  And then we just
> include any unique steps not covered by installing the prereqs.


I totally agree with redundant information being a negative thing. But in this case, here's my dilemma, if you will. The Prereqs for COSMOS list two downloads the SDK doesn't need: Java5 and BIRT. So if I refer users to the COSMOS Prereqs page from the SDK page, do I tell them something like "Install every download listed on the Prereqs page, with the exception of Java5 and BIRT." Then I'd also have to tell them to download the COSMOS SDK. I'm torn if that makes more sense, or if not having every download identified in a bulleted list would be annoying to the user. I also think I'm contemplating this too much. Any thoughts?
Comment 27 David Whiteman CLA 2008-10-16 21:11:10 EDT
(In reply to comment #26)
> I totally agree with redundant information being a negative thing. But in this
> case, here's my dilemma, if you will. The Prereqs for COSMOS list two downloads
> the SDK doesn't need: Java5 and BIRT. So if I refer users to the COSMOS Prereqs
> page from the SDK page, do I tell them something like "Install every download
> listed on the Prereqs page, with the exception of Java5 and BIRT." Then I'd
> also have to tell them to download the COSMOS SDK. I'm torn if that makes more
> sense, or if not having every download identified in a bulleted list would be
> annoying to the user. I also think I'm contemplating this too much. Any
> thoughts?

Actually Java5 will be required either way too.  Java is required for any usage of COSMOS.  So really the only thing you would have them skip is BIRT.  But I will leave it up to you to do as you think is best. 

Comment 28 Pam Kusnirik CLA 2008-10-20 22:04:48 EDT
Please note that there are outstanding issues for this issue that I still need feedback on, that David identified in his comments. Hubert, Sheldon, Ruth, Jimmy, and Srinivas are specifically mentioned. Please provide feedback on the following issues to I can finish up this guide by the doc deadline.

Here are the issues I'm referring to so you don't have to hunt for your name in previous posts:

*COSMOS Demo Setup - 
Hubert, do we still pass in the location of the axis2 war jar?


*COSMOS Demo Web User Interface - 
In the list under Data Managers View, it lists the Statistical Data Manager and
Logging Data Manager.  Weren't those recently removed due to IP concerns?
Update from David: OK, I did some fact checking on this (yes, too much watching debate analysis). 
The statistical data manager is likely still in.  Sheldon or Hubert can
probably confirm.  The logging data manager includes CBE, which had to be (or
will be) removed from the build; Ruth is checking to see if we can reference
the CBE plugin itself instead.  I don't know what I'm talking about, so I'll
stop there.  I trust someone else will let you know if the logging data manager
instructions have to be removed.


*Installing Resource Modeling Tooling
> Issues: 
  In this section and the SDK section, shouldn't we also point out the update
> installer as an alternative means of installing?
> (and)
> I'm not sure of the purpose of Manual Installation.  It seems basically the
> same as automatic, except that you unzip it to the hard drive before copying it
> over.  Again, I think we want to instead contrast unzipping the download with
> using the update installer.
David's update that still needs clarification:
As far as I'm concerned we can remove the Manual Installation section and offer
one way of installing. Since time is short, you probably don't want to spend
time learning how the update installer works.  I don't have time now to write
up a draft of that; maybe Srinivas or Jimmy want to step through writing
something about installing RM tooling using these instructions, assuming the
update site is still current:
http://wiki.eclipse.org/COSMOS_1.0.0_update_site_installation
Srinivas, if it's not already part of your testing, we might want to add a step
to iteration testing to ensure the update site is functional and that you can
install COSMOS components correctly using that approach.
---------------------------
 
Thanks very much.




Comment 29 Pam Kusnirik CLA 2008-10-20 22:11:42 EDT
(In reply to comment #28)
One more outstanding issue for the DV or QA team:
On the Prerequisites page, should this be “Business Intelligence and Reporting 
> Tools - BIRT 2.3.1”?
http://www.eclipse.org/birt/phoenix/
(It currently reads Business Intelligence and Reporting Tools - BIRT 2.3)    
David's previous comment: I'm not sure which is correct.  Hopefully someone from the DV team or QA can clarify this.
Comment 30 SrinivasReddy CLA 2008-10-21 05:29:21 EDT
(In reply to comment #29)
> (In reply to comment #28)
> One more outstanding issue for the DV or QA team:
> On the Prerequisites page, should this be “Business Intelligence and Reporting 
> > Tools - BIRT 2.3.1”?
> http://www.eclipse.org/birt/phoenix/
> (It currently reads Business Intelligence and Reporting Tools - BIRT 2.3)    
> David's previous comment: I'm not sure which is correct.  Hopefully someone
> from the DV team or QA can clarify this.

Last version where QA has tested COSMOS is BIRT 2.3.0, which was listed under COSMOS downloads requirements section (http://download.eclipse.org/birt/downloads/drops/R-R1-2_3_0-200806191030/birt-runtime-2_3_0.zip). Hence, I feel BIRT 2.3.0 is the correct version
Comment 31 SrinivasReddy CLA 2008-10-21 05:42:55 EDT
> *Installing Resource Modeling Tooling
> > Issues: 
>   In this section and the SDK section, shouldn't we also point out the update
> > installer as an alternative means of installing?
> > (and)
> > I'm not sure of the purpose of Manual Installation.  It seems basically the
> > same as automatic, except that you unzip it to the hard drive before copying it
> > over.  Again, I think we want to instead contrast unzipping the download with
> > using the update installer.
> David's update that still needs clarification:
> As far as I'm concerned we can remove the Manual Installation section and offer
> one way of installing. Since time is short, you probably don't want to spend
> time learning how the update installer works.  I don't have time now to write
> up a draft of that; maybe Srinivas or Jimmy want to step through writing
> something about installing RM tooling using these instructions, assuming the
> update site is still current:
> http://wiki.eclipse.org/COSMOS_1.0.0_update_site_installation
> Srinivas, if it's not already part of your testing, we might want to add a step
> to iteration testing to ensure the update site is functional and that you can
> install COSMOS components correctly using that approach.
> ---------------------------
> Thanks very much.

COSMOS SDK and SML Tooling can also be installed using Update site installer, however the current site - "http://download.eclipse.org/technology/cosmos/1.0.0/update-site" is not upto date, it's pointing to very old builds. Hence I would recommend to have both Manual and Update site instructions for SDK and SML tooling. 

Also,for update site instructions we can just provide the link to "http://wiki.eclipse.org/COSMOS_1.0.0_update_site_installation", without rewriting instructions over here.
Comment 32 David Whiteman CLA 2008-10-21 07:14:04 EDT
(In reply to comment #31)
 
> COSMOS SDK and SML Tooling can also be installed using Update site installer,
> however the current site -
> "http://download.eclipse.org/technology/cosmos/1.0.0/update-site" is not upto
> date, it's pointing to very old builds. Hence I would recommend to have both
> Manual and Update site instructions for SDK and SML tooling. 
> 
> Also,for update site instructions we can just provide the link to
> "http://wiki.eclipse.org/COSMOS_1.0.0_update_site_installation", without
> rewriting instructions over here.
> 

I have created bug 251519 to address the update site not being kept up-to-date.  If that defect is not resolved for 1.0, we should not mention the update site in the install guide.
Comment 33 Sheldon Lee-Loy CLA 2008-10-21 08:25:03 EDT
(In reply to comment #28)

> *COSMOS Demo Web User Interface - 
> In the list under Data Managers View, it lists the Statistical Data Manager and
> Logging Data Manager.  Weren't those recently removed due to IP concerns?
> Update from David: OK, I did some fact checking on this (yes, too much watching
> debate analysis). 
> The statistical data manager is likely still in.  Sheldon or Hubert can
> probably confirm.  The logging data manager includes CBE, which had to be (or
> will be) removed from the build; Ruth is checking to see if we can reference
> the CBE plugin itself instead.  I don't know what I'm talking about, so I'll
> stop there.  I trust someone else will let you know if the logging data manager
> instructions have to be removed.
> 

Yes, the statistical data manager should be still part of COSMOS.  The CBE logging data manager should be removed as it references TPTP jars to parse CBEs.  

I can't advice if we should remove the logging data manager instruction if Ruth still thinks we can reference the CBE plugin instead.  However, this might complicate the builds and hence complicate how adopters will run the COSMOS demo.  I'm not sure if keeping the logging data manager is worth while.  We have the statistical report to demonstrate a data manager that is not an MDR.  It also demonstrates a custom report based on a data manager.
Comment 34 David Whiteman CLA 2008-10-24 16:06:53 EDT
Pam, you might want to wait on my suggestion to add the link to download Axis2 to the prereqs list.  Even though we have an explicit list of jar files, Ruth had wanted the download link removed.  I'm not sure how a user would know where to get those jars, but I think she had concerns about the implication of having a link to the full distribution.  Hopefully she can help us resolve this when she returns on Monday.
Comment 35 Pam Kusnirik CLA 2008-10-29 21:30:51 EDT
(In reply to comment #34)
> Pam, you might want to wait on my suggestion to add the link to download Axis2
> to the prereqs list.  Even though we have an explicit list of jar files, Ruth
> had wanted the download link removed.  I'm not sure how a user would know where
> to get those jars, but I think she had concerns about the implication of having
> a link to the full distribution.  Hopefully she can help us resolve this when
> she returns on Monday.

Ruth stated that no link will be included on the Prereqs page to download Axis2. I understand that there are legal requirements to that decision, but is there any way possible we can give the user some type of guidance on how to find the download, that gets around the red tape?
Comment 36 David Whiteman CLA 2008-10-29 21:42:07 EDT
(In reply to comment #35)
> Ruth stated that no link will be included on the Prereqs page to download
> Axis2. I understand that there are legal requirements to that decision, but is
> there any way possible we can give the user some type of guidance on how to
> find the download, that gets around the red tape?

One thing you can do is refer to it as Apache Axis2, which is the full name of it.  That way they know it is something they get from the Apache site (similar to Tomcat). 

Comment 37 David Whiteman CLA 2008-10-31 10:40:53 EDT
Comment on attachment 115195 [details]
COSMOS 1.0 Install Guide

This attachment is obsolete.  The latest version should be attached to this bug.
Comment 38 David Whiteman CLA 2008-10-31 10:45:12 EDT
I am having trouble finding the latest draft of the install guide to check this, but please ensure we have the file commons-codec-1.3.jar listed in the Axis2 prereq jars.  It might be missing there, though I can't confirm.
Comment 39 Pam Kusnirik CLA 2008-10-31 10:47:31 EDT
(In reply to comment #38)
> I am having trouble finding the latest draft of the install guide to check
> this, but please ensure we have the file commons-codec-1.3.jar listed in the
> Axis2 prereq jars.  It might be missing there, though I can't confirm.

It will be later today. Note there is still an outstanding issue that might
affect the Prereqs page so I need clarification ASAP if it's going to make it
into today's doc build (see Bug 250489). Note that all guides will be posted by
1:30 today to their corresponding bugs.

commons-codec-1.3.jar is listed in the Axis2 jar files.
Comment 40 Pam Kusnirik CLA 2008-10-31 13:26:38 EDT
Created attachment 116639 [details]
Installation Guide
Comment 41 Pam Kusnirik CLA 2008-10-31 13:27:05 EDT
Final version attached.
Comment 42 Ruth Lee CLA 2008-11-11 10:39:45 EST
Across the three guides there were some orphan files, some broken anchors, and some missing ibmdita.css. (I forget which changes that I made to which files.) Checked in now into CVS and into the web site.