Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[dsdp-tm-dev] RE: discovery docs
Hi Javier,
 
thanks for checking.
 
Do you also get the Contexthelp as expected?
If you go to the "About" dialog, are all the about notices, copyrights etc. as expected?
In the ISV API Docs: Do you get hyperlinks into Platform docs and EMF Docs (e.g. on parameters and return values of your methods)?
Is the extension points doc converted as expected? (I did not take your static pages but have it auto-generated out of the *.exsd files)
 
When you browse through all the pages listed in the TOC of the ISV Docs, are there any empty pages?
Are there any hyperlinks pointing into nowhere?
 
In your ISV Doc "Guide" I'd recommend adding some hyperlinks from the explanations into the generated Javadoc.
Perhaps some of the guide is even to be obsoleted by the generated Javadoc?

Cheers,
--
Martin Oberhuber
Wind River Systems, Inc.
Target Management Project Lead, DSDP PMC Member
http://www.eclipse.org/dsdp/tm

 

From: javier.montalvoorus@xxxxxxxxxxx [mailto:javier.montalvoorus@xxxxxxxxxxx]
Sent: Monday, June 11, 2007 2:26 PM
To: Oberhuber, Martin
Subject: Re: discovery docs


Hi Martin,

I verified the documentation with the N-build and a new Eclipse 3.3 RC3 installation. Many thanks for adding the "Service Discovery API Reference" !

The documentation plugin is accessible with installing the N-build package in a clean Eclipse installation, then installing EMF allows accessing the stand-alone view, and installing the RSE end-user allows accessing the service discovery wizard as expected.

I have also seen that the plugins in the Europa update site are now signed. That's great !

Cheers,

Javier Montalvo Orús
Development Tools
Symbian Software Limited.


"Oberhuber, Martin" <Martin.Oberhuber@xxxxxxxxxxxxx>

11/06/2007 13:06

To
<javier.montalvoorus@xxxxxxxxxxx>
cc
Subject
Re: discovery docs





Hello Javier,
 
I think I got it all right and committed.
Please download and test discovery docs ASAP from
http://download.eclipse.org/dsdp/tm/downloads/drops/N20070611-0752/index.php
 

Cheers,
--
Martin Oberhuber
Wind River Systems, Inc.
Target Management Project Lead, DSDP PMC Member
http://www.eclipse.org/dsdp/tm



From: javier.montalvoorus@xxxxxxxxxxxx [mailto:javier.montalvoorus@xxxxxxxxxxx]
Sent: Friday, June 08, 2007 7:32 PM
To: Oberhuber, Martin
Subject: [dsdp-tm-dev] Re: discovery docs


Hi Martin,

I have open bug 191745 : "[discovery] Service Discovery wizard needs context help" and provided a patch for the user context help.
Also, here's the ISV documentation I have written in  "org.eclipse.tm.discovery.doc.isv":



It would be great if you could take a look at them and let me know if you think some parts should be more deeply explained.

Regards,

Javier Montalvo Orús
Development Tools
Symbian Software Limited.
----- Forwarded by Javier MontalvoOrus/UK/Symbian on 08/06/2007 18:23 -----
javier.montalvoorus@xxxxxxxxxxx
Sent by: dsdp-tm-dev-bounces@xxxxxxxxxxxx

07/06/2007 12:26

Please respond to
Target Management developer discussions <dsdp-tm-dev@xxxxxxxxxxx>


To
Martin Oberhuber <martin.oberhuber@xxxxxxxxxxxxx>
cc
Target Management developer discussions <dsdp-tm-dev@xxxxxxxxxxx>
Subject
[dsdp-tm-dev] Re: discovery docs








Hi Martin,

* For user documentation:
The discovery wizard pages can also be accessed from a non-RSE service discovery installation through the View "Service Discovery"->"Service Discovery Properties"
So I would prefer adding the user context menu in the plugin org.eclipse.tm...discovery.wizard so it can be accessed from the wizard view  as well as from the RSE wizard.

