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

Documentation: 'MacOS X' under 'Download and Start Flink' in Quickstart page is not rendered correctly

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 1.2.0
    • Fix Version/s: 1.3.0, 1.2.1
    • Component/s: Documentation
    • Labels:
      None

      Description

      On https://ci.apache.org/projects/flink/flink-docs-release-1.2/quickstart/setup_quickstart.html#setup-download-and-start-flink , command lines in "MacOS X" part are not rendered correctly.

      This is because the markdown is misformatted - it doesn't leave a blank line between text and code block.

      So the fix is simple - add a blank line between text and code block.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user phoenixjiangnan opened a pull request:

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

          FLINK-6002 'MacOS X' section in Quickstart page is not rendered correctly

          Currently, ["MacOS X" section under "Setup: Download and Start Flink" in Quickstart page](https://ci.apache.org/projects/flink/flink-docs-release-1.2/quickstart/setup_quickstart.html#setup-download-and-start-flink) is not rendered correctly.
          ![before](https://cloud.githubusercontent.com/assets/1892692/23719173/28a8daaa-03ef-11e7-9663-26486723c652.png)

          I fixed this markdown issue by simply adding a blank line between text paragraph and code block.

          Now it looks like this:
          ![after](https://cloud.githubusercontent.com/assets/1892692/23719258/7b0645da-03ef-11e7-8c15-e8484d71364c.png)

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

          $ git pull https://github.com/phoenixjiangnan/flink FLINK-6002

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

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


          commit d34944a05a2584d0f3880c100dc3f71b48ffe94e
          Author: phoenixjiangnan <bowenli86@gmail.com>
          Date: 2017-03-08T19:03:21Z

          FLINK-6002 'MacOS X' under 'Download and Start Flink' in Quickstart page is not rendered correctly


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user phoenixjiangnan opened a pull request: https://github.com/apache/flink/pull/3497 FLINK-6002 'MacOS X' section in Quickstart page is not rendered correctly Currently, ["MacOS X" section under "Setup: Download and Start Flink" in Quickstart page] ( https://ci.apache.org/projects/flink/flink-docs-release-1.2/quickstart/setup_quickstart.html#setup-download-and-start-flink ) is not rendered correctly. ! [before] ( https://cloud.githubusercontent.com/assets/1892692/23719173/28a8daaa-03ef-11e7-9663-26486723c652.png ) I fixed this markdown issue by simply adding a blank line between text paragraph and code block. Now it looks like this: ! [after] ( https://cloud.githubusercontent.com/assets/1892692/23719258/7b0645da-03ef-11e7-8c15-e8484d71364c.png ) You can merge this pull request into a Git repository by running: $ git pull https://github.com/phoenixjiangnan/flink FLINK-6002 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3497.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 #3497 commit d34944a05a2584d0f3880c100dc3f71b48ffe94e Author: phoenixjiangnan <bowenli86@gmail.com> Date: 2017-03-08T19:03:21Z FLINK-6002 'MacOS X' under 'Download and Start Flink' in Quickstart page is not rendered correctly
          Hide
          phoenixjiangnan Bowen Li added a comment -

          Hi guys, how to assign this issue to myself?

          Show
          phoenixjiangnan Bowen Li added a comment - Hi guys, how to assign this issue to myself?
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user zentol commented on the issue:

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

          +1 to merge.

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

          Github user clarkyzl commented on the issue:

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

          +1 LGTM. Thanks @phoenixjiangnan

          Show
          githubbot ASF GitHub Bot added a comment - Github user clarkyzl commented on the issue: https://github.com/apache/flink/pull/3497 +1 LGTM. Thanks @phoenixjiangnan
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

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

          Fixed in 2a32af8 (1.2), 8d92f86 (master).

          Show
          uce Ufuk Celebi added a comment - Fixed in 2a32af8 (1.2), 8d92f86 (master).

            People

            • Assignee:
              Unassigned
              Reporter:
              phoenixjiangnan Bowen Li
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development