flink-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Fabian Hueske <fhue...@gmail.com>
Subject Re: Web Page Issue
Date Tue, 27 Oct 2015 10:42:30 GMT
Hi Matthias,

thanks for taking care of this issue.
How about we change the menu completely, i.e., have menue entries for:

- Project Website
- Setup
  - Local
  - Cluster
  - Yarn
- DataSet API
  - Programming guide
  - transformations
- DataStream API
  - Programming Guide
- Internals

This is not a complete list, just what came to my mind right now.

Cheers,
Fabian

2015-10-27 3:39 GMT+01:00 Matthias J. Sax <mjsax@apache.org>:

> I started to work on this. Please see here:
> https://github.com/mjsax/flink/tree/flink-2752-webpage
>
> Basically, I just changed the color schema of the menu. I also remove
> "How to Contribute" and "Coding Guidelines" from "Internals".
>
> To get an even better separation, I would like to change the menu from
> the main web page, too.
>
>  - At least we should change the link of "Overview" which is not useful
> at all, right now (is it broken or intentionally?)
>  - I would also move "Quickstart" as sub-menu point of "Documentation"
>  - maybe we could move "Overview" as sub-menu point of "Documentation", too
>
> From my point of view, having a different menu structure and color
> should be good enough to make the distinction of both pages clear.
>
> Btw: the link "setup guide" in *Getting Started* section at the main
> page is broken... I would fix this together with those changes (if
> accepted).
>
> Please give feedback.
>
> -Matthias
>
> On 10/26/2015 10:40 AM, Maximilian Michels wrote:
> > Thanks Matthias for pointing this out. I opened an issue some time ago
> with
> > a similar description: https://issues.apache.org/jira/browse/FLINK-2752
> >
> > I agree with Fabian and Ufuk that it makes sense to separate the website
> > and the source repository. However, the distinction between the
> > documentation and the homepage should be more clear.
> >
> > On Mon, Oct 26, 2015 at 10:35 AM, Ufuk Celebi <uce@apache.org> wrote:
> >
> >>
> >>> On 26 Oct 2015, at 10:27, Fabian Hueske <fhueske@gmail.com> wrote:
> >>>
> >>> The website consists of two parts which are maintained in two separate
> >>> respositories:
> >>>
> >>> 1) The project website about features, community, etc.
> >>> 2) The documentation of the project
> >>>
> >>> We have the separation because we want to be able to update source and
> >>> documentation in one repository to avoid that the documentation gets
> out
> >> of
> >>> sync. The documentation is built every night and hosted at
> ci.apache.org
> >> to
> >>> achieve that.
> >>>
> >>> IMO, this separation makes sense, because the project website is not
> >>> changed very often whereas the documentation should be touched whenever
> >> the
> >>> API or behavior is changed. I think it is very important to have
> >>> documentation in sync with the code. In fact, I believe both parts of
> the
> >>> website should not be related to each other, so they shouldn't be a way
> >> to
> >>> have both parts getting out-of-sync, except for layout / design which
> is
> >>> nice to have but not crucial. We might even think about changing the
> >>> color-scheme of the documentation to make the difference more clear.
> >>
> >> Yes, Max pointed this out in the beginning. Let’s change the
> colors/design
> >> to make the distinction clear. The confusion comes from the fact that
> they
> >> look similar. It only makes sense to assume that they are hosted on the
> >> same web server etc. But as Fabian said, there are good reasons against
> it.
> >>
> >> – Ufuk
> >
>
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message