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

Breakpoints on documentation website

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Trivial
    • Resolution: Implemented
    • Affects Version/s: 1.2.0
    • Fix Version/s: 1.3.0, 1.4.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      When reading the documentation website, I'm finding that unless I have the browser window fully maximised, the content is formatted in the narrow layout.

      See https://ci.apache.org/projects/flink/flink-docs-release-1.2/

      Expected behaviour:
      The content should flow on the right-hand-side of the menu.

      Actual behaviour
      The menu is the full width of the window and the content flows below the menu.

      Notes
      Any width below 1200px causes the content to be placed below the full width menu. This 2/3 the width of my laptop screen.

      I would suggest making this smaller and consistent with the main project page (http://flink.apache.org/) which has the breakpoint set to about 840px.

        Issue Links

          Activity

          Hide
          StephanEwen Stephan Ewen added a comment -

          +1, good idea

          Show
          StephanEwen Stephan Ewen added a comment - +1, good idea
          Hide
          StephanEwen Stephan Ewen added a comment -
          Show
          StephanEwen Stephan Ewen added a comment - /cc Ufuk Celebi David Anderson
          Hide
          uce Ufuk Celebi added a comment -

          Thanks for reporting this Colin Breame. I fully agree. Do you want to contribute a fix? If you don't have time, I will look into this myself, just ping me here.

          The docs are part of the source code in the /docs directory. The CSS files are in /docs/page/css. Bootstrap is loaded in docs/_layouts/base.html from the Bootstrap CDN. So I think we need to overwrite the breakpoints (if possible) in our CSS files or make a custom Bootstrap installation part of the docs setup.

          Show
          uce Ufuk Celebi added a comment - Thanks for reporting this Colin Breame . I fully agree. Do you want to contribute a fix? If you don't have time, I will look into this myself, just ping me here. The docs are part of the source code in the /docs directory. The CSS files are in /docs/page/css . Bootstrap is loaded in docs/_layouts/base.html from the Bootstrap CDN. So I think we need to overwrite the breakpoints (if possible) in our CSS files or make a custom Bootstrap installation part of the docs setup.
          Hide
          colinbreame Colin Breame added a comment -

          Ufuk Celebi I'll take a look at the weekend

          Show
          colinbreame Colin Breame added a comment - Ufuk Celebi I'll take a look at the weekend
          Hide
          uce Ufuk Celebi added a comment -

          Colin Breame Did you have time to look into it?

          Show
          uce Ufuk Celebi added a comment - Colin Breame Did you have time to look into it?
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-5742 allow docs sidebar nav to work below 1200px

          The breakpoints for the docs move the content below the sidebar navigation for widths below 1200px, which is frequently annoying. Getting this down to 992px was relatively straightforward, but going much lower would require something of a redesign, in my opinion (the navigation is designed to be about 260px wide, and isn't easily shrunk).

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

          $ git pull https://github.com/alpinegizmo/flink 5742-breakpoints-for-docs

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

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


          commit 7b3fd152626f6f3fdff0d13f478c3a859b8985d8
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-05-04T11:51:36Z

          FLINK-5742 allow sidenav to work for widths down to 992


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3821 FLINK-5742 allow docs sidebar nav to work below 1200px The breakpoints for the docs move the content below the sidebar navigation for widths below 1200px, which is frequently annoying. Getting this down to 992px was relatively straightforward, but going much lower would require something of a redesign, in my opinion (the navigation is designed to be about 260px wide, and isn't easily shrunk). You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink 5742-breakpoints-for-docs Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3821.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 #3821 commit 7b3fd152626f6f3fdff0d13f478c3a859b8985d8 Author: David Anderson <david@alpinegizmo.com> Date: 2017-05-04T11:51:36Z FLINK-5742 allow sidenav to work for widths down to 992
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user greghogan commented on the issue:

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

          @alpinegizmo nice fix! Merging ...

          Show
          githubbot ASF GitHub Bot added a comment - Github user greghogan commented on the issue: https://github.com/apache/flink/pull/3821 @alpinegizmo nice fix! Merging ...
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

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

          master: a1ec761628051ad5dd04ea469f1a23b07b99ea70
          release-1.3: 21961481e6fd53f001158b1348f9ff8ea7eab4a3

          Show
          greghogan Greg Hogan added a comment - master: a1ec761628051ad5dd04ea469f1a23b07b99ea70 release-1.3: 21961481e6fd53f001158b1348f9ff8ea7eab4a3

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development