Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "COSMOS Manual Guide"

(Undo revision 87783 by Vasconi.us.ibm.com (Talk))
Line 1: Line 1:
The content on this Wiki page is invalid. [http://wiki.eclipse.org/COSMOS_Manual_Guide Click here] to view updated COSMOS Manual Guide. 
+
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]]
  
  
The COSMOS manual is a centralized page that displays all consumer and end user documents in a structured format.  This is an evolving document that will iteratively be improved based on user feedback.  Please don't hesitate to [https://dev.eclipse.org/mailman/listinfo/cosmos-dev contact us] to provide your suggestions.   
+
The COSMOS manual is a centralized page that displays all consumer and end user documents in a structured format.  This is an evolving document that will iteratively be improved based on user feedback.  Please don't hesitate to [https://dev.eclipse.org/mailman/listinfo/cosmos-dev contact us]to provide your suggestions.   
  
 +
== Document Schedule ==
 +
[http://wiki.eclipse.org/COSMOS_Document_Schedule Click here] to view the  detailed document schedule.
  
 +
== Audience Description ==
 +
{| border="1" cellpadding="2"
 +
!width="50"|Audience
 +
!width="225"|Description
 +
 +
|-
 +
|User  || A person who makes use of Eclipse COSMOS project to perform some function including support resources.
 +
|-
 +
|Devloper || Has an interest in building and/or deploying the Eclipse COSMOS plug-in with the purpose of extending the capabilities of the Eclipse Platform
 +
|}
 +
 +
 +
 +
[[Category:COSMOS_Documentation]]
 +
 +
== Document Outlines  ==
 +
The following links outlines the structure of the User's Guide and Develoment Guide. 
 +
* [http://wiki.eclipse.org/COSMOS_Document_UG_template User's Guide]
 +
* [http://wiki.eclipse.org/COSMOS_Document_Dev_Guide_template Development Guide]
 +
 +
== Document Assignments  ==
 +
This section shows what content needs to be developed and whom it belongs to. 
 +
=== COSMOS User's Guide ===
 +
{|{{BMTableStyle}}
 +
 +
|-{{BMTHStyle}}
 +
!align="left"|Table of contents
 +
{| border="1" cellpadding="2"
 +
|- style="color: white; background-color: blue;"
 +
!width="50"|Bug
 +
!width="75"| Status
 +
!width="125"| Owner
 +
!width="225"| Document section
 +
!width="225"| Comments
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218825 218825] || Assigned || Rich Vasconi and Mark Weitzel  || [[COSMOS_User's Guide | User's Guide]]  || Whole document
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218828 218828] || Assigned || Mark Weitzel  || [[COSMOS_UG_Overview | 1.0 Overview]]  ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218830 218830] || Assigned || Mark Weitzel  || [[COSMOS_UG_Prerequisites | 1.1 Prerequisites]]  ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218853 218853] || Assigned || Jimmy Mohsin  ||  [[COSMOS_UG_Service Registration and Discovery |2.0 Core COSMOS Components]]              ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218836 218836] || Assigned || Jimmy Mohsin  ||  [[COSMOS_UG_Management of COSMOS | 2.1 Management of COSMOS Components]]    ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218844 218844] || Assigned || Jimmy Mohsin  || [[COSMOS_UG_How to start Data Broker and Data Manager |2.2 How to start Data Broker and Data Manager  ]]        ||
 +
|-
 +
| || ||  ||  || 3.0 has moved to item 8.0            ||
 +
|-
 +
| || ||  ||  || 4.0 has moved to item 2.1            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218849 218849] || Assigned || Bill Muldoon, Jack Devine  || [[COSMOS_UG_Introduction to CMDBf |5.0 Using CMDBf in COSMOS]]            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218851 218851] || Assigned || Jimmy Mohsin  || [[COSMOS_UG_Query Capabilities |6.0 Query Capabilities]]              ||Use scenarios
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218858 218858] || Assigned || Jimmy Mohsin  || [[COSMOS_UG_Data Managers Adapters |7.0 Data Managers - Adapters for integrating applications to the COSMOS infrastructure]]            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218838 218838] || Assigned || Sheldon Lee-Loy  || [[COSMOS_UG_Web Component Library |8.0  COSMOS Web Component Library]]            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218871 218871] || Assigned || David Whiteman  || [[COSMOS_UG_SML |9.0  Service Modeling Language (SML) Tooling & Usage]]  ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219117 219117] || Assigned || Jason Losh  || [[COSMOS_UG_SDD |10.0  Solution Deployment Descriptor (SDD)]]          ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219118 219118] || Assigned || Hubert Leung  || [[COSMOS_UG_Deploying COSMOS |11.0  Deploying COSMOS]]            || Hubert: I suggest removing this section. The installation of the toolkit, COSMOS UI, and the demo are covered under various sections. 
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219120 219120] || Assigned || Hubert Leung || [[COSMOS_UG_Running the Example |12.0  Running the Example ]]        ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218841 218841] || Assigned || Sheldon Lee-Loy  || [[COSMOS_UG_Web_Console |12.1 Web Console]]    ||
 +