*For ISV documentation:
I have already created a org.eclipse.tm.discovery...doc.isv plugin and I'm currently working on the html documentation pages.
Do you want the list of new files to be added or do you prefer waiting until I finish the html docs ?

Cheers,

Javier Montalvo Orús
Development Tools
Symbian Software Limited.
Martin Oberhuber <martin.oberhuber@xxxxxxxxxxxxx>

07/06/2007 06:52


To
Javier Montalvo Orus <javier.montalvoorus@xxxxxxxxxxx>
cc
Target Management developer discussions <dsdp-tm-dev@xxxxxxxxxxx>
Subject
discovery docs









Hi Javier,

I thought about discovery docs, and I think:
* We do not need much user docs - Eclipse typically doesnt write too
many of them. What I'd like to see is some F1 context help for the rse
discovery integration (the wizard). The tm standalone component will
typically not be used as a tool by itself but rather be embedded into
products; then those products can copy userdocs from the rse integration
or write their own.
* To implement this, look at org.eclipse.rse.ui, plugin.xml and
HelpContexts.xml; and org.eclipse.rse.remotecdt for how to embed
userdocs into the rse guide. The docs shold be in existing plugin
org.eclipse.rse.discovery.
* For iSV docs, we'll need a new plugin -
org.eclipse.tm.discovery.doc.isv - you can either create this yourself
based on what you see for org.eclipse.rse.doc.isv or I can create it for
you. But I cannot do this before monday. At any rate, if you create it,
send a ZIP of it to me by monday morning so I can integrate it into the
build and mapfiles.

Any other opinions ? Thoughts?

Thanks,

--
Martin Oberhuber
Wind River Systems, Inc.
Target Management Project Lead, DSDP PMC Member
http://www.eclipse.org/dsdp/tm

********************************************************************** Symbian Software Ltd is a company registered in England and Wales with registered number 4190020 and registered office at 2-6 Boundary Row, Southwark, London, SE1 8HP, UK. This message is intended only for use by the named addressee and may contain privileged and/or confidential information. If you are not the named addressee you should not disseminate, copy or take any action in reliance on it. If you have received this message in error please notify postmaster@xxxxxxxxxxx and delete the message and any attachments accompanying it immediately. Neither Symbian nor any of its Affiliates accepts liability for any corruption, interception, amendment, tampering or viruses occurring to this message in transit or for any message sent by its employees which is not in compliance with Symbian corporate policy. ********************************************************************** _______________________________________________
dsdp-tm-dev mailing list
dsdp-tm-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/dsdp-tm-dev

********************************************************************** Symbian Software Ltd is a company registered in England and Wales with registered number 4190020 and registered office at 2-6 Boundary Row, Southwark, London, SE1 8HP, UK. This message is intended only for use by the named addressee and may contain privileged and/or confidential information. If you are not the named addressee you should not disseminate, copy or take any action in reliance on it. If you have received this message in error please notify postmaster@xxxxxxxxxxx and delete the message and any attachments accompanying it immediately. Neither Symbian nor any of its Affiliates accepts liability for any corruption, interception, amendment, tampering or viruses occurring to this message in transit or for any message sent by its employees which is not in compliance with Symbian corporate policy. **********************************************************************

********************************************************************** Symbian Software Ltd is a company registered in England and Wales with registered number 4190020 and registered office at 2-6 Boundary Row, Southwark, London, SE1 8HP, UK. This message is intended only for use by the named addressee and may contain privileged and/or confidential information. If you are not the named addressee you should not disseminate, copy or take any action in reliance on it. If you have received this message in error please notify postmaster@xxxxxxxxxxx and delete the message and any attachments accompanying it immediately. Neither Symbian nor any of its Affiliates accepts liability for any corruption, interception, amendment, tampering or viruses occurring to this message in transit or for any message sent by its employees which is not in compliance with Symbian corporate policy. **********************************************************************

Back to the top