You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2020/08/07 12:26:51 UTC

[GitHub] [flink] WeiZhong94 opened a new pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

WeiZhong94 opened a new pull request #13085:
URL: https://github.com/apache/flink/pull/13085


   ## What is the purpose of the change
   
   *This pull request modifies the `flink.js` to improve the code tabs of the Flink documents.*
   
   ## Brief change log
   
     - *Split the code tab label like "Java/Scala" to 2 labels.*
     - *Let the first character of the code tab label always upper case.*
     - *Add a new attribute "data-hide-tabs" used to hide the code tab headers.*
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): (no)
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (no)
     - The serializers: (no)
     - The runtime per-record code paths (performance sensitive): (no)
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: (no)
     - The S3 file system connector: (no)
   
   ## Documentation
   
     - Does this pull request introduce a new feature? (no)
     - If yes, how is the feature documented? (not applicable)
   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] WeiZhong94 commented on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
WeiZhong94 commented on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-671313595


   @dianfu Thanks for your advice. I have improved the `tableApi.md` and `types.md` with the newly added feature.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot commented on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * cec71d84d3cfb2a69cbae2ed74fd1612ff95f747 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * cec71d84d3cfb2a69cbae2ed74fd1612ff95f747 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] sjwiesman commented on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
sjwiesman commented on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-673477247


   +1


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     }, {
       "hash" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "triggerType" : "PUSH"
     }, {
       "hash" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5355",
       "triggerID" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * c766d6f7449b734976f85691c9bdd9f3f72bf641 UNKNOWN
   * 2e32aa5a9180f9acabe54baa1be77a0c032f61d0 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5355) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] dianfu commented on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
dianfu commented on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-671000990


   What about also updating the existing documentation to use the functionality provided in this PR? It could provide an example on how to use the functionalities provided in this PR and could also help to understand why this PR is needed.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot commented on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670492600


   Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
   to review your pull request. We will use this comment to track the progress of the review.
   
   
   ## Automated Checks
   Last check on commit fc4d1b8508fca04e655657d67bc74fc166f27dcf (Fri Aug 07 12:29:34 UTC 2020)
   
   **Warnings:**
    * No documentation files were touched! Remember to keep the Flink docs up to date!
    * **This pull request references an unassigned [Jira ticket](https://issues.apache.org/jira/browse/FLINK-18849).** According to the [code contribution guide](https://flink.apache.org/contributing/contribute-code.html), tickets need to be assigned before starting with the implementation work.
   
   
   <sub>Mention the bot in a comment to re-run the automated checks.</sub>
   ## Review Progress
   
   * ❓ 1. The [description] looks good.
   * ❓ 2. There is [consensus] that the contribution should go into to Flink.
   * ❓ 3. Needs [attention] from.
   * ❓ 4. The change fits into the overall [architecture].
   * ❓ 5. Overall code [quality] is good.
   
   Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
    The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
    - `@flinkbot approve all` to approve all aspects
    - `@flinkbot approve-until architecture` to approve everything until `architecture`
    - `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
    - `@flinkbot disapprove architecture` to remove an approval you gave earlier
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     }, {
       "hash" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "triggerType" : "PUSH"
     }, {
       "hash" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * cec71d84d3cfb2a69cbae2ed74fd1612ff95f747 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289) 
   * c766d6f7449b734976f85691c9bdd9f3f72bf641 UNKNOWN
   * 2e32aa5a9180f9acabe54baa1be77a0c032f61d0 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] dianfu edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
dianfu edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-671000990


   What about also updating the existing documentation to use the functionality provided in this PR? It could provide an example on how to use the functionalities provided in this PR, help to understand and verify this PR.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     }, {
       "hash" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "triggerType" : "PUSH"
     }, {
       "hash" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5355",
       "triggerID" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "triggerType" : "PUSH"
     }, {
       "hash" : "dd003bc5406134a8b415f3f8efc351c9ac43ce3b",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5497",
       "triggerID" : "dd003bc5406134a8b415f3f8efc351c9ac43ce3b",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * c766d6f7449b734976f85691c9bdd9f3f72bf641 UNKNOWN
   * dd003bc5406134a8b415f3f8efc351c9ac43ce3b Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5497) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     }, {
       "hash" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * cec71d84d3cfb2a69cbae2ed74fd1612ff95f747 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289) 
   * c766d6f7449b734976f85691c9bdd9f3f72bf641 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     }, {
       "hash" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "triggerType" : "PUSH"
     }, {
       "hash" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5355",
       "triggerID" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "triggerType" : "PUSH"
     }, {
       "hash" : "dd003bc5406134a8b415f3f8efc351c9ac43ce3b",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "dd003bc5406134a8b415f3f8efc351c9ac43ce3b",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * c766d6f7449b734976f85691c9bdd9f3f72bf641 UNKNOWN
   * 2e32aa5a9180f9acabe54baa1be77a0c032f61d0 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5355) 
   * dd003bc5406134a8b415f3f8efc351c9ac43ce3b UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] flinkbot edited a comment on pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #13085:
URL: https://github.com/apache/flink/pull/13085#issuecomment-670497782


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289",
       "triggerID" : "cec71d84d3cfb2a69cbae2ed74fd1612ff95f747",
       "triggerType" : "PUSH"
     }, {
       "hash" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "c766d6f7449b734976f85691c9bdd9f3f72bf641",
       "triggerType" : "PUSH"
     }, {
       "hash" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5355",
       "triggerID" : "2e32aa5a9180f9acabe54baa1be77a0c032f61d0",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * cec71d84d3cfb2a69cbae2ed74fd1612ff95f747 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5289) 
   * c766d6f7449b734976f85691c9bdd9f3f72bf641 UNKNOWN
   * 2e32aa5a9180f9acabe54baa1be77a0c032f61d0 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=5355) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [flink] sjwiesman closed pull request #13085: [FLINK-18849][docs] Improve the code tabs of the Flink documents.

Posted by GitBox <gi...@apache.org>.
sjwiesman closed pull request #13085:
URL: https://github.com/apache/flink/pull/13085


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org