|}
 +
|}
 +
<br/>
 +
 +
=== COSMOS Development Guide ===
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
!align="left"|Table of contents
 +
{| border="1" cellpadding="2"
 +
|- style="color: white; background-color: green;"
 +
!width="50"|Bug
 +
!width="75"| Status
 +
!width="125"| Owner
 +
!width="225"| Document section
 +
!width="225"| Comments
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219130 219130] || Assigned || Rich Vasconi and Mark Weitzel  || [[COSMO_Development_Guide | Development Guide]]  || Status and comments
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219138 219138] || Assigned || Mark Weitzel  || [[COSMOS_DG_Overview | 1.0 Overview]]  ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219141 219141] || Assigned || Hubert Leung, David Whiteman  || [[COSMOS_DG_Constructing a Data Manager |2.0 Constructing a Data Manager]]  || (including debug & test)
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219142 219142] || Assigned || Ali Mehregani  || [[COSMOS_DG_Providing CMDBf Query and Registration Services |3.0 Providing CMDBf Query and Registration Services]]              || (including debug & test)
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219143 219143] || Assigned || Sheldon Lee-Loy  || [[COSMOS_DG_Extending the Web User Interface Framework |4.0 Extending the Web User Interface Framework]]            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219144 219144 ] || Assigned || Joel Hawkins  || [[COSMOS_DG_Management Enablement |5.0 Management Enablement]]            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219148 219148] || Assigned || Balan Subramanian  || [[COSMOS_DG_WSDM Tooling |5.1 WSDM Tooling]]            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219150 219150 ] || Assigned || Joel Hawkins  || [[COSMOS_DG_WSDM Annotations |5.2  WSDM Annotations]]          ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219151 219151 ] || Assigned || Hubert Leung  || [[COSMOS_DG_Application Integration and Data Federation |6.0 Application Integration and Data Federation]]            || Hubert: I suggest removing this section.  If you refer to [http://wiki.eclipse.org/index.php?title=COSMOS_Manual_Guide&oldid=72258 Revision as of 23:22, 7 January 2008] of this wiki page, this heading was a section title that introduce various features provided by COSMOS.  The content is already covered by other sections.
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219152 219152 ] || Assigned || Ali Mehregani    || [[COSMOS_DG_Support for CMDBf |6.1 Support for CMDBf]]            ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219153 219153 ]|| Assigned || Jimmy Mohsin  || [[COSMOS_DG_Security requirements |7.0  Security requirements]]          ||
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219154 219154 ]|| Assigned || Jimmy Mohsin  || [[COSMOS_DG_Internationalization |8.0  Internationalization]]          ||
 +
 +
|}
 +
|}
 +
<br/>
 +
 +
=== COSMOS Application Program Interface Guide ===
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
!align="left"|Table of contents
 +
{| border="1" cellpadding="2"
 +
|- style="color: black; background-color: gray;"
 +
!width="50"|Bug
 +
!width="75"| Status
 +
!width="125"| Owner
 +
!width="225"| Document section
 +
!width="225"| Comments
 +
|-
 +
|123456 || Assigned || TBD  || [[COSMOS_API_Guide | API]] 
 +
            ||
 +
|}
 +
|}
 +
 +
=== COSMOS Logging and Messaging Guide ===
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
!align="left"|Table of contents
 +
{| border="1" cellpadding="2"
 +
|- style="color: black; background-color: gray;"
 +
!width="50"|Bug
 +
!width="75"| Status
 +
!width="125"| Owner
 +
!width="225"| Document section
 +
!width="225"| Comments
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=222574 222574] || Assigned || Paul Stratton  || [[COSMOS_Logging_and_Messaging |Logging and Messaging]]            ||
 +
|}
 +
|}
 +
 +
