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

Bug 385717

Summary:	Rename org.eclipse.rap.help to org.eclipse.rap.doc?
Product:	[RT] RAP	Reporter:	Ralf Sternberg <rsternberg>
Component:	Tools	Assignee:	Project Inbox <rap-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	P1	CC:	mknauer
Version:	2.0
Target Milestone:	2.0 M4
Hardware:	PC
OS:	Linux
Whiteboard:

Description Ralf Sternberg

2012-07-23 08:30:37 EDT

We've already renamed our help project from org.eclipse.rap.ui.help to org.eclipse.rap.help in bug 251419. But this bundle id can still be mistaken to be the RAP equivalent of org.eclipse.help.
Looking over bug 379598, it seems that the convention is to use the suffix .doc for bundles that provide documentation.
Should we follow this convention? If yes, 2.0 is probably a good occasion.

Comment 1 Markus Knauer

2012-07-25 06:40:58 EDT

As far as I remember the old naming convention is split into 

* foo.bar.doc.user and
* foo.bar.doc.isv

If I am not mistaken and if I apply this convention to the RAP bundles, I end up with

* org.eclipse.rap.doc.isv (for help about RAP Runtime and its API)

If there was any RAP Tools specific documentation, it would go into 'org.eclipse.rap.tools.doc.user'.

In order to avoid any potential future conflicts and confusion, I think we should take the opportunity to rename it now with 2.0.

Comment 2 Ralf Sternberg

2012-10-18 10:32:52 EDT

(In reply to comment #1)
I'd rather keep it simple. There isn't too much documentation at the moment and I doubt that it will explode in the future. Splitting it up into runtime/tools and/or into user/isv would make it more complicated to find the right information. Instead of the one and only "RAP Developer's Guide" we'd end up with more guides such as a "RAP Tools Guide" etc. Moreover, it's probably hard to separate runtime and tools documentation because the are closely related.

> In order to avoid any potential future conflicts and confusion, I think we
> should take the opportunity to rename it now with 2.0.

I agree. Although this will change the pattern of our help URLs, I think we should do that now.

Comment 3 Markus Knauer

2012-12-05 04:46:09 EST

I am going to rename it to 'org.eclipse.rap.doc' then.

Comment 4 Markus Knauer

2012-12-05 05:05:41 EST

Implemented in commit f8e81799705fb3712971e20db9bd388e5cfb343d.