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

Add deep links to Apache Bahir Flink streaming connector documentations

    Details

      Description

      Recently, the Bahir documentation for Flink streaming connectors in Bahir was added to Bahir's website: BAHIR-90.

      We should add deep links to the individual Bahir connector dos under /dev/connectors/overview, instead of just shallow links to the source README.md s in the community ecosystem page.

        Issue Links

          Activity

          Hide
          alpinegizmo David Anderson added a comment -

          I can take this ticket if you like.
          I hope FLINK-6660 can be merged first.

          Show
          alpinegizmo David Anderson added a comment - I can take this ticket if you like. I hope FLINK-6660 can be merged first.
          Hide
          tzulitai Tzu-Li (Gordon) Tai added a comment -

          Sure! I've also reviewed FLINK-6660.

          Show
          tzulitai Tzu-Li (Gordon) Tai added a comment - Sure! I've also reviewed FLINK-6660 .
          Hide
          alpinegizmo David Anderson added a comment -

          I'm thinking of linking to the github READMEs rather than the project's pages – so for example, https://github.com/apache/bahir-flink/tree/master/flink-connector-redis rather than http://bahir.apache.org/docs/flink/current/flink-streaming-redis/. The content is identical, but I find the github versions more readable. More importantly, Bahir has yet to make a release, so to use these connectors you have to go to github and clone the repo, so it seems more helpful to link directly there.

          Tzu-Li (Gordon) Tai Is this a bad idea?

          Show
          alpinegizmo David Anderson added a comment - I'm thinking of linking to the github READMEs rather than the project's pages – so for example, https://github.com/apache/bahir-flink/tree/master/flink-connector-redis rather than http://bahir.apache.org/docs/flink/current/flink-streaming-redis/ . The content is identical, but I find the github versions more readable. More importantly, Bahir has yet to make a release, so to use these connectors you have to go to github and clone the repo, so it seems more helpful to link directly there. Tzu-Li (Gordon) Tai Is this a bad idea?
          Hide
          tzulitai Tzu-Li (Gordon) Tai added a comment -

          David Anderson the first Bahir release for Flink should be out very soon, so the need to have to go to github and clone the repo shouldn't be an issue for too long anymore.

          I think it would still be better to link to the actual website. It's more a matter of polishing up the website documents on the Bahir side, I suppose.

          Show
          tzulitai Tzu-Li (Gordon) Tai added a comment - David Anderson the first Bahir release for Flink should be out very soon, so the need to have to go to github and clone the repo shouldn't be an issue for too long anymore. I think it would still be better to link to the actual website. It's more a matter of polishing up the website documents on the Bahir side, I suppose.
          Hide
          githubbot ASF GitHub Bot added a comment -

          GitHub user alpinegizmo opened a pull request:

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

          FLINK-6038[docs] Added deep links to Bahir connectors

          • [x] General
          • The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
          • The pull request addresses only one issue
          • Each commit in the PR has a meaningful commit message (including the JIRA id)

          Added a section to the connectors overview page that lists the connectors in Bahir, with links to the docs for each.

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

          $ git pull https://github.com/alpinegizmo/flink 6038-docs-add-bahir-connectors

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

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


          commit 7bf4aeaf9d9d1fbd6083dc6715ee0d0486b917d6
          Author: David Anderson <david@alpinegizmo.com>
          Date: 2017-05-23T16:47:57Z

          FLINK-6038[docs] Added deep links to Bahir connectors


          Show
          githubbot ASF GitHub Bot added a comment - GitHub user alpinegizmo opened a pull request: https://github.com/apache/flink/pull/3975 FLINK-6038 [docs] Added deep links to Bahir connectors [x] General The pull request references the related JIRA issue (" [FLINK-XXX] Jira title text") The pull request addresses only one issue Each commit in the PR has a meaningful commit message (including the JIRA id) Added a section to the connectors overview page that lists the connectors in Bahir, with links to the docs for each. You can merge this pull request into a Git repository by running: $ git pull https://github.com/alpinegizmo/flink 6038-docs-add-bahir-connectors Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/3975.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 #3975 commit 7bf4aeaf9d9d1fbd6083dc6715ee0d0486b917d6 Author: David Anderson <david@alpinegizmo.com> Date: 2017-05-23T16:47:57Z FLINK-6038 [docs] Added deep links to Bahir connectors
          Hide
          githubbot ASF GitHub Bot added a comment -

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

          https://github.com/apache/flink/pull/3975#discussion_r118214314

          — Diff: docs/dev/connectors/index.md —
          @@ -54,6 +54,16 @@ Note also that while the streaming connectors listed in this section are part of
          Flink project and are included in source releases, they are not included in the binary distributions.
          Further instructions can be found in the corresponding subsections.

          +## Connectors in Apache Bahir
          +
          +The [Apache Bahir](http://bahir.apache.org/) project provides some additional streaming connectors for Flink, including:
          +
          + * [Apache ActiveMQ](http://bahir.apache.org/docs/flink/current/flink-streaming-activemq/) (sink/source)
          — End diff –

          maybe switch sink/source?

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on a diff in the pull request: https://github.com/apache/flink/pull/3975#discussion_r118214314 — Diff: docs/dev/connectors/index.md — @@ -54,6 +54,16 @@ Note also that while the streaming connectors listed in this section are part of Flink project and are included in source releases, they are not included in the binary distributions. Further instructions can be found in the corresponding subsections. +## Connectors in Apache Bahir + +The [Apache Bahir] ( http://bahir.apache.org/ ) project provides some additional streaming connectors for Flink, including: + + * [Apache ActiveMQ] ( http://bahir.apache.org/docs/flink/current/flink-streaming-activemq/ ) (sink/source) — End diff – maybe switch sink/source?
          Hide
          githubbot ASF GitHub Bot added a comment -

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

          https://github.com/apache/flink/pull/3975#discussion_r118214469

          — Diff: docs/dev/connectors/index.md —
          @@ -54,6 +54,16 @@ Note also that while the streaming connectors listed in this section are part of
          Flink project and are included in source releases, they are not included in the binary distributions.
          Further instructions can be found in the corresponding subsections.

          +## Connectors in Apache Bahir
          +
          +The [Apache Bahir](http://bahir.apache.org/) project provides some additional streaming connectors for Flink, including:
          +
          + * [Apache ActiveMQ](http://bahir.apache.org/docs/flink/current/flink-streaming-activemq/) (sink/source)
          + * [Apache Flume](http://bahir.apache.org/docs/flink/current/flink-streaming-flume/) (sink)
          — End diff –

          use `https` instead?

          Show
          githubbot ASF GitHub Bot added a comment - Github user zentol commented on a diff in the pull request: https://github.com/apache/flink/pull/3975#discussion_r118214469 — Diff: docs/dev/connectors/index.md — @@ -54,6 +54,16 @@ Note also that while the streaming connectors listed in this section are part of Flink project and are included in source releases, they are not included in the binary distributions. Further instructions can be found in the corresponding subsections. +## Connectors in Apache Bahir + +The [Apache Bahir] ( http://bahir.apache.org/ ) project provides some additional streaming connectors for Flink, including: + + * [Apache ActiveMQ] ( http://bahir.apache.org/docs/flink/current/flink-streaming-activemq/ ) (sink/source) + * [Apache Flume] ( http://bahir.apache.org/docs/flink/current/flink-streaming-flume/ ) (sink) — End diff – use `https` instead?
          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/3975#discussion_r118245299

          — Diff: docs/dev/connectors/index.md —
          @@ -54,6 +54,16 @@ Note also that while the streaming connectors listed in this section are part of
          Flink project and are included in source releases, they are not included in the binary distributions.
          Further instructions can be found in the corresponding subsections.

          +## Connectors in Apache Bahir
          +
          +The [Apache Bahir](https://bahir.apache.org/) project provides some additional streaming connectors for Flink, including:
          — End diff –

          Remove "some". Consider reversing and expanding the statement, something like "Additional streaming connectors for Flink are being released through [Apache Bahir](https://bahir.apache.org/), including:". This could help acclimate contributors and treats Bahir less like a third-party.

          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/3975#discussion_r118245299 — Diff: docs/dev/connectors/index.md — @@ -54,6 +54,16 @@ Note also that while the streaming connectors listed in this section are part of Flink project and are included in source releases, they are not included in the binary distributions. Further instructions can be found in the corresponding subsections. +## Connectors in Apache Bahir + +The [Apache Bahir] ( https://bahir.apache.org/ ) project provides some additional streaming connectors for Flink, including: — End diff – Remove "some". Consider reversing and expanding the statement, something like "Additional streaming connectors for Flink are being released through [Apache Bahir] ( https://bahir.apache.org/ ), including:". This could help acclimate contributors and treats Bahir less like a third-party.
          Hide
          githubbot ASF GitHub Bot added a comment -

          Github user greghogan commented on the issue:

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

          @alpinegizmo thanks for the contribution! Merging ...

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

          Github user asfgit closed the pull request at:

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

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

          master: f12c591aa7e9cf72edbeaf04b53eca71fa3681ca
          release-1.3: 4ff1f439ee4529cd47ca1e9d37084da6fd2298b8

          Show
          greghogan Greg Hogan added a comment - master: f12c591aa7e9cf72edbeaf04b53eca71fa3681ca release-1.3: 4ff1f439ee4529cd47ca1e9d37084da6fd2298b8

            People

            • Assignee:
              alpinegizmo David Anderson
              Reporter:
              tzulitai Tzu-Li (Gordon) Tai
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development