=== COSMOS Installation Guide ===
 +
{|{{BMTableStyle}}
 +
|-{{BMTHStyle}}
 +
!align="left"|Table of contents
 +
{| border="1" cellpadding="2"
 +
|- style="color: white; background-color: purple;"
 +
!width="50"|Bug
 +
!width="75"| Status
 +
!width="125"| Owner
 +
!width="225"| Document section
 +
!width="225"| Comments
 +
|-
 +
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219156 219156 ] || Assigned || Jimmy Mohsin  || [[COSMOS_InstallGuide10 | Installation Guide]]            ||
 +
|}
 +
|}
 +
<br/>
 +
 +
=== COSMOS Getting Started Guide ===
 
{|{{BMTableStyle}}
 
{|{{BMTableStyle}}
|+{{BMTableCaptionStyle}}|Table of Contents
 
 
|-{{BMTHStyle}}
 
|-{{BMTHStyle}}
!align="left"|[[COSMOS_Overview | 1. Overview]] <font size="1">[Owner: Mark Weitzel]</font>
+
!align="left"|Table of contents
&nbsp;&nbsp;&nbsp;&nbsp; [[Project_Objectives | 1.1 Project Objectives]] <font size="1">[Owner: Mark Weitzel]</font><br/>
+
{| border="1" cellpadding="2"
&nbsp;&nbsp;&nbsp;&nbsp; [[Integration_Federation | 1.2 Application Integration and Data Federation]] <font size="1">[Owner: Hubert Leung]</font><br/>
+
|- style="color: black; background-color: yellow;"
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [[Registration_Discovery | 1.2.1 Service Registration and Discovery - Management Domain and Brokers]] <font size="1">[Owner: Ali Mehregani]</font><br/>
+
!width="50"|Bug
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [[Data_Managers | 1.2.2 Data Managers - Adapters for integrating applications to the COSMOS infrastructure]] <font size="1">[Owner: Ali Mehregani]</font><br/>
+
!width="75"| Status
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [[CMDBf_Support | 1.2.3 Support for CMDBf]] <font size="1">[Owner: Ali Mehregani]</font><br/>
+
!width="125"| Owner
&nbsp;&nbsp;&nbsp;&nbsp; [[Management_Enablement | 1.3 Management Enablement]] <font size="1">[Owner: Balan Subramanian]</font><br/>
+
!width="225"| Document section
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [[WSDM_Tooling | 1.3.1 WSDM Tooling]] <font size="1">[Owner: Balan Subramanian]</font><br/>
+
!width="225"| Comments
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [[WSDM Annotations | 1.3.2 WSDM Annotations]] <font size="1">[Owner: Joel Hawkins]</font><br/>
+
|-
&nbsp;&nbsp;&nbsp;&nbsp; [[Web_Console | 1.4 Web Console for System Administrators]] <font size="1">[Owner: Sheldon Lee-Loy]</font><br/>
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219157 219157 ] || Assigned || Rich Vasconi  || [[COSMOS_Getting_Started | Getting Started Guide]]           ||
&nbsp;&nbsp;&nbsp;&nbsp; [[Service_Modeling_Language  | 1.5 Service Modeling Language (SML)]] <font size="1">[Owner: Valentina Popescu]</font><br/>
+
|}
&nbsp;&nbsp;&nbsp;&nbsp; [[Solution_Deployment_Descriptor | 1.6 Solution Deployment Descriptor (SDD)]] <font size="1">[Owner: Jason Losh]</font><br/>
+
|}
[[Development_Guide | 2. Development Guide]] <font size="1">[Owner: Mark Weitzel]</font><br/>
+
<br/>
&nbsp;&nbsp;&nbsp;&nbsp;[[Running_Example | 2.1 Running the Example]] <font size="1">[Owner: Hubert Leung]</font><br/>
+
&nbsp;&nbsp;&nbsp;&nbsp;[[Creating_Data_Manager | 2.2 Constructing a Data Manager]] <font size="1">[Owner: Hubert Leung]</font><br/>
+
&nbsp;&nbsp;&nbsp;&nbsp;[[Creating_MDR | 2.3 Constructing an MDR]] <font size="1">[Owner: Hubert Leung] </font><br/>
+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[CMDBf_Services | 2.3.1 Providing CMDBf Services]] <font size="1">[Owner: Ali Mehregani]</font><br/>
+
&nbsp;&nbsp;&nbsp;&nbsp;[[Extending_UI | 2.4 Extending the Web User Interface Framework]] <font size="1">[Owner: Sheldon Lee-Loy]</font><br/>
+
&nbsp;&nbsp;&nbsp;&nbsp;[[Deploying_COSMOS | 2.5 Deploying COSMOS]] <font size="1">[Owner: Hubert Leung]</font><br/>
+
&nbsp;&nbsp;&nbsp;&nbsp;[[WSDM_Annotation | 2.6 Use of WSDM Annontations]] <font size="1">[Owner: Joel Hawkins]</font><br/>
+
|-}
+

