Jump to: navigation, search

Difference between revisions of "COSMOS Manual Guide"

(COSMOS Getting Started Guide)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]]
 
[[COSMOS|COSMOS Wiki]] > [[COSMOS_Documentation_Plan|COSMOS Document Plan]]
  
 +
<font color=red>Important Note!  This does not represent the most recent level of documentation.  This documentation served as input the documentation editor, who converted it to HTML and updated it.  Please instead use the documentation found here: http://www.eclipse.org/cosmos/documents/index.php</font>
 +
 +
[[COSMOS_Documentation_Meeting_Minutes_20080905]]
  
 
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 ==
 
== Document Schedule ==
[http://wiki.eclipse.org/COSMOS_Document_Schedule Click here] to view the detailed document schedule.
+
[http://wiki.eclipse.org/COSMOS_Document_Schedule Click here] to view the detailed document schedule.
  
 
== Audience Description ==
 
== Audience Description ==
Line 15: Line 18:
 
|User  || A person who makes use of Eclipse COSMOS project to perform some function including support resources.
 
|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  
+
|Developer || Has an interest in building and/or deploying the Eclipse COSMOS plug-in with the purpose of extending the capabilities of the Eclipse Platform  
 
|}
 
|}
  
Line 47: Line 50:
  
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218830 218830] || Assigned || Mark Weitzel  || [[COSMOS_UG_Prerequisites | 1.1 Prerequisites]]  || Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218830 218830] || Complete || Mark Weitzel  || [[COSMOS_UG_Prerequisites | 1.1 Prerequisites]]  || Closed
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=223084 223084] || Resolved || Mark Weitzel  || [[COSMOS_UG_Restrictions | 1.2 Limitation and Restrictions]]  || Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=223084 223084] || Complete || Mark Weitzel  || [[COSMOS_UG_Restrictions | 1.2 Limitation and Restrictions]]  || Closed
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218853 218853] || Resolved || Jimmy Mohsin  ||  [[COSMOS_UG_Service Registration and Discovery |2.0 Core COSMOS Components]]              || Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218853 218853] || Closed || Jimmy Mohsin  ||  [[COSMOS_UG_Service Registration and Discovery |2.0 Core COSMOS Components]]              || Closed
  
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218836 218836] || Resolved || Jimmy Mohsin  ||  [[COSMOS_UG_Management of COSMOS |2.1 Management of COSMOS Components]]              || Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218836 218836] || Closed || Jimmy Mohsin  ||  [[COSMOS_UG_Management of COSMOS |2.1 Management of COSMOS Components]]              || Closed
 
|-
 
|-
|<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218844 218844]</strike> || Resolved || Jimmy Mohsin  || <strike> [[COSMOS_UG_How to start Data Broker and Data Manager |2.2 How to start Data Broker and Data Manager  ]]  </strike> || Combined with bug 218836 Closed
+
|<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218844 218844]</strike> || Closed || Jimmy Mohsin  || <strike> [[COSMOS_UG_How to start Data Broker and Data Manager |2.2 How to start Data Broker and Data Manager  ]]  </strike> || Combined with bug 218836 Closed
 
|-
 
|-
|[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]]            || Outline (Complete) Content (Complete, but references many other sections in both docs that are not complete.)
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218849 218849] || Closed || Bill Muldoon, Jack Devine  || [[COSMOS_UG_Introduction to CMDBf |5.0 Using CMDBf in COSMOS]]            || Closed
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218851 218851] || Resolved || Jimmy Mohsin  || [[COSMOS_UG_Query Capabilities |6.0 Query Capabilities]]              || Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218851 218851] || Closed || Jimmy Mohsin  || [[COSMOS_UG_Query Capabilities |6.0 Query Capabilities]]              || Closed
 
|-
 
|-
|<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218858 218858]</strike> || Resolved || Jimmy Mohsin  || <strike> [[COSMOS_UG_Data Managers Adapters |7.0 Data Managers - Adapters for integrating applications to the COSMOS infrastructure]] </strike> || After a call between Hubert Leung and Jimmy Mohsin on 4/18/200, a decision was made to remove this section. Data Managers are covered in 218853 (User Guide) and 219141 (Development Guide). Closed
+
|<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218858 218858]</strike> || Closed || Jimmy Mohsin  || <strike> [[COSMOS_UG_Data Managers Adapters |7.0 Data Managers - Adapters for integrating applications to the COSMOS infrastructure]] </strike> || After a call between Hubert Leung and Jimmy Mohsin on 4/18/200, a decision was made to remove this section. Data Managers are covered in 218853 (User Guide) and 219141 (Development Guide). Closed
 
