Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 297142 - Provide more documentation
Summary: Provide more documentation
Status: CLOSED FIXED
Alias: None
Product: EMF
Classification: Modeling
Component: cdo.core (show other bugs)
Version: 4.5   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Eike Stepper CLA
QA Contact: Eike Stepper CLA
URL:
Whiteboard: N&N
Keywords:
: 391103 (view as bug list)
Depends on:
Blocks:
 
Reported: 2009-12-07 18:39 EST by Neil Bartlett CLA
Modified: 2020-12-11 10:35 EST (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Neil Bartlett CLA 2009-12-07 18:39:03 EST
I would very much like to know what CDO is, since cool people are talking about it.

So I went to http://www.eclipse.org/cdo/ and clicked the big Documentation link. The result is a page with a navigation bar on the left, but no content. So I clicked "About" but this gives a 404 Not Found. Going back, I clicked on "Manual 2.0" and this resulted in an almost-empty "Work in Progress" page. Finally I clicked on Presentations and this led to a series of slides mostly written in the Presentation Zen style... i.e. very pretty but totally useless as standalone documents.

Overall the approach to documenting this project seems far too zen-like. When it comes to documentation, less is NOT more. Please fix this!
Comment 1 Eike Stepper CLA 2009-12-08 02:19:14 EST
Hi Neil, thanks for your interest. We are aware that the volume of documentation is less than optimal and we would really like to have more of it. Currently the best sources for information are (probably in that order):

1) The CDO webinar listed in the Presentations section of the homepage
2) The wiki http://wiki.eclipse.org/CDO
3) The JavaDocs of the interfaces

Unfortunately the sponsors of CDO are not funding documentation work in particular but rather some large and very interesting new features like an offline mode. Hopefully I (or somebody else) will find time to add necessary manual pages for Helios...
Comment 2 ekkehard gentz CLA 2009-12-08 03:07:15 EST
At some eclipse democamps I presented our redview - CDO Integration.

there was much discussion about missing documentation  and examples of CDO:

* easy download of a default-configured CDO Server
* example of EMF Library with Editor to open and edit from CDO Server

ekke
Comment 3 Eike Stepper CLA 2009-12-09 01:56:47 EST
(In reply to comment #2)
> * easy download of a default-configured CDO Server

Generally a good idea but a bit vague. Do you mean OS-specific executables? I would like that idea and long ago I filed a CQ for the usage of an installation wizard. It was rejected by the foundation ;-(

> * example of EMF Library with Editor to open and edit from CDO Server

Why does it have to be the Library example? We have a somewhat complexer "Company" example. Maybe we should mention that in the docs...
Comment 4 ekkehard gentz CLA 2009-12-09 02:30:32 EST
(In reply to comment #3)
> (In reply to comment #2)
> > * easy download of a default-configured CDO Server
> 
> Generally a good idea but a bit vague. Do you mean OS-specific executables? I
> would like that idea and long ago I filed a CQ for the usage of an installation
> wizard. It was rejected by the foundation ;-(
at first it could help a short description "HowTo start a CDO server"
something like:
install EPP Modeling
add updatesite xxxx
choose bundle a + b
copy configfile xxx from xxx to config location xxxxx (OS specific)
import launch config
start server
and then the hint "never quit application - always use close from cosole -
otherwise at restart server reports corrupt data

much better would of course be something more automated
like install CDO Server

then provide a client to test the server with a simple hello world example
> 
> > * example of EMF Library with Editor to open and edit from CDO Server
> 
> Why does it have to be the Library example? We have a somewhat complexer
> "Company" example. Maybe we should mention that in the docs...
this was only an example ;-)
doesnt matter what, but (as Jochen Krause said) it must be easy to follow
so the developer has success and then is motivated to go deeper into CDO

only my 2cts
Comment 5 Eike Stepper CLA 2010-06-29 04:49:54 EDT
Rebasing all outstanding enhancements requests to version 4.0
Comment 6 Eike Stepper CLA 2011-06-23 03:56:29 EDT
Moving all open enhancement requests to 4.1
Comment 7 Eike Stepper CLA 2012-08-14 22:54:53 EDT
Moving all open issues to 4.2. Open bugs can be ported to 4.1 maintenance after they've been fixed in master.
Comment 8 Eike Stepper CLA 2012-10-04 05:56:23 EDT
*** Bug 391103 has been marked as a duplicate of this bug. ***
Comment 9 Eike Stepper CLA 2013-06-27 04:05:30 EDT
Moving all outstanding enhancements to 4.3
Comment 10 Eike Stepper CLA 2014-08-19 09:21:55 EDT
Moving all open enhancement requests to 4.4
Comment 11 Eike Stepper CLA 2014-08-19 09:34:39 EDT
Moving all open enhancement requests to 4.4
Comment 12 Eike Stepper CLA 2015-07-14 02:17:15 EDT
Moving all open bugzillas to 4.5.
Comment 13 Eike Stepper CLA 2015-09-22 05:29:26 EDT
I've finally managed to add a complete User's Guide that explains how to use the new CDO Explorer user interface and an Operator's Guide that explains how to configure and operate a CDO Server. I've also added some articles to the Programmer's Guide.
Comment 14 Eike Stepper CLA 2015-09-22 06:39:52 EDT
The changes are committed to master:
http://git.eclipse.org/c/cdo/cdo.git/commit/?id=25e044eec0e03b601204ef0daaaf07ae23aff194
Comment 15 Eike Stepper CLA 2015-09-22 06:41:10 EDT
And back-ported to 4.4 via bug 478047.
Comment 16 Eike Stepper CLA 2020-12-11 10:25:31 EST
Closing.
Comment 17 Eike Stepper CLA 2020-12-11 10:35:22 EST
Closing.