[mylyn-integrators] RE: [mylyn-dev] Documentation for Connector Developm

["Mik Kersten" <beatmik@xxxxxxx>]

The following page links all of our current resources for those interested
in building on Mylyn, including the useful resources linked by Eric:

  http://wiki.eclipse.org/index.php/Mylyn

The Mylyn Integrator Reference is most likely the main document that you are
after.  We will be making a pass at updating it (e.g. the references to
Mylar instead of Mylyn) after Friday's 2.1 release.

Our current strategy with documentation is to update the corresponding
documents once we change something (e.g. add to porting guide, if
significant new API add to Integrator Reference).  However, we have limited
development resources and have not been prioritizing documentation over
responding to integrators' API requests.  Since the documentation is easy
for others to contribute to, and since all of the source code to our
reference implementations is available (e.g. Bugzilla and Trac for
connectors) I think that it provides more benefit overall to keep
committers' resources focused on improving the framework and continue
encouraging community contributions for evolving the integrator
documentation.  What I've found to work well is when someone starts building
a connector that they capture the expertise that they build up by editing
the wiki.  We have an act now and apologize later approach to our wiki docs,
so please do not be shy in editing since it will all be reviewed for
correctness.

Mik

> -----Original Message-----
> From: mylyn-dev-bounces@xxxxxxxxxxx [mailto:mylyn-dev-
> bounces@xxxxxxxxxxx] On Behalf Of Eric Bresie
> Sent: Wednesday, September 26, 2007 6:51 AM
> To: Mylyn developer discussions
> Subject: Re: [mylyn-dev] Documentation for Connector Development
> 
> I may be answer part of my own question...
> 
> Was just noticing some additional complimentary source of information
> may be at the following sites:
> 
> http://wiki.eclipse.org/index.php/Mylyn_Extensions
> 
> Planning information :
> 
> http://wiki.eclipse.org/index.php/Mylyn_3.0_Plan
> 
> Architecture Information::
> 
> http://wiki.eclipse.org/Mylar_Architecture
> 
> Are there any UML or design information on Mylyn anywhere?
> 
> http://wiki.eclipse.org/Mylyn_Integrator_Reference
> http://wiki.eclipse.org/Mylar_Porting_Guide
> 
> Now to read up on this stuff..
> 
> Eric
> 
> 
> On 9/25/07, Ketan Padegaonkar <ketanpadegaonkar@xxxxxxxxx> wrote:
> >
> >
> > Eric Bresie wrote:
> > > Can anyone provide guidance, pointers, or any additional
> information
> > > on how one goes about developing a connector for Mylyn?
> > >
> > > What classes and interfaces need to be implemented for a given
> > > connector for instance?
> > >
> > > I'm suspecting reviewing an existing one is probably my best bet,
> so
> > > I'm guessing the cvs connector would be a good starting point.
> >
> > We've been looking at creating a mylyn connector for our project
> > management tools.
> >
> > With the lack of proper documentation around, things are a bit
> difficult
> > if not impossible in the mylyn world.
> >
> > I've got some suggestions on this front:
> > 1. Improve javadoc -- there's very little documentation around mylyn
> > API, after which I ended up looking at bugzilla to see how to create
> a
> > connector.
> > 2. Wiki pages - there's some documentation to get people started (It
> > definitely did help me get started -- but that's it)
> > 3. Articles (http://eclipse.org/articles) for developers so that they
> > could help create mylyn connectors.
> >
> > Any show of hands ?
> > I'd definitely like to contribute towards point #1, maybe point #3 as
> well.
> >
> > Any thoughts ?
> >
> > Cheers,
> > Ketan Padegaonkar
> > I blog... therefore I am... http://ketan.padegaonkar.name/
> >
> > If bankers can count, how come they have eight windows
> > and only four tellers?
> >
> >
> > _______________________________________________
> > mylyn-dev mailing list
> > mylyn-dev@xxxxxxxxxxx
> > https://dev.eclipse.org/mailman/listinfo/mylyn-dev
> >
> >
> >
> 
> 
> --
> Eric Bresie
> ebresie@xxxxxxxxx
> _______________________________________________
> mylyn-dev mailing list
> mylyn-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/mylyn-dev