|-
 
|-
|[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]]            || Outline (Missing) Content (Started but missing task oriented content about the Viewers, Manage and Utility.)
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218838 218838] || Complete || Sheldon Lee-Loy  || [[COSMOS_UG_Web Component Library |8.0  COSMOS Web Component Library]]            || Closed
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218871 218871] || Resolved || David Whiteman  || [[COSMOS_UG_SML |9.0  Service Modeling Language (SML) Tooling & Usage]]  || Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218871 218871] || Complete || David Whiteman  || [[COSMOS_UG_SML |9.0  Service Modeling Language (SML) Tooling & Usage]]  || Closed
  
 
|-
 
|-
 
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219117 219117] || Future || Jason Losh  || [[COSMOS_UG_SDD |10.0  Solution Deployment Descriptor (SDD)]]          || Moved to Future release
 
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219117 219117] || Future || Jason Losh  || [[COSMOS_UG_SDD |10.0  Solution Deployment Descriptor (SDD)]]          || Moved to Future release
 
|-
 
|-
|<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219118 219118]</strike> || Resolved || Hubert Leung  || <strike>[[COSMOS_UG_Deploying COSMOS |11.0  Deploying COSMOS]] </strike>            ||  Removed from document as per discusson at the 03/06/2008 COSMOS Weekly Community Call. Hubert: I suggest removing this section. The installation of the toolkit, COSMOS UI, and the demo are covered under various sections.  Closed  
+
|<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219118 219118]</strike> || Complete || Hubert Leung  || <strike>[[COSMOS_UG_Deploying COSMOS |11.0  Deploying COSMOS]] </strike>            ||  Removed from document as per discusson at the 03/06/2008 COSMOS Weekly Community Call. Hubert: I suggest removing this section. The installation of the toolkit, COSMOS UI, and the demo are covered under various sections.  Closed  
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219120 219120] || Resolved || Hubert Leung || [[COSMOS_UG_Running the Example |12.0  Running the Example ]]        || Use content from COSMOS Demo i11  Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219120 219120] || Complete || Hubert Leung || [[COSMOS_UG_Running the Example |12.0  Running the Example ]]        || Use content from COSMOS Demo i11  Closed
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218841 218841] || Resolved || Sheldon Lee-Loy  || [[COSMOS_UG_Web_Console |12.1 Web Console]]    || Closed
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=218841 218841] || Complete || Sheldon Lee-Loy  || [[COSMOS_UG_Web_Console |12.1 Web Console]]    || Closed
 
|}
 
|}
 
|}
 
|}
Line 92: Line 95:
 
!width="225"| Comments
 
!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=219130 219130] || Assigned || Rich Vasconi and Mark Weitzel  || [[COSMOS_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]]  || Outline (Missing) Content (Missing)
 
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219138 219138] || Assigned || Mark Weitzel  || [[COSMOS_DG_Overview | 1.0 Overview]]  || Outline (Missing) Content (Missing)
Line 112: Line 115:
 
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219152 219152 ] || Closed || Ali Mehregani    || <strike> [[COSMOS_DG_Support for CMDBf | 6.1 Support for CMDBf]] </strike>            || Removed from document as per discusson at the 03/06/2008 COSMOS Weekly Community Call.
 
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219152 219152 ] || Closed || Ali Mehregani    || <strike> [[COSMOS_DG_Support for CMDBf | 6.1 Support for CMDBf]] </strike>            || Removed from document as per discusson at the 03/06/2008 COSMOS Weekly Community Call.
 
|-
 
|-
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219153 219153 ]|| Resolved || Jimmy Mohsin  || [[COSMOS_DG_Security requirements |7.0  Security requirements]]          || Outline (Complete) Content (Complete)
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219153 219153 ]|| Closed || Jimmy Mohsin  || [[COSMOS_DG_Security requirements |7.0  Security requirements]]          || Outline (Complete) Content (Complete)
 
|-
 
|-
 
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219154 219154 ]|| Future || Jimmy Mohsin  || [[COSMOS_DG_Internationalization |8.0  Internationalization]]          || Outline (Complete) Content (Deferred till COSMOS 1.1)
 
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219154 219154 ]|| Future || Jimmy Mohsin  || [[COSMOS_DG_Internationalization |8.0  Internationalization]]          || Outline (Complete) Content (Deferred till COSMOS 1.1)
Line 131: Line 134:
 
!width="225"| Comments
 
!width="225"| Comments
 
|-  
 
