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-6952) Add link to Javadocs
Date Thu, 22 Jun 2017 09:46:00 GMT

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

ASF GitHub Bot commented on FLINK-6952:
---------------------------------------

GitHub user uce opened a pull request:

    https://github.com/apache/flink/pull/4162

    [FLINK-6952] [FLINK-6985] [docs] Add Javadocs links and remove bugfix version

    Adds a link to the Javadocs in the left side navigation:
    
    ![screen shot 2017-06-20 at 11 46 38](https://user-images.githubusercontent.com/1756620/27427607-e200a3f4-573f-11e7-84ed-51b610c79fe1.png)
    
    Makes sure that the title and other places that reference the Flink release version, only
point to the minor release version (e.g. `1.3`). For snapshot release, we display the full
version.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/uce/flink 6952-javadocs

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/4162.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #4162
    
----
commit 15752faf7059fd580d5da9da024a82e07209b879
Author: Ufuk Celebi <uce@apache.org>
Date:   2017-06-20T10:19:07Z

    [FLINK-6952] [docs] Add link to Javadocs

commit 151c13c9c33282493cb0d6ec6266f316e615ac26
Author: Ufuk Celebi <uce@apache.org>
Date:   2017-06-22T09:37:54Z

    [FLINK-6985] [docs] Remove bugfix version from title
    
    Removes the bugfix version from title and other places where it
    can potentially be confusing.
    
    For snapshot release, version and version_short should be the
    same, e.g. 1.4-SNAPSHOT. For stable releases, version should be
    the full version string (e.g. 1.2.1) whereas version_short
    should skip the bugfix version (e.g. 1.2):.

----


> Add link to Javadocs
> --------------------
>
>                 Key: FLINK-6952
>                 URL: https://issues.apache.org/jira/browse/FLINK-6952
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Ufuk Celebi
>            Assignee: Ufuk Celebi
>            Priority: Minor
>
> The project webpage and the docs are missing links to the Javadocs.
> I think we should add them as part of the external links at the bottom of the doc navigation
(above "Project Page").
> In the same manner we could add a link to the Scaladocs, but if I remember correctly
there was a problem with the build of the Scaladocs. Correct, [~aljoscha]?



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message