Tabs for Java/XML DSL in documentation

[Ruurtjan Pul <ru...@gmail.com>]

Hi dev team,

I've updated the documentation of one page so the example in java and xml
are shown in tabs in stead of below each other. This works in confluence,
but not on the main site:
https://cwiki.apache.org/confluence/display/CAMEL/Spark-rest
http://camel.apache.org/spark-rest.html

The js and css files are not included on the site. Showing the same example
for different DSL's in tabs makes the documentation clearer in my opinion.

Should we add the js and css files or should I revert the changes?

Best,
Ruurtjan

Re: Tabs for Java/XML DSL in documentation

[Ruurtjan Pul <ru...@gmail.com>]

Ok, so I've dug into the css and js of confluence. They're using AUI (
https://bitbucket.org/atlassian/aui) and jQuery. Including both frameworks
would be overkill for this feature... We could of course reverse engineer
and rewrite it, but I've not taken the time to do so.

Also: the current camel website uses an 8+ year old version of prototype.
Maybe it's about time to shift some effort from development to
documentation and invest in a new, responsive website ;)

Best,
Ruurtjan

On Thu, Dec 4, 2014 at 4:14 PM, Daniel Kulp <dk...@apache.org> wrote:

> If you can figure out the css/js things that we need to add, we can get
> them added to:
>
>
> https://svn.eu.apache.org/repos/infra/websites/production/camel/content/styles/
>
> which would hopefully allow it to work.
>
> Dan
>
>
>
> > On Dec 4, 2014, at 8:16 AM, Ruurtjan Pul <ru...@gmail.com> wrote:
> >
> > Hi dev team,
> >
> > I've updated the documentation of one page so the example in java and xml
> > are shown in tabs in stead of below each other. This works in confluence,
> > but not on the main site:
> > https://cwiki.apache.org/confluence/display/CAMEL/Spark-rest
> > http://camel.apache.org/spark-rest.html
> >
> > The js and css files are not included on the site. Showing the same
> example
> > for different DSL's in tabs makes the documentation clearer in my
> opinion.
> >
> > Should we add the js and css files or should I revert the changes?
> >
> > Best,
> > Ruurtjan
>
> --
> Daniel Kulp
> dkulp@apache.org - http://dankulp.com/blog
> Talend Community Coder - http://coders.talend.com
>
>

Re: Tabs for Java/XML DSL in documentation

[Daniel Kulp <dk...@apache.org>]

If you can figure out the css/js things that we need to add, we can get them added to:

https://svn.eu.apache.org/repos/infra/websites/production/camel/content/styles/

which would hopefully allow it to work.

Dan
 


> On Dec 4, 2014, at 8:16 AM, Ruurtjan Pul <ru...@gmail.com> wrote:
> 
> Hi dev team,
> 
> I've updated the documentation of one page so the example in java and xml
> are shown in tabs in stead of below each other. This works in confluence,
> but not on the main site:
> https://cwiki.apache.org/confluence/display/CAMEL/Spark-rest
> http://camel.apache.org/spark-rest.html
> 
> The js and css files are not included on the site. Showing the same example
> for different DSL's in tabs makes the documentation clearer in my opinion.
> 
> Should we add the js and css files or should I revert the changes?
> 
> Best,
> Ruurtjan

-- 
Daniel Kulp
dkulp@apache.org - http://dankulp.com/blog
Talend Community Coder - http://coders.talend.com

Re: Tabs for Java/XML DSL in documentation

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

Hi

The documentation is mainly viewed as static html, and there is a job
that exports from wiki.
And for that to work it has be be as before / simple.

Though in the future I would like to migrate documentation away from
confluence wiki, and let the components be self documented and
includes in the source code, eg for example readme.md files. And then
there is a lot of tools that can generate pdf / epub / html from
markdown / asciidoctor or whatnot. And .md files is already lovely to
view using github, so ppl can browse Camel component documentation the
usual github way.

But there is still a long road ahead until that is done.

On Thu, Dec 4, 2014 at 2:16 PM, Ruurtjan Pul <ru...@gmail.com> wrote:
> Hi dev team,
>
> I've updated the documentation of one page so the example in java and xml
> are shown in tabs in stead of below each other. This works in confluence,
> but not on the main site:
> https://cwiki.apache.org/confluence/display/CAMEL/Spark-rest
> http://camel.apache.org/spark-rest.html
>
> The js and css files are not included on the site. Showing the same example
> for different DSL's in tabs makes the documentation clearer in my opinion.
>
> Should we add the js and css files or should I revert the changes?
>
> Best,
> Ruurtjan



-- 
Claus Ibsen
-----------------
Red Hat, Inc.
Email: cibsen@redhat.com
Twitter: davsclaus
Blog: http://davsclaus.com
Author of Camel in Action: http://www.manning.com/ibsen
hawtio: http://hawt.io/
fabric8: http://fabric8.io/