Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-5575

in old releases, warn users and guide them to the latest stable docs

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.0.4, 1.2.0, 1.3.0, 1.1.5
    • Component/s: Documentation
    • Labels:
      None

      Description

      Old versions of Flink (especially version 0.8) are being frequently studied, downloaded, and used by new users (because google leads them there). I propose to guide folks to the latest stable release by adding a link on every documentation page in the old docs that links to the home page of the latest stable docs.

      The redirect lives at flink.apache.org/q/stable-docs.html, and will need to be modified with each major release (e.g. when 1.2 is released).

      This problem affects all releases before 1.1, but the stats show that 0.8, 0.9, 0.10, and 1.0 are the most important to deal with.

        Issue Links

          Activity

          Hide
          StephanEwen Stephan Ewen added a comment -

          +1 to that

          Show
          StephanEwen Stephan Ewen added a comment - +1 to that
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-5575[docs] in old releases, warn users and guide them to the …

          …latest stable docs

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

          $ git pull https://github.com/alpinegizmo/flink release-0.8

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

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


          commit 619544336d201373a05e1750470ed31a9a10a3fb
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-01-20T10:41:00Z

          FLINK-5575[docs] in old releases, warn users and guide them to the latest stable docs


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3238 FLINK-5575 [docs] in old releases, warn users and guide them to the … …latest stable docs You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink release-0.8 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3238.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 #3238 commit 619544336d201373a05e1750470ed31a9a10a3fb Author: David Anderson <david@alpinegizmo.com> Date: 2017-01-20T10:41:00Z FLINK-5575 [docs] in old releases, warn users and guide them to the latest stable docs
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-5575[docs] in old releases, warn users and guide them to the …

          …latest stable docs

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

          $ git pull https://github.com/alpinegizmo/flink release-0.9

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

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


          commit 41a96f5d2fee337de3c8b81b170775eb8044b4bf
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-01-30T15:20:06Z

          FLINK-5575[docs] in old releases, warn users and guide them to the latest stable docs


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3239 FLINK-5575 [docs] in old releases, warn users and guide them to the … …latest stable docs You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink release-0.9 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3239.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 #3239 commit 41a96f5d2fee337de3c8b81b170775eb8044b4bf Author: David Anderson <david@alpinegizmo.com> Date: 2017-01-30T15:20:06Z FLINK-5575 [docs] in old releases, warn users and guide them to the latest stable docs
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-5575[docs] in old releases, warn users and guide them to the …

          …latest stable docs

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

          $ git pull https://github.com/alpinegizmo/flink release-0.10

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

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


          commit 7ed95c3a7871706094a71942ade67a367dd3963d
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-01-30T15:24:00Z

          FLINK-5575[docs] in old releases, warn users and guide them to the latest stable docs


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3240 FLINK-5575 [docs] in old releases, warn users and guide them to the … …latest stable docs You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink release-0.10 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3240.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 #3240 commit 7ed95c3a7871706094a71942ade67a367dd3963d Author: David Anderson <david@alpinegizmo.com> Date: 2017-01-30T15:24:00Z FLINK-5575 [docs] in old releases, warn users and guide them to the latest stable docs
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-5575[docs] in old releases, warn users and guide them to the …

          …latest stable docs

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

          $ git pull https://github.com/alpinegizmo/flink release-1.0

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

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


          commit a9d9782adce2ad51f104b766bc06811ca0f03c14
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-01-31T13:50:43Z

          FLINK-5575[docs] in old releases, warn users and guide them to the latest stable docs


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3241 FLINK-5575 [docs] in old releases, warn users and guide them to the … …latest stable docs You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink release-1.0 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3241.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 #3241 commit a9d9782adce2ad51f104b766bc06811ca0f03c14 Author: David Anderson <david@alpinegizmo.com> Date: 2017-01-31T13:50:43Z FLINK-5575 [docs] in old releases, warn users and guide them to the latest stable docs
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-5575[docs] reworked the mechanism that warns users about …

          …newer docs so that only the most recent out-of-date release has to be updated when a new release is made available.

          Defining latest_stable_url wasn't a very scalable approach, since this value would have to be updated in every old release. This has been replaced with a redirect from flink.apache.org/q/stable-docs.html.

          It would make sense to merge this PR into the release-1.2 branch, though it isn't strictly necessary.

          Also, release-1.1 will need to be updated when 1.2 is released.

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

          $ git pull https://github.com/alpinegizmo/flink old-doc-warning

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

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


          commit dcf9b96205c604cb2665d1e9bf6ed1d5897910ad
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-01-31T14:15:15Z

          FLINK-5575[docs] reworked the mechanism that warns users about newer docs so that only the most recent out-of-date release has to be updated when a new release is available


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3242 FLINK-5575 [docs] reworked the mechanism that warns users about … …newer docs so that only the most recent out-of-date release has to be updated when a new release is made available. Defining latest_stable_url wasn't a very scalable approach, since this value would have to be updated in every old release. This has been replaced with a redirect from flink.apache.org/q/stable-docs.html. It would make sense to merge this PR into the release-1.2 branch, though it isn't strictly necessary. Also, release-1.1 will need to be updated when 1.2 is released. You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink old-doc-warning Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3242.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 #3242 commit dcf9b96205c604cb2665d1e9bf6ed1d5897910ad Author: David Anderson <david@alpinegizmo.com> Date: 2017-01-31T14:15:15Z FLINK-5575 [docs] reworked the mechanism that warns users about newer docs so that only the most recent out-of-date release has to be updated when a new release is available
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

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

          Good addition. Could you post a screenshot of how this looks now?

          Given that we are very unlikely to provide any fixes for older versions than 1.0.0, I would vote to simply redirect to the latest stable version instead of still hosting the docs for those versions; especially because the docs before 1.0.0 are in very bad shape. If any user is interested in those docs, it's possible to check out the source code and manually build them. What do you think?

          @rmetzger Would it be possible to have a redirect via the `ci` infra?

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3242 Good addition. Could you post a screenshot of how this looks now? Given that we are very unlikely to provide any fixes for older versions than 1.0.0, I would vote to simply redirect to the latest stable version instead of still hosting the docs for those versions; especially because the docs before 1.0.0 are in very bad shape. If any user is interested in those docs, it's possible to check out the source code and manually build them. What do you think? @rmetzger Would it be possible to have a redirect via the `ci` infra?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user alpinegizmo commented on the issue:

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

          @uce I tried to choose styling that looks decent with all previous releases. Here's a screenshot against 1.0.
          ![old-release-warning](https://cloud.githubusercontent.com/assets/43608/22600510/1ef86282-ea3b-11e6-8fea-853e317a08e9.png)

          Show
          githubbot ASF GitHub Bot added a comment - Github user alpinegizmo commented on the issue: https://github.com/apache/flink/pull/3242 @uce I tried to choose styling that looks decent with all previous releases. Here's a screenshot against 1.0. ! [old-release-warning] ( https://cloud.githubusercontent.com/assets/43608/22600510/1ef86282-ea3b-11e6-8fea-853e317a08e9.png )
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user alpinegizmo commented on the issue:

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

          @uce Some old releases still have strong google power – especially 0.8. I don't know if replacing those pages with a redirect will cause the page rank to plummet or not.

          Show
          githubbot ASF GitHub Bot added a comment - Github user alpinegizmo commented on the issue: https://github.com/apache/flink/pull/3242 @uce Some old releases still have strong google power – especially 0.8. I don't know if replacing those pages with a redirect will cause the page rank to plummet or not.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

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

          Looks very nice. +1 to the design.

          Let's merge this as is and decide whether we remove the older pages later then.

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3242 Looks very nice. +1 to the design. Let's merge this as is and decide whether we remove the older pages later then.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

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

          Merging this with the other PRs.

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3242 Merging this with the other PRs.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

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

          Could you please close this PR manually? Bot closing only works for the master branch.

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3241 Could you please close this PR manually? Bot closing only works for the master branch.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

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

          Could you please close this PR manually? Bot closing only works for the master branch.

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3240 Could you please close this PR manually? Bot closing only works for the master branch.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

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

          Could you please close this PR manually? Bot closing only works for the master branch.

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3239 Could you please close this PR manually? Bot closing only works for the master branch.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user uce commented on the issue:

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

          Could you please close this PR manually? Bot closing only works for the master branch.

          Show
          githubbot ASF GitHub Bot added a comment - Github user uce commented on the issue: https://github.com/apache/flink/pull/3238 Could you please close this PR manually? Bot closing only works for the master branch.
          Hide
          uce Ufuk Celebi added a comment -

          Fixed in dd7311e (master), 6986f49 (release-1.2), 3cd7c8e (release-1.1), 63660ca (release-1.0), 43f8261 (release-0.10), 3ea8ae3 (release-0.9), f6f823e (release-0.8).

          Show
          uce Ufuk Celebi added a comment - Fixed in dd7311e (master), 6986f49 (release-1.2), 3cd7c8e (release-1.1), 63660ca (release-1.0), 43f8261 (release-0.10), 3ea8ae3 (release-0.9), f6f823e (release-0.8).
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

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

          Github user alpinegizmo closed the pull request at:

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

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

          Github user alpinegizmo closed the pull request at:

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

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

          Github user alpinegizmo closed the pull request at:

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

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

          Github user alpinegizmo closed the pull request at:

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

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

            People

            • Assignee:
              alpinegizmo David Anderson
              Reporter:
              alpinegizmo David Anderson
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development