Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Manual Guide"
m (COSMOS Documentation Topics moved to COSMOS Manual Guide) |
|
(No difference)
| |
Revision as of 18:30, 7 January 2008
We have some documentations on COSMOS already in the form of design docs, and wiki pages that we have written to explain various aspects of the project. We will need to come up with a coherent set of documentations for users to understand what COSMOS is and how to use it. We can reuse some contents from existing wiki pages, and may need to write more to fill the gaps. This page is a proposal for the structure of the content to be documented. I hope to get comments about the way information is presented/structure, and assign sections for committers to complete.
Contents
Overview
Provide definitions and high level descriptions of the project
Project Objectives
An executive overview on the purpose of the project and what features will COSMOS support
Application Integration and Data Federation
Service Registration and Discovery - Management Domain and Brokers
Data Managers - Adapters for integrating applications to the COSMOS infrastructure
Support for CMDBf
Management Enablement
WSDM Tooling
WSDM Annotations
Web Console for System Administrators
Extensible user interface framework for visualizing data and controlling data collection
SML
Introduce SML as a language (an extension of XML), and its potential use in CML. Provide reference to the specifications.
SDD
Development Guide
Documentation for developers who needs to adopt COSMOS and extend the framework
Running the Example
Instructions for running the example that comes with COSMOS
Creating a Data Manager
Instructions for extending the framework to create a data manager
http://wiki.eclipse.org/COSMOS_Programming_Model
Creating an MDR
Instructions for creating an MDR: Creating the MDR data manager
Extending CMDBf Query Processing Framework
Develop handlers for processing CMDBf queries
http://wiki.eclipse.org/Providing_a_CMDBf_Query_and_Registration_Service
Extending the Web User Interface Framework
Register views for data visualization and ways to customize the user interface
Deploying COSMOS
Deploying the end-to-end application