camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From James Strachan <james.strac...@gmail.com>
Subject Re: 3.0 Ideas
Date Wed, 27 Mar 2013 07:26:04 GMT
On 27 March 2013 07:03, Claus Ibsen <claus.ibsen@gmail.com> wrote:
> On Tue, Mar 26, 2013 at 5:15 PM, Henryk Konsek <hekonsek@gmail.com> wrote:
>>>> Do you guys read the javadoc of the Java DSL? We have java doc on the
>>>> DSL where we provide a little information.
>>> I know you aren't referring to me, but I'm sure that all dev@ posters have
>>> read the Javadocs ;)
>>
>> We want users to learn about DSL from Javadoc? IMHO reference
>> documentation should serve as the base knowledge hub.
>>
>
> The javadoc allows users to in a standard way to get documentation
> about the Java DSL they use.
> We already have that.
>
> As an example if you use removeHeaders, then check its javadoc. There
> was a hint about a pattern, so you can remove multiple headers.
>
> What we can do is to take a look on the javadoc, and improve where
> there is gaps. And add links to the EIP page, as well refer to a FAQ
> if there is a common "thing" about this DSL that is good to know (eg
> we refer to the getIn vs getOut FAQ)
>
>>> FAQ-centric documentation is hell for everyone:
>>
>> +1
>>
>
> No FAQ is great. Its common questions.
>
> Again a FAQ should most often not be the single resource of the
> information. But have a description, and point your to links for
> further material, eg where the actual information is.
>
> Of course a FAQ like, can just be without further links
> http://camel.apache.org/can-i-use-camel-on-java-14.html
>
> But a better FAQ has references to other pages
> http://camel.apache.org/how-do-i-debug-my-route.html

FAQs are also great for search engines :)

--
James
-------
Red Hat

Email: jstracha@redhat.com
Web: http://fusesource.com
Twitter: jstrachan, fusenews
Blog: http://macstrac.blogspot.com/

Open Source Integration

Mime
View raw message