Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.2.2, 1.3.1, 1.4.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      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 Krettek?

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          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):.


          Show
          githubbot ASF GitHub Bot added a comment - 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):.
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user uce opened a pull request:

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

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

          Backport of #4162 for the `release-1.3` branch.

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

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

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

          https://github.com/apache/flink/pull/4163.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 #4163



          Show
          githubbot ASF GitHub Bot added a comment - GitHub user uce opened a pull request: https://github.com/apache/flink/pull/4163 FLINK-6952 FLINK-6985 [docs] Add Javadocs links and remove bugfix version (1.3) Backport of #4162 for the `release-1.3` branch. You can merge this pull request into a Git repository by running: $ git pull https://github.com/uce/flink 6952-javadocs-release-1.3 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/4163.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 #4163
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user uce opened a pull request:

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

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

          Backport of #4162 for the `release-1.2` branch.

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

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

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

          https://github.com/apache/flink/pull/4164.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 #4164



          Show
          githubbot ASF GitHub Bot added a comment - GitHub user uce opened a pull request: https://github.com/apache/flink/pull/4164 FLINK-6952 FLINK-6985 [docs] Add Javadocs links and remove bugfix version (1.2) Backport of #4162 for the `release-1.2` branch. You can merge this pull request into a Git repository by running: $ git pull https://github.com/uce/flink 6952-javadocs-release-1.2 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/4164.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 #4164
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

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

          +1

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/4164 +1
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

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

          +1

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/4163 +1
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

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

          +1

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on the issue: https://github.com/apache/flink/pull/4162 +1
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/4162
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce closed the pull request at: https://github.com/apache/flink/pull/4163
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce closed the pull request at:

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

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce closed the pull request at: https://github.com/apache/flink/pull/4164
          Hide
          uce Ufuk Celebi added a comment -

          Fixed in bb7f08b (release-1.2), 5fa60c7 (release-1.3), e7c887c (master).

          Show
          uce Ufuk Celebi added a comment - Fixed in bb7f08b (release-1.2), 5fa60c7 (release-1.3), e7c887c (master).
          Hide
          aljoscha Aljoscha Krettek added a comment -

          Ufuk Celebi About scaladocs, I think they are still not built correctly and (more importantly) there is only Scaladocs for the Scala batch package and no docs for code written in Java.

          Show
          aljoscha Aljoscha Krettek added a comment - Ufuk Celebi About scaladocs, I think they are still not built correctly and (more importantly) there is only Scaladocs for the Scala batch package and no docs for code written in Java.

            People

            • Assignee:
              uce Ufuk Celebi
              Reporter:
              uce Ufuk Celebi
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development