Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 205343 - [web connector] stabilize name for web repository connector
Summary: [web connector] stabilize name for web repository connector
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: unspecified   Edit
Hardware: PC All
: P4 trivial (vote)
Target Milestone: 3.0   Edit
Assignee: Mik Kersten CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-10-03 15:19 EDT by Eugene Kuleshov CLA
Modified: 2008-06-12 18:02 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Eugene Kuleshov CLA 2007-10-03 15:19:59 EDT
Name for the web repository connector need to be stabilized and used consistently across the project. For example:

- On repository wizard it is called "generic web-based access" (reminds me "excel" or "ms word")
- On corresponding feature it is called "Mylyn Connector: Generic Issue Tracker (Advanced)"

I think more meaningful name would be something along the lines of "Web-based Repository Connector", "Generic Web Connector" or "Generic Web Repository Connector"
Comment 1 Mik Kersten CLA 2007-10-26 02:02:16 EDT
Agreed. I wish we could come up with a short name that communicates what it is, but this is a tricky problem.  Most connectors are named by what they connect to, so in terms of the way it shows in the UI, I think that it should be along the lines of:

  Generic Issue Tracker (Advanced)
  
When referring to it we would then say "Mylyn Generic Issue Tracker Connector".  I prefer that to "Generic Web.." because it's more concreate.  Thoughts?
Comment 2 Eugene Kuleshov CLA 2007-10-26 02:06:02 EDT
IMHO, "Generic Issue Tracker" is too generic and it doesn't say "web".
Comment 3 Mik Kersten CLA 2008-03-07 19:23:01 EST
Brainstorming from our call:
* Generic Web Connector
* Generic Issue Tracker
* Generic Web-based Access

The favorite so far:
* Mylyn Connector: Web Template

Comment 4 Eugene Kuleshov CLA 2008-05-30 03:51:25 EDT
Any update on this?
Comment 5 Mik Kersten CLA 2008-06-02 16:58:53 EDT
My favorite so far is still the same as per comment#3.  But looking at it with all the others I think it's better to make it plural, making the full name and standard incubation label be:

	Mylyn Connector: Web Templates (Incubation)
	
How does that sound?
Comment 6 Eugene Kuleshov CLA 2008-06-02 17:34:21 EDT
(In reply to comment #5)
> I think it's better to make it plural
> making the full name and standard incubation label be:
> 
>         Mylyn Connector: Web Templates (Incubation)
> 
> How does that sound?

It sound odd. You don't call other connectors "Bugzillas", "Tracks", "JIRAs" and "Tasktops" :)

I also don't recall "Mylyn Connector", neither (Incubator) shown in the connector selections available in Mylyn UI. The example you shown look more like feature text from the update site. 

Anyways, I am fine with anything, as long it is consistent with other connectors names shown in connector selection UI in Mylyn, i.e. new Repository wizard.
Comment 7 Steffen Pingel CLA 2008-06-03 03:53:25 EDT
+1 for "Mylyn Connector: Web Template"

Singular will work nicely in the repository selection dialog.
Comment 8 Mik Kersten CLA 2008-06-03 12:55:52 EDT
Sorry, yes, the formatting I was using was for the feature name as it shows in the update site.

The choice of plural was intentional, because the main difference between this connector and others is that instead of supporting connectivity to 1 repository, it provides templates for connectivity to n different repositories.  For adding the repository I agree that the name should be singular.  This gives us the following for the wizard:

	Web Template (Advanced)

And the following for the feature's name: 

	Mylyn Connector: Web Templates (Incubation)
	
How does that sound?

---------------
As a side note, I think that it's important to continue to include "(Advanced)" in order to set the user's expectation.  I have been wondering if instead we should consider including the protocol used by connectors, similar to how email tools do it.  This will surface a bit too much implementation detail, but can also help set expectations and assist in debugging.  For example, users of JIRA would see "JIRA (SOAP)" whereas users of Bugzilla would see something like "Bugzilla (REST/XML)".
Comment 9 Eugene Kuleshov CLA 2008-06-03 14:12:11 EDT
Singular still better and it matches the repository selection

BTW, jira is using soap and xml/rpc and html screenscraping/post. That doesn't seem useful details for the end users. Also, most of connectors are using some form of http.
Comment 10 Mik Kersten CLA 2008-06-12 18:02:50 EDT
The name has now stabilized.  In the UI it appears as the singular "Web Template".