More realistic examples in documentation

[Wolfram Huesken <wo...@m18.io>]

Hello together,

I'm using the documentation a lot at work for my current project. It's
extremely useful, but sometimes I find that essential parts are missing.
Here an example: 

http://camel.apache.org/producertemplate

There's no hint where to get the ProducerTemplate instance from. For
people who use the producer template for the first time, it would be
helpful to do something like this: 

Instead of:
ProducerTemplate template;

Do it like this: 
ProducerTemplate template =
exchange.getContext().createProducerTemplate();

I'm seeing this in quite some places and I'd like to change that, but
wanted to ask before if that's ok or if there are objections.

Bye
Wolfram

Re: More realistic examples in documentation

[Wolfram Huesken <wo...@m18.io>]

Ok, great. I already have edit permission, so I'll just update the
articles where I think we need more information. Don't worry, I don't
want to make the books obsolete by bloating the documentation ;-)

On Thu, Mar 17, 2016, at 07:52 AM, Claus Ibsen wrote:
> Hi
> 
> Yeah sure we love contributions
> http://camel.apache.org/contributing
> 
> Here is how you can edit the docs
> http://camel.apache.org/how-do-i-edit-the-website.html
> 
> And btw for better realistic examples then consider the Camel books
> which has a much higher documentation for getting people on board with
> Camel.
> http://camel.apache.org/books
> 
> 
> On Thu, Mar 17, 2016 at 7:49 AM, Wolfram Huesken <wo...@m18.io> wrote:
> > Hello together,
> >
> > I'm using the documentation a lot at work for my current project. It's
> > extremely useful, but sometimes I find that essential parts are missing.
> > Here an example:
> >
> > http://camel.apache.org/producertemplate
> >
> > There's no hint where to get the ProducerTemplate instance from. For
> > people who use the producer template for the first time, it would be
> > helpful to do something like this:
> >
> > Instead of:
> > ProducerTemplate template;
> >
> > Do it like this:
> > ProducerTemplate template =
> > exchange.getContext().createProducerTemplate();
> >
> > I'm seeing this in quite some places and I'd like to change that, but
> > wanted to ask before if that's ok or if there are objections.
> >
> > Bye
> > Wolfram
> 
> 
> 
> -- 
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2

Re: More realistic examples in documentation

[Claus Ibsen <cl...@gmail.com>]

Hi

Yeah sure we love contributions
http://camel.apache.org/contributing

Here is how you can edit the docs
http://camel.apache.org/how-do-i-edit-the-website.html

And btw for better realistic examples then consider the Camel books
which has a much higher documentation for getting people on board with
Camel.
http://camel.apache.org/books


On Thu, Mar 17, 2016 at 7:49 AM, Wolfram Huesken <wo...@m18.io> wrote:
> Hello together,
>
> I'm using the documentation a lot at work for my current project. It's
> extremely useful, but sometimes I find that essential parts are missing.
> Here an example:
>
> http://camel.apache.org/producertemplate
>
> There's no hint where to get the ProducerTemplate instance from. For
> people who use the producer template for the first time, it would be
> helpful to do something like this:
>
> Instead of:
> ProducerTemplate template;
>
> Do it like this:
> ProducerTemplate template =
> exchange.getContext().createProducerTemplate();
>
> I'm seeing this in quite some places and I'd like to change that, but
> wanted to ask before if that's ok or if there are objections.
>
> Bye
> Wolfram



-- 
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2