Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[ecf-dev] Better ECF documentation (Re: ECF Feature Restructuring)

On 12/04/2013 02:12 PM, "Pablo García Sánchez" <fergunet@xxxxxxxxx>" wrote:
> Hi guys. I would suggest centralize all tutorials and information in the
> Integrator's Guide [1] or publicity this wiki more. There are several
> tutorials in Scott's blog or other webs [2], but I think that the
> "official" source of documentation should be the wiki, and newcomers
> should find the wiki easy to find and navigate. For example, a link to
> [2] from [1].
> 
> Some clarification should be performed. For example. which tutorial
> should be used to start: [3] or [4]? Also, some pending subsections
> should be redacted (the ones in red in [1]).
> 
> Also, if you enter in the ECF main page [5] you see the "Getting Started
> Thing" [6] with some comments, and then an user enters in the ECF wiki,
> but the first thing that sees is the conference calls info. New users
> need to move to "New Stuff" section with a lot of unordered issues to
> find the Integrator's Guide.
> 
> Finally, some interesting sections (such as [7]) are not located in a
> visible part of the web (for example, the EIG does not include a link to
> [7]).
> 
> [1] https://wiki.eclipse.org/EIG:Integrators_Guide
> [2] http://www.eclipse.org/community/eclipse_newsletter/2013/july/article3.php
> [3] https://wiki.eclipse.org/EIG:Remoting
> [4] https://wiki.eclipse.org/EIG:Getting_Started_with_OSGi_Remote_Services
> [5] http://www.eclipse.org/ecf/
> [6] http://www.eclipse.org/ecf/gettingStarted.php
> [7] http://wiki.eclipse.org/SOAP-based_Providers
> 
> Summarizing, there are a lot of information about how to use ECF, but it
> is a bit disorganized and difficult to find.

Hi Pablo,

you are absolutely right that most of ECF's documentation is scattered
around the place and that it hinders adoption. Would you be willing to
help us to clean up/restructure the wiki (after all its editable by
everybody with an EF account)?

Btw. with sufficient resources, we would also be happy to re-design the
ECF website which doesn't exactly follow today's style in website design.

Thanks
Markus


Back to the top