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/04/14 09:26:33 UTC

[GitHub] [flink] aljoscha opened a new pull request #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation

aljoscha opened a new pull request #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation
URL: https://github.com/apache/flink/pull/11730
 
 
   ## What is the purpose of the change
   
   This is moving towards the goal of FLIP-42 of having only DataStream, DataSet, and Table API as the only top-level documentation sections under the API section.
   
   My goal with this is also that the DataStream API Overview gives a full guide for users starting with the API. After this change, a user does not first have to read basic concepts but the DataStream API overview is sufficient and the information is in the right place.
   
   This move different sections from `api_concepts.md` to different "top-level" sections, depending on what seems right. For example, "Specifying Keys" is moved to the state documentation. The section about user functions is moved to a new "User-Defined Functions" page.
   
   I will create a Jira issue for updating the Chinese documentation once this is merged. I meticulously "logged" the steps via commits so that a translator can apply the same changes.
   
   Please look at the individual commits, they document what's going on quite well. Also take a look at the flow of the updated DataStream API Overview page.

----------------------------------------------------------------
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


With regards,
Apache Git Services

[GitHub] [flink] flinkbot edited a comment on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation
URL: https://github.com/apache/flink/pull/11730#issuecomment-613339776
 
 
   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "status" : "SUCCESS",
       "url" : "https://travis-ci.com/github/flink-ci/flink/builds/160182630",
       "triggerID" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "triggerType" : "PUSH"
     }, {
       "hash" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7450",
       "triggerID" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * d9a74eac544011f9d7c5976aaf37dc6d301d3f1b Travis: [SUCCESS](https://travis-ci.com/github/flink-ci/flink/builds/160182630) Azure: [SUCCESS](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7450) 
   
   <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


With regards,
Apache Git Services

[GitHub] [flink] flinkbot commented on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation

Posted by GitBox <gi...@apache.org>.
flinkbot commented on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation
URL: https://github.com/apache/flink/pull/11730#issuecomment-613339776
 
 
   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * d9a74eac544011f9d7c5976aaf37dc6d301d3f1b 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


With regards,
Apache Git Services

[GitHub] [flink] aljoscha commented on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation

Posted by GitBox <gi...@apache.org>.
aljoscha commented on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation
URL: https://github.com/apache/flink/pull/11730#issuecomment-613330017
 
 
   @knaufk @alpinegizmo @sjwiesman Could one of you please review this?
   
   cc @wuchong 

----------------------------------------------------------------
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


With regards,
Apache Git Services

[GitHub] [flink] flinkbot edited a comment on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation
URL: https://github.com/apache/flink/pull/11730#issuecomment-613339776
 
 
   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "status" : "PENDING",
       "url" : "https://travis-ci.com/github/flink-ci/flink/builds/160182630",
       "triggerID" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "triggerType" : "PUSH"
     }, {
       "hash" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7450",
       "triggerID" : "d9a74eac544011f9d7c5976aaf37dc6d301d3f1b",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * d9a74eac544011f9d7c5976aaf37dc6d301d3f1b Travis: [PENDING](https://travis-ci.com/github/flink-ci/flink/builds/160182630) Azure: [PENDING](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7450) 
   
   <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


With regards,
Apache Git Services

[GitHub] [flink] flinkbot commented on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation

Posted by GitBox <gi...@apache.org>.
flinkbot commented on issue #11730: [FLINK-17009] Fold api_concepts.md into DataStream documentation
URL: https://github.com/apache/flink/pull/11730#issuecomment-613331694
 
 
   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 d9a74eac544011f9d7c5976aaf37dc6d301d3f1b (Tue Apr 14 09:30:22 UTC 2020)
   
    ✅no warnings
   
   <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


With regards,
Apache Git Services