Hi Aljoscha,

I think it should not be too difficult to have different menu layouts for
the different versions of the website documentation. However, this would
make the documentation even more complicated.

I'm also unhappy with the current setup of the documentation. The
maintenance is quite time-consuming, so I'm happy if you come up with a
simpler approach.

I agree with having a self contained documentation. This would also allow
us to make it part of the release votes and ship it with the binary
releases.


I think it would be fine to just hardcode a link to
flink.incubator.apache.org into the standalone documentation.


Robert



On Fri, Sep 19, 2014 at 9:45 AM, Aljoscha Krettek <[email protected]>
wrote:

> Hi,
> I'm right now rewriting the documentation to unify the Java API/Scala
> API parts with tabs to switch between language (mentioned that before,
> I know. :D).
>
> The problem is now that the doc is very tightly integrated into the
> website. For example, the sidebar of links is part of the website.
> (The self contained doc also has the sidebar of links, but if you look
> closely you will notice it's slightly different.) It is the same for
> the 0.6 doc and the 0.7 doc, which doesn't work well when those two
> docs have different pages with differing names.
>
> Would it not be easier to make the documentation completely self
> contained (as it already is) and copy the built files into the
> website's doc folder. The website would then just have links to the
> documentation for the separate versions.
>
> The problem would then be that the documentation doesn't share the
> same header as the website anymore. I don't see this as a problem, we
> could even move the documentation navigation into the header and out
> of the sidebar. Some people might object though.
>
> What do you think? How should we handle this?
>
> Cheers,
> Aljoscha
>

Reply via email to