|-  
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219156 219156 ] || Assigned || Jimmy Mohsin  || [[COSMOS_InstallGuide10 | Installation Guide]]            || Outline (Complete) Content (expected completion by i12)
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219156 219156 ] || Assigned || Paul Stratton || [[COSMOS_InstallGuide10 | Installation Guide]]            || Outline (Complete) Content (expected completion by i13)
 
|}
 
|}
 
|}
 
|}
Line 149: Line 152:
 
!width="225"| Comments
 
!width="225"| Comments
 
|-  
 
|-  
|123456 || Assigned || TBD  || [[COSMOS_API_Guide | API]]   
+
|TBD || 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]]            || Outline (Complete) Content (Missing)
 
|}
 
|}
 
  
  
Line 183: Line 171:
 
!width="225"| Comments
 
!width="225"| Comments
 
|-  
 
|-  
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219157 219157 ] || Complete || Rich Vasconi  || [[COSMOS_Getting_Started | Getting Started Guide]]            || .|}
+
|[https://bugs.eclipse.org/bugs/show_bug.cgi?id=219157 219157 ] || Complete || Rich Vasconi  || [[COSMOS_Getting_Started | Getting Started Guide]]            || .
 +
|}
 
|}
 
|}
 
<br/>
 
<br/>

Latest revision as of 15:24, 14 November 2008

COSMOS Wiki > COSMOS Document Plan

Important Note! This does not represent the most recent level of documentation. This documentation served as input the documentation editor, who converted it to HTML and updated it. Please instead use the documentation found here: http://www.eclipse.org/cosmos/documents/index.php

COSMOS_Documentation_Meeting_Minutes_20080905

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.
Developer 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 Content (Missing)
218830 Complete Mark Weitzel 1.1 Prerequisites Closed
223084 Complete Mark Weitzel 1.2 Limitation and Restrictions Closed
218853 Closed Jimmy Mohsin 2.0 Core COSMOS Components Closed
218836 Closed Jimmy Mohsin 2.1 Management of COSMOS Components Closed
218844 Closed Jimmy Mohsin 2.2 How to start Data Broker and Data Manager Combined with bug 218836 Closed
218849 Closed Bill Muldoon, Jack Devine 5.0 Using CMDBf in COSMOS Closed
218851 Closed Jimmy Mohsin 6.0 Query Capabilities Closed
218858 Closed Jimmy Mohsin 7.0 Data Managers - Adapters for integrating applications to the COSMOS infrastructure After a call between Hubert Leung and Jimmy Mohsin on 4/18/200, a decision was made to remove this section. Data Managers are covered in 218853 (User Guide) and 219141 (Development Guide). Closed
218838 Complete Sheldon Lee-Loy 8.0 COSMOS Web Component Library Closed
218871 Complete David Whiteman 9.0 Service Modeling Language (SML) Tooling & Usage Closed
219117 Future Jason Losh 10.0 Solution Deployment Descriptor (SDD) Moved to Future release
219118 Complete Hubert Leung 11.0 Deploying COSMOS Removed from document as per discusson at the 03/06/2008 COSMOS Weekly Community Call. Hubert: I suggest removing this section. The installation of the toolkit, COSMOS UI, and the demo are covered under various sections. Closed
219120 Complete Hubert Leung 12.0 Running the Example Use content from COSMOS Demo i11 Closed
218841 Complete Sheldon Lee-Loy 12.1 Web Console Closed


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 Outline (Missing) Content (Missing)
219141 Complete Hubert Leung, David Whiteman 2.0 Constructing a Data Manager .
219142 Complete Ali Mehregani 3.0 Providing CMDBf Query and Registration Services .
219143 Complete Sheldon Lee-Loy 4.0 Extending the Web User Interface Framework .
219144 Future Joel Hawkins 5.0 Management Enablement Future)
219148 Future Balan Subramanian 5.1 WSDM Tooling Outline Future
219150 Future Joel Hawkins 5.2 WSDM Annotations Future
219151 Closed Hubert Leung 6.0 Application Integration and Data Federation Removed from document. 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 Closed Ali Mehregani 6.1 Support for CMDBf Removed from document as per discusson at the 03/06/2008 COSMOS Weekly Community Call.
219153 Closed Jimmy Mohsin 7.0 Security requirements Outline (Complete) Content (Complete)
219154 Future Jimmy Mohsin 8.0 Internationalization Outline (Complete) Content (Deferred till COSMOS 1.1)


COSMOS Installation Guide

Table of contents
Bug Status Owner Document section Comments
219156 Assigned Paul Stratton Installation Guide Outline (Complete) Content (expected completion by i13)


COSMOS Application Program Interface Guide

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


COSMOS Getting Started Guide

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