Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 368101

Summary: [console] Documentation for the console is necessary
Product: [Eclipse Project] Equinox Reporter: Lazar Kirchev <l.kirchev>
Component: ComponentsAssignee: Lazar Kirchev <l.kirchev>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: tjwatson
Version: 3.8.0 Juno   
Target Milestone: Juno M7   
Hardware: PC   
OS: Windows 7   
Whiteboard:
Attachments:
Description Flags
place holder for console doc
none
Patch with console documentation
none
Update of the shell documentation. none

Description Lazar Kirchev CLA 2012-01-08 07:43:23 EST 
Currently there is no documentation for the org.eclipse.equinox.console project. There is documentation on the incubator page, but this should be migrated and updated.
Comment 1 Lazar Kirchev CLA 2012-01-08 07:45:41 EST 
Tom, where should the documentation be placed? 
On the page for the bundles project, http://eclipse.org/equinox/bundles/, there are no details for the different projects, neither links to dedicated pages for each of them. I am not sure where to place the page, and from where to link it so that is easily accessible.
Comment 2 Thomas Watson CLA 2012-01-09 09:34:21 EST 
Created attachment 209207 [details]
place holder for console doc

Lazar, I suggest we add a section to the platform help for the console.  Attached is a patch to doc bundle from the repo:

http://git.eclipse.org/c/platform/eclipse.platform.common.git/

the project bundles/org.eclipse.platform.doc.isv contains the documentation for the platform.  I think it would be good to add the console shell documentation to this bundle.
Comment 3 Lazar Kirchev CLA 2012-02-12 09:03:51 EST 
Created attachment 210893 [details]
Patch with console documentation

The patch contains the user documentation for the new shell. I do not have sufficient permissions to submit it in eclipse.platform.common  project, so I attach the patch to this bug.
Comment 4 Lazar Kirchev CLA 2012-02-12 09:04:56 EST 
There is also some design documentation for the console. Which is the best place for it? Currently it is in the incubator console project documentation.
Comment 5 Thomas Watson CLA 2012-02-13 14:14:22 EST 
(In reply to comment #3)
> Created attachment 210893 [details]
> Patch with console documentation
> 
> The patch contains the user documentation for the new shell. I do not have
> sufficient permissions to submit it in eclipse.platform.common  project, so I
> attach the patch to this bug.

I released this in commit:

http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=a36c8d1052e32a6baa55ad47254fdaff7fd57309

(In reply to comment #4)
> There is also some design documentation for the console. Which is the best
> place for it? Currently it is in the incubator console project documentation.

I think design documentation has some place in the developers guide as well.  Otherwise I would recommend the use of a wiki for this.
Comment 6 Lazar Kirchev CLA 2012-02-14 03:05:03 EST 
Thanks!

As for the developers guide - in which project is it? I was thinking about a wiki too, but is it a problem if I place the documentation in both places?
Comment 7 Lazar Kirchev CLA 2012-04-30 08:56:03 EDT 
Created attachment 214797 [details]
Update of the shell documentation.

This update should be submitted after the documentation patch in bug 376319.