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

Bug 331272

Summary:	Include example search contribution in SCM / Build
Product:	[Eclipse Project] e4	Reporter:	Dimitar Georgiev <dimitar.georgiev>
Component:	Search	Assignee:	Project Inbox <e4.search-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	aniefer, bokowski, danail.branekov, dimitar.georgiev, martina.galabova, pwebster
Version:	unspecified
Target Milestone:	---
Hardware:	All
OS:	All
Whiteboard:
Bug Depends on:
Bug Blocks:	331336

Description Dimitar Georgiev

2010-11-27 08:23:06 EST

In one of his comments on the Search console contribution, Dani Branekov has provided a sample search contribution to the incubator search:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=322721#c23
And here's the attachment:
https://bugs.eclipse.org/bugs/attachment.cgi?id=180107

This is a valuable piece of code, because although trivial as provided functionality, it demonstrates the key concepts of the framework. It's not the best if it just stays as a bugzilla attachment.
Therefore we would like to contribute it in the SCM.
Following the e4 convention, we will create the bundle at this path of the search repo: examples/org.eclipse.demo.cheatsheets.search.

Before we can do that, I have some unanswered questions regarding the build integration of the piece, and this is why I have opened this bug - to dicsuss them with the community. I am putting Paul in CC to dicuss this with us, because he has helped us a lot with the SCM and Build so far. Please feel free to include whoever necessary in the loop.

Request for comments for what follows below:

- It is a valid usecase that someone will want to install this example to their IDE. Right now you can download an eclipse with the search console, and if you open the view, you'll see empty dropdowns and be able to do nothing with it. If we make the example installable, at least one can see what a simple contributor looks like in the UI. What's the way to achieve this?
How should we include the bundle in the central build?
In what feature should it be packed? Do we need a new feature, or is it feasible to reuse an existing one?
(My guess is that it is not the practice to include examples in the main feature of the integration build, so it should be separately installable.)

Also, Dani has created a developer guide for contributing to the search console:
https://bugs.eclipse.org/bugs/attachment.cgi?id=180106
We would like to use this bug to get ideas what is the best place to put this - eclipse.org , wiki, Git ...

Also, we will use this bug to track the necessary commits.

Cheers, Dimitar

Comment 1 Paul Webster

2010-11-29 08:29:25 EST

I would create the separate examples feature so you can include your examples plugin.  While you're at it, I would create a search master feature that you can add your features to (only the main feature and examples feature for now, until we sort out tests).

Then we'll have Andrew add your master feature to the main master feature, and that will give you control over adding your own features.

Other things that come to mind:

1) generate source plugins. I'll open another bug.

2) there are ways to provide eclipse examples/templates, like you can see on the welcome page ... I'm not sure how to do this, and we don't yet for other parts of e4

3) Documentation is definitely easier to maintain on the wiki at first.  Arguably the goal would be to create a .doc plugin in the end.

PW

Comment 2 Martina Galabova

2010-12-01 08:21:40 EST

Hi,

 The example plugin that Danail implemented was pushed to the central repository and added to new master feature.

Cheers,
Martina

Comment 3 Dimitar Georgiev

2011-07-11 13:00:17 EDT

(In reply to comment #2)
> Hi,
> 
>  The example plugin that Danail implemented was pushed to the central
> repository and added to new master feature.
> 
> Cheers,
> Martina

, but we somehow forgot to close the bug. I am closing it now.

Cheers, Dimitar