camel-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Claus Ibsen <claus.ib...@gmail.com>
Subject Re: [DISCUSS] - Thoughts on Apache Camel 2.18 and towards 3.0
Date Tue, 05 Apr 2016 06:00:47 GMT
Hi

The migration of the docs is already started with the components. We
are migrating them one by one which takes a rather long time to get
all done, but we do have a good start already.

Thee is docs in the src/doc folder of the components that has been
migrated, such as
https://github.com/apache/camel/blob/master/components/camel-ahc/src/main/docs/ahc.adoc

And a start of a website that put together all that docs at
https://github.com/apache/camel/tree/master/docs/user-manual/en

The latter is just very rough and certainly not set in stone.


The first goal is to get all the component docs migrated. Where it
grabs parts of the docs from the source code and auto maintain in the
.adoc files. So we ensure all the options are always 100% up to date.
We can then do the same for the EIPs as we can do for the docs. And as
well for data formats and languages. So all of them are always up to
date.

The actual look and feel of the website is not started yet. And yes I
do think the Apache Karaf team did a good job of a website make over,
at least on the front page. When you dive down then the docs is the
old style.






On Mon, Apr 4, 2016 at 6:57 PM, Matt Pavlovich <mattrpav@gmail.com> wrote:
>
>
> On 4/4/16 11:12 AM, Raul Kripalani wrote:
>>
>> On Mon, Apr 4, 2016 at 4:44 PM, Matt Pavlovich <mattrpav@gmail.com> wrote:
>>
>>> The current website looks the same as it did when it was created:
>>>>
>>>>
>>>> https://web.archive.org/web/20070701184530/http://activemq.apache.org/camel/
>>>>
>>> I thought the Karaf guys did a nice job on the website re-work. Is there
>>> a
>>> new base framework for all Apache projects, or are we at ground zero on
>>> this?
>>
>>
>> I dig the Karaf redesign - clean, modern and simple. I'd love to aim for
>> something similar in Camel.
>>
>> What do we do about our content editing system? My proposal is to move
>> away
>> from Confluence and adopt Markdown, AsciiDoc, or the like.
>>
>> Pros:
>>
>> 1. Docs can be versioned alongside code
>> 2. The HTML is purer and with less artifacts => accurate styling =>
>> cleaner
>> visuals.
>> 3. A breeze to edit, fix typos, add release notes, etc.
>>
>> Cons:
>>
>> 1. Large migration effort.
>
>
> I agree, a markdown-based CMS would be handy. Do we know what Karaf is
> using?
>
> Re Cons #1: I think the docs need a massive overhaul anyway. Probably a good
> time to just do it.
>
> The component config should be separated by version and not a hodge-podge of
> carve-outs like we have today.
>
> Rough pass at a TOC:
> (Suggest short and sweet)
> Index
> Documentation
> Download
> Support
>
> Then the sub-sections fall under the top level categories.
>
> Documentation
>    + Core
>    + Components
>    + Data Formats
>    + etc..
>
> Download
>     + Grab the bits
>     + Grab the source
>     + Links to svn / git etc
>
> Contributor Documentation
>     + Camel API
>     + etc..
>
> Support
>      + Community  ( IRC, mailing lists, LinkedIn Group, etc)
>      + Commercial
>
>
>
>>
>> Cheers,
>>
>> *Raúl Kripalani*
>> PMC & Committer @ Apache Ignite, Apache Camel | Integration, Big Data and
>> Messaging Engineer
>> http://about.me/raulkripalani | http://www.linkedin.com/in/raulkripalani
>> Blog: raul.io
>> <http://raul.io/?utm_source=email&utm_medium=email&utm_campaign=apache>
|
>> twitter: @raulvk <https://twitter.com/raulvk>
>>
>



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

Mime
View raw message