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

Bug 345428

Summary:	Need a way to document service types
Product:	[ECD] Orion	Reporter:	Mark Macdonald <mamacdon>
Component:	Client	Assignee:	John Arthorne <john.arthorne>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	bokowski, john.arthorne, pwebster, simon_kaegi, susan
Version:	0.2	Keywords:	Documentation
Target Milestone:	0.2
Hardware:	PC
OS:	Windows 7
Whiteboard:

Description Mark Macdonald

2011-05-11 10:27:20 EDT

0.2 M7

When I want to contribute a service of a particular type, where do I go for documentation about how my contribution should look? At the moment there is no help, so I have to infer from existing contributions or by looking at the code that ultimately uses them.

I am interested in:
- A description of what the service type is for
- What service properties I must provide
- What methods my service must define

I would like to see a list of all available service types too. It would make sense to include this as part of the client-side documentation.

Comment 1 Boris Bokowski

2011-05-11 13:09:09 EDT

+1 - something on the Wiki would probably be a good start. John?

Comment 2 John Arthorne

2011-05-12 09:04:16 EDT

Let me get an initial structure setup, and I'll document it here.

Comment 3 John Arthorne

2011-06-17 15:08:35 EDT

This structure is now in place on the wiki:

http://wiki.eclipse.org/Orion/Documentation/Developer_Guide

Documentation added there is scraped into the build using WikiText.