Details

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

      Description

      The idea is to improve the documentation home page by adding a few links to valuable items that are too easily overlooked.

        Issue Links

          Activity

          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-6438 Added a few links to the docs home page ...

          … and made some other small adjustments.

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

          $ git pull https://github.com/alpinegizmo/flink 6438-add-to-docs-home-page

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

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


          commit a8d9415ad1f5670e4baacc10700062da4f5baddc
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-05-03T14:44:03Z

          FLINK-6438 Added a few links to the docs home page, and made some other small adjustments.


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3823 FLINK-6438 Added a few links to the docs home page ... … and made some other small adjustments. You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink 6438-add-to-docs-home-page Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3823.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 #3823 commit a8d9415ad1f5670e4baacc10700062da4f5baddc Author: David Anderson <david@alpinegizmo.com> Date: 2017-05-03T14:44:03Z FLINK-6438 Added a few links to the docs home page, and made some other small adjustments.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user StephanEwen commented on the issue:

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

          I like these additional links.

          Since some of the links point for example to the blog of a company, would be good to get an opinion from someone else as well (who is not involved with data Artisans)

          Show
          githubbot ASF GitHub Bot added a comment - Github user StephanEwen commented on the issue: https://github.com/apache/flink/pull/3823 I like these additional links. Since some of the links point for example to the blog of a company, would be good to get an opinion from someone else as well (who is not involved with data Artisans)
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user greghogan commented on a diff in the pull request:

          https://github.com/apache/flink/pull/3823#discussion_r115064578

          — Diff: docs/index.md —
          @@ -33,9 +33,13 @@ Apache Flink is an open source platform for distributed stream and batch data pr

          • *Concepts*: Start with the basic concepts of Flink's [Dataflow Programming Model](concepts/programming-model.html) and [Distributed Runtime Environment](concepts/runtime.html). This will help you to fully understand the other parts of the documentation, including the setup and programming guides. It is highly recommended to read these sections first.

          – *Quickstarts*: [Run an example program](quickstart/setup_quickstart.html) on your local machine or [write a simple program](quickstart/run_example_quickstart.html) working on live Wikipedia edits.
          +- *Quickstarts*: [Run an example program](quickstart/setup_quickstart.html) on your local machine or [study some examples](examples/index.html).

          – *Programming Guides*: You can check out our guides about [basic concepts](dev/api_concepts.html) and the [DataStream API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to learn how to write your first Flink programs.
          +- *Programming Guides*: You can check out our guides about [basic api concepts](dev/api_concepts.html) and the [DataStream API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to learn how to write your first Flink programs.
          — End diff –

          Capitalize 'API'.

          Show
          githubbot ASF GitHub Bot added a comment - Github user greghogan commented on a diff in the pull request: https://github.com/apache/flink/pull/3823#discussion_r115064578 — Diff: docs/index.md — @@ -33,9 +33,13 @@ Apache Flink is an open source platform for distributed stream and batch data pr * Concepts *: Start with the basic concepts of Flink's [Dataflow Programming Model] (concepts/programming-model.html) and [Distributed Runtime Environment] (concepts/runtime.html). This will help you to fully understand the other parts of the documentation, including the setup and programming guides. It is highly recommended to read these sections first. – * Quickstarts *: [Run an example program] (quickstart/setup_quickstart.html) on your local machine or [write a simple program] (quickstart/run_example_quickstart.html) working on live Wikipedia edits. +- * Quickstarts *: [Run an example program] (quickstart/setup_quickstart.html) on your local machine or [study some examples] (examples/index.html). – * Programming Guides *: You can check out our guides about [basic concepts] (dev/api_concepts.html) and the [DataStream API] (dev/datastream_api.html) or [DataSet API] (dev/batch/index.html) to learn how to write your first Flink programs. +- * Programming Guides *: You can check out our guides about [basic api concepts] (dev/api_concepts.html) and the [DataStream API] (dev/datastream_api.html) or [DataSet API] (dev/batch/index.html) to learn how to write your first Flink programs. — End diff – Capitalize 'API'.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user greghogan commented on a diff in the pull request:

          https://github.com/apache/flink/pull/3823#discussion_r115065489

          — Diff: docs/index.md —
          @@ -33,9 +33,13 @@ Apache Flink is an open source platform for distributed stream and batch data pr

          • *Concepts*: Start with the basic concepts of Flink's [Dataflow Programming Model](concepts/programming-model.html) and [Distributed Runtime Environment](concepts/runtime.html). This will help you to fully understand the other parts of the documentation, including the setup and programming guides. It is highly recommended to read these sections first.

          – *Quickstarts*: [Run an example program](quickstart/setup_quickstart.html) on your local machine or [write a simple program](quickstart/run_example_quickstart.html) working on live Wikipedia edits.
          +- *Quickstarts*: [Run an example program](quickstart/setup_quickstart.html) on your local machine or [study some examples](examples/index.html).

          – *Programming Guides*: You can check out our guides about [basic concepts](dev/api_concepts.html) and the [DataStream API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to learn how to write your first Flink programs.
          +- *Programming Guides*: You can check out our guides about [basic api concepts](dev/api_concepts.html) and the [DataStream API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to learn how to write your first Flink programs.
          +
          +## Deployment
          +
          +Before putting your Flink job into production, be sure to read the [Production Readiness Checklist](http://localhost:4000/ops/production_ready.html).
          — End diff –

          Fix URL.

          Show
          githubbot ASF GitHub Bot added a comment - Github user greghogan commented on a diff in the pull request: https://github.com/apache/flink/pull/3823#discussion_r115065489 — Diff: docs/index.md — @@ -33,9 +33,13 @@ Apache Flink is an open source platform for distributed stream and batch data pr * Concepts *: Start with the basic concepts of Flink's [Dataflow Programming Model] (concepts/programming-model.html) and [Distributed Runtime Environment] (concepts/runtime.html). This will help you to fully understand the other parts of the documentation, including the setup and programming guides. It is highly recommended to read these sections first. – * Quickstarts *: [Run an example program] (quickstart/setup_quickstart.html) on your local machine or [write a simple program] (quickstart/run_example_quickstart.html) working on live Wikipedia edits. +- * Quickstarts *: [Run an example program] (quickstart/setup_quickstart.html) on your local machine or [study some examples] (examples/index.html). – * Programming Guides *: You can check out our guides about [basic concepts] (dev/api_concepts.html) and the [DataStream API] (dev/datastream_api.html) or [DataSet API] (dev/batch/index.html) to learn how to write your first Flink programs. +- * Programming Guides *: You can check out our guides about [basic api concepts] (dev/api_concepts.html) and the [DataStream API] (dev/datastream_api.html) or [DataSet API] (dev/batch/index.html) to learn how to write your first Flink programs. + +## Deployment + +Before putting your Flink job into production, be sure to read the [Production Readiness Checklist] ( http://localhost:4000/ops/production_ready.html ). — End diff – Fix URL.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user alpinegizmo commented on a diff in the pull request:

          https://github.com/apache/flink/pull/3823#discussion_r115125659

          — Diff: docs/index.md —
          @@ -33,9 +33,13 @@ Apache Flink is an open source platform for distributed stream and batch data pr

          • *Concepts*: Start with the basic concepts of Flink's [Dataflow Programming Model](concepts/programming-model.html) and [Distributed Runtime Environment](concepts/runtime.html). This will help you to fully understand the other parts of the documentation, including the setup and programming guides. It is highly recommended to read these sections first.

          – *Quickstarts*: [Run an example program](quickstart/setup_quickstart.html) on your local machine or [write a simple program](quickstart/run_example_quickstart.html) working on live Wikipedia edits.
          +- *Quickstarts*: [Run an example program](quickstart/setup_quickstart.html) on your local machine or [study some examples](examples/index.html).

          – *Programming Guides*: You can check out our guides about [basic concepts](dev/api_concepts.html) and the [DataStream API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to learn how to write your first Flink programs.
          +- *Programming Guides*: You can check out our guides about [basic api concepts](dev/api_concepts.html) and the [DataStream API](dev/datastream_api.html) or [DataSet API](dev/batch/index.html) to learn how to write your first Flink programs.
          +
          +## Deployment
          +
          +Before putting your Flink job into production, be sure to read the [Production Readiness Checklist](http://localhost:4000/ops/production_ready.html).
          — End diff –

          That's embarrassing; glad you caught that.

          Show
          githubbot ASF GitHub Bot added a comment - Github user alpinegizmo commented on a diff in the pull request: https://github.com/apache/flink/pull/3823#discussion_r115125659 — Diff: docs/index.md — @@ -33,9 +33,13 @@ Apache Flink is an open source platform for distributed stream and batch data pr * Concepts *: Start with the basic concepts of Flink's [Dataflow Programming Model] (concepts/programming-model.html) and [Distributed Runtime Environment] (concepts/runtime.html). This will help you to fully understand the other parts of the documentation, including the setup and programming guides. It is highly recommended to read these sections first. – * Quickstarts *: [Run an example program] (quickstart/setup_quickstart.html) on your local machine or [write a simple program] (quickstart/run_example_quickstart.html) working on live Wikipedia edits. +- * Quickstarts *: [Run an example program] (quickstart/setup_quickstart.html) on your local machine or [study some examples] (examples/index.html). – * Programming Guides *: You can check out our guides about [basic concepts] (dev/api_concepts.html) and the [DataStream API] (dev/datastream_api.html) or [DataSet API] (dev/batch/index.html) to learn how to write your first Flink programs. +- * Programming Guides *: You can check out our guides about [basic api concepts] (dev/api_concepts.html) and the [DataStream API] (dev/datastream_api.html) or [DataSet API] (dev/batch/index.html) to learn how to write your first Flink programs. + +## Deployment + +Before putting your Flink job into production, be sure to read the [Production Readiness Checklist] ( http://localhost:4000/ops/production_ready.html ). — End diff – That's embarrassing; glad you caught that.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user alpinegizmo commented on the issue:

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

          @greghogan I'd be happy to list other blogs; any suggestions? I've considered at a few, but the problem with the ones I've examined is that the proportion of Flink-related posts is rather small, and the posts aren't tagged, so we can't link directly the subset that's relevant.

          Show
          githubbot ASF GitHub Bot added a comment - Github user alpinegizmo commented on the issue: https://github.com/apache/flink/pull/3823 @greghogan I'd be happy to list other blogs; any suggestions? I've considered at a few, but the problem with the ones I've examined is that the proportion of Flink-related posts is rather small, and the posts aren't tagged, so we can't link directly the subset that's relevant.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user greghogan commented on the issue:

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

          @alpinegizmo understood, and meant to say that with an eye to the future. Was only confirming that the community is not giving special consideration to data Artisians.

          Show
          githubbot ASF GitHub Bot added a comment - Github user greghogan commented on the issue: https://github.com/apache/flink/pull/3823 @alpinegizmo understood, and meant to say that with an eye to the future. Was only confirming that the community is not giving special consideration to data Artisians.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user asfgit closed the pull request at:

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

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

          master: e0ab5f5249d285921f400cc4794673380e7aa8d4
          release-1.3: fd910f2c969b6c8ef555e68532ffad2fbc674828

          Show
          greghogan Greg Hogan added a comment - master: e0ab5f5249d285921f400cc4794673380e7aa8d4 release-1.3: fd910f2c969b6c8ef555e68532ffad2fbc674828

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development