Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [mdt-papyrus.dev] Documentation for plugin in plugin

Extra-plugins can come with an installation guide, so it also makes sense to have the Documentation plug-in without having the plug-in

 

That was the case for example for the CSS Plug-in when it was still an extra-component, and it’s the case for CDO as well

 

It also gives more visibility to components when they are not installed

 

 

Camille

 

De : mdt-papyrus.dev-bounces@xxxxxxxxxxx [mailto:mdt-papyrus.dev-bounces@xxxxxxxxxxx] De la part de MAGGI Benoit
Envoyé : jeudi 18 décembre 2014 17:23
À : Papyrus Project list
Objet : [PROVENANCE INTERNET] [mdt-papyrus.dev] Documentation for plugin in plugin

 

Hi,

 

All documentation plugins are (or at least should )stored here :  org.eclipse.papyrus\plugins\doc\*.doc

 

My question is : Why don’t we keep the documentation in the plugin it describes ?

For example : org.eclipse.papyrus.infra.gmfdiag.common.doc should be included in org.eclipse.papyrus.infra.gmfdiag.common

 

I see these advantages :

-          Easier for a newcomer to find documentation when trying to add a feature

-          Easier to think of updating the doc when its already in the workspace

-          Easier to follow impact on documentation (same dependency tree as plugins)

-          Less plugins

-          Won’t miss documentation in the build when packaging an rcp or updating plugins

 

The only bad thing I see is that it won’t be any more possible to create a custom rcp without documentation but who will need that ?

 

Regards,

Benoit  


Back to the top