Revision as of 09:37, 18 March 2008

COSMOS Wiki > COSMOS Document Plan


The COSMOS manual is a centralized page that displays all consumer and end user documents in a structured format. This is an evolving document that will iteratively be improved based on user feedback. Please don't hesitate to contact usto provide your suggestions.

Document Schedule

Click here to view the detailed document schedule.

Audience Description

Audience Description
User A person who makes use of Eclipse COSMOS project to perform some function including support resources.
Devloper Has an interest in building and/or deploying the Eclipse COSMOS plug-in with the purpose of extending the capabilities of the Eclipse Platform

Document Outlines

The following links outlines the structure of the User's Guide and Develoment Guide.

Document Assignments

This section shows what content needs to be developed and whom it belongs to.

COSMOS User's Guide

Table of contents
Bug Status Owner Document section Comments
218825 Assigned Rich Vasconi and Mark Weitzel User's Guide Whole document
218828 Assigned Mark Weitzel 1.0 Overview
218830 Assigned Mark Weitzel 1.1 Prerequisites
218853 Assigned Jimmy Mohsin 2.0 Core COSMOS Components
218836 Assigned Jimmy Mohsin 2.1 Management of COSMOS Components
218844 Assigned Jimmy Mohsin 2.2 How to start Data Broker and Data Manager
3.0 has moved to item 8.0
4.0 has moved to item 2.1
218849 Assigned Bill Muldoon, Jack Devine 5.0 Using CMDBf in COSMOS
218851 Assigned Jimmy Mohsin 6.0 Query Capabilities Use scenarios
218858 Assigned Jimmy Mohsin 7.0 Data Managers - Adapters for integrating applications to the COSMOS infrastructure
218838 Assigned Sheldon Lee-Loy 8.0 COSMOS Web Component Library
218871 Assigned David Whiteman 9.0 Service Modeling Language (SML) Tooling & Usage
219117 Assigned Jason Losh 10.0 Solution Deployment Descriptor (SDD)
219118 Assigned Hubert Leung 11.0 Deploying COSMOS Hubert: I suggest removing this section. The installation of the toolkit, COSMOS UI, and the demo are covered under various sections.
219120 Assigned Hubert Leung 12.0 Running the Example
218841 Assigned Sheldon Lee-Loy 12.1 Web Console


COSMOS Development Guide

Table of contents
Bug Status Owner Document section Comments
219130 Assigned Rich Vasconi and Mark Weitzel Development Guide Status and comments
219138 Assigned Mark Weitzel 1.0 Overview
219141 Assigned Hubert Leung, David Whiteman 2.0 Constructing a Data Manager (including debug & test)
219142 Assigned Ali Mehregani 3.0 Providing CMDBf Query and Registration Services (including debug & test)
219143 Assigned Sheldon Lee-Loy 4.0 Extending the Web User Interface Framework
219144 Assigned Joel Hawkins 5.0 Management Enablement
219148 Assigned Balan Subramanian 5.1 WSDM Tooling
219150 Assigned Joel Hawkins 5.2 WSDM Annotations
219151 Assigned Hubert Leung 6.0 Application Integration and Data Federation Hubert: I suggest removing this section. If you refer to Revision as of 23:22, 7 January 2008 of this wiki page, this heading was a section title that introduce various features provided by COSMOS. The content is already covered by other sections.
219152 Assigned Ali Mehregani 6.1 Support for CMDBf
219153 Assigned Jimmy Mohsin 7.0 Security requirements
219154 Assigned Jimmy Mohsin 8.0 Internationalization


COSMOS Application Program Interface Guide

Table of contents
Bug Status Owner Document section Comments
123456 Assigned TBD API

COSMOS Logging and Messaging Guide

Table of contents
Bug Status Owner Document section Comments
222574 Assigned Paul Stratton Logging and Messaging

COSMOS Installation Guide

Table of contents
Bug Status Owner Document section Comments
219156 Assigned Jimmy Mohsin Installation Guide


COSMOS Getting Started Guide

Table of contents
Bug Status Owner Document section Comments
219157 Assigned Rich Vasconi Getting Started Guide


Back to the top