flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-2752) Documentation is not easily differentiable from the Flink homepage
Date Tue, 03 Nov 2015 13:30:27 GMT

    [ https://issues.apache.org/jira/browse/FLINK-2752?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14987270#comment-14987270

ASF GitHub Bot commented on FLINK-2752:

Github user mxm commented on a diff in the pull request:

    --- Diff: docs/internals/coding_guidelines.md ---
    @@ -1,23 +0,0 @@
    -title:  "Coding Guidelines"
    -Licensed to the Apache Software Foundation (ASF) under one
    -or more contributor license agreements.  See the NOTICE file
    -distributed with this work for additional information
    -regarding copyright ownership.  The ASF licenses this file
    -to you under the Apache License, Version 2.0 (the
    -"License"); you may not use this file except in compliance
    -with the License.  You may obtain a copy of the License at
    -  http://www.apache.org/licenses/LICENSE-2.0
    -Unless required by applicable law or agreed to in writing,
    -software distributed under the License is distributed on an
    -KIND, either express or implied.  See the License for the
    -specific language governing permissions and limitations
    -under the License.
    -The *Coding Guidelines* are located [on the project website](http://flink.apache.org/coding-guidelines.html).
    --- End diff --
    Yes. Using meta refresh? Why not.

> Documentation is not easily differentiable from the Flink homepage
> ------------------------------------------------------------------
>                 Key: FLINK-2752
>                 URL: https://issues.apache.org/jira/browse/FLINK-2752
>             Project: Flink
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 0.9, 0.10
>            Reporter: Maximilian Michels
>            Assignee: Matthias J. Sax
>            Priority: Minor
>              Labels: starter
>             Fix For: 0.9, 0.10
> When users go to the documentation, either via the homepage's quickstart menu or the
documentation menu, the transition to the documentation is not easily noticeable; the layout
of both pages are pretty much the same. There should be a hint in the documentation page "Flink
documentation version X. Click here to go back to the homepage" or something similar.

This message was sent by Atlassian JIRA

View raw message