Hi Claus,

Responses inline.

Regards,

*Raúl Kripalani*
Enterprise Architect, Open Source Integration specialist, Program
Manager | Apache
Camel Committer
http://about.me/raulkripalani | http://www.linkedin.com/in/raulkripalani
http://blog.raulkr.net | twitter: @raulvk

On Mon, Mar 25, 2013 at 4:43 PM, Claus Ibsen <claus.ib...@gmail.com> wrote:

> On Sun, Mar 24, 2013 at 5:23 PM, Henryk Konsek <hekon...@gmail.com> wrote:
> >> We already have a removeHeaders() DSL [1]
> >
> > Wow, indeed we got it. :)
> >
> > We definitely need to improve our documentation in this regards. I
> > feel pretty familiar with Camel wiki and haven't notice this one :) .
> > I guess that the majority of our users don't know about removeHeaders
> > option as well.
> >
> > I'll try to edit wiki to make this option more visible. Not sure when
> however.
> >
>
> 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 could enhance this javadoc and add more links to more details at
> the Camel web site. For example in the case of removeHeader DSL we
> could refer to these FAQ's etc.
>

You're just asking for broken links in the Javadocs! We can't guarantee
that a FAQ entry will be alive for the lifetime of a Camel release in the
Maven repos, i.e. forever.

IMHO we should focus on restructuring the website (see below). Let's fix
the base problem instead of patching here and there and creating a jumble
of unmaintainable links throughout time.

Improving docs is always appreciated. For example at any time fell
> free to add FAQ entries for stuff that you feel is good knowledge for
> others.


I beg to differ. FAQ-centric documentation is hell for everyone:
committers, users, evaluators, newbies, etc. Imagine if Wikipedia was a
collection of a bunch of questions like "When was the GMT timezone
created?", "How tall can a Giraffe be?", etc. You get me.

We need better documentation structure. I shared some ideas on overhauling
component pages in May 2012 [1] - before I became a committer. But the need
for a modern website keeps haunting me time after time, as I see other
sites like Apache Cordova [2], Apache Shiro [3], etc. Even the Apache ODE
project [4] – which hasn't seen a release in 2 years – has a refurbished
website!

All in all: new website, new documentation structure.

I guess I'm asking to reignite the discussion here: [5].

[1]
http://camel.465427.n5.nabble.com/Improving-the-Documentation-Articles-Presentations-etc-tp5711559p5713170.html
[2] http://cordova.apache.org/
[3] http://shiro.apache.org/
[4] http://ode.apache.org/
[5] http://camel.apache.org/site-update-ideas.html


>
> --
> Claus Ibsen
> -----------------
> Red Hat, Inc.
> FuseSource is now part of Red Hat
> Email: cib...@redhat.com
> Web: http://fusesource.com
> Twitter: davsclaus
> Blog: http://davsclaus.com
> Author of Camel in Action: http://www.manning.com/ibsen
>

Reply via email to