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 2022/01/19 03:56:17 UTC

[GitHub] [flink] wenlong88 opened a new pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

wenlong88 opened a new pull request #18400:
URL: https://github.com/apache/flink/pull/18400


   
   ## What is the purpose of the change
   this is part of This PR is part of https://cwiki.apache.org/confluence/display/FLINK/FLIP-195%3A+Improve+the+name+and+structure+of+vertex+and+operator+name+for+job , aims at to add doc about name and description.
   
   
   ## Brief change log
   add docs about name and description in the section of operators.
   
   
   ## Verifying this change
   
   This change is a trivial work 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, ZooKeeper: (no)
     - The S3 file system connector: (no)
   
   ## Documentation
     - Does this pull request introduce a new feature? (no)
   


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

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] wenlong88 commented on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   @gaoyunhaii  thanks for the detailed review, I have addressed the comments


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

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] gaoyunhaii closed pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   


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

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31377",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31377) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot commented on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] gaoyunhaii closed pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   


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

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31377",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31377) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "DELETED",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31377",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 377f14caf340fcfbba8fa409a23529769bfcff2a Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31377) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "5b1db23198aec87c376a6793562ce0753a02b8f3",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "5b1db23198aec87c376a6793562ce0753a02b8f3",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 5b1db23198aec87c376a6793562ce0753a02b8f3 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] gaoyunhaii commented on a change in pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

Posted by GitBox <gi...@apache.org>.
gaoyunhaii commented on a change in pull request #18400:
URL: https://github.com/apache/flink/pull/18400#discussion_r805477288



##########
File path: docs/content.zh/docs/dev/datastream/operators/overview.md
##########
@@ -755,3 +755,38 @@ some_stream.filter(...).slot_sharing_group("name")
 ```
 {{< /tab >}}
 {{< /tabs>}}
+
+## 名字和描述
+Flink里的算子和作业节点会有一个名字和一个描述。名字和描述。名字和描述都是用来介绍一个算子或者节点是在做什么操作,但是他们会被用在不同地方。
+
+名字会用在用户界面、线程名、日志、指标等场景。节点的名字会根据节点中算子的名字来构建。
+名字需要尽可能的简介,避免对外部系统产生大的压力。
+
+描述主要用在执行计划展示,以及用户界面展示。节点的描述同样是根据节点中算子的描述来构建。
+描述可以包括详细的算子行为的信息,以便我们在运行时进行debug分析。
+
+{{< tabs slotsharing >}}

Review comment:
       Do not use the same tabs name, otherwise it would  cause issues. Might change to `namedescription` ? Same to the English version

##########
File path: docs/content/docs/dev/datastream/operators/overview.md
##########
@@ -755,5 +755,43 @@ someStream.filter(...).slotSharingGroup("name")
 ```python
 some_stream.filter(...).slot_sharing_group("name")
 ```
+

Review comment:
       Hi @wenlong88  If convenient could you also add the following two lines to fix the previous incomplete labels? Or  it could be put into a separate hotfix commit in this PR. 
   ```
   {{< /tab >}}
   {{< /tabs>}}
   ```

##########
File path: docs/content.zh/docs/dev/datastream/operators/overview.md
##########
@@ -755,3 +755,38 @@ some_stream.filter(...).slot_sharing_group("name")
 ```
 {{< /tab >}}
 {{< /tabs>}}
+
+## 名字和描述

Review comment:
       Add an empty line after the title? Same to the English version

##########
File path: docs/content/docs/dev/datastream/operators/overview.md
##########
@@ -755,5 +755,43 @@ someStream.filter(...).slotSharingGroup("name")
 ```python
 some_stream.filter(...).slot_sharing_group("name")
 ```
+
+## Name And Description
+Operators and job vertices in flink have a name and a description. 
+Both name and description are introduction about what an operator or a job vertex is doing, but they are used differently.
+
+The name of operator and job vertex will be used in web ui, thread name, logging, metrics, etc.
+The name of a job vertex is constructed based on the name of operators in it.
+The name need to be as concise as possible to avoid big pressure on external systems.

Review comment:
       need -> needs ? 
   big pressure -> high pressure ? 

##########
File path: docs/content/docs/dev/datastream/operators/overview.md
##########
@@ -755,5 +755,43 @@ someStream.filter(...).slotSharingGroup("name")
 ```python
 some_stream.filter(...).slot_sharing_group("name")
 ```
+
+## Name And Description
+Operators and job vertices in flink have a name and a description. 
+Both name and description are introduction about what an operator or a job vertex is doing, but they are used differently.
+
+The name of operator and job vertex will be used in web ui, thread name, logging, metrics, etc.
+The name of a job vertex is constructed based on the name of operators in it.
+The name need to be as concise as possible to avoid big pressure on external systems.
+
+The description will be used in the execution plan and displayed as details of a job vertex in web UI.
+The description of a job vertex is constructed based on the description of operators in it.
+The description can contain detail information about operators to facilitate debugging at runtime.
+
+{{< tabs slotsharing >}}
+{{< tab "Java" >}}
+```java
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Scala" >}}
+```scala
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Python" >}}
+```python
+some_stream.filter(...).name("filter").set_description("x in (1, 2, 3, 4) and y > 1")
+```
 {{< /tab >}}
 {{< /tabs>}}
+
+The format of description of a job vertex would be a tree format string by default. 
+Users can set `pipeline.vertex-description-mode` to be `CASCADING`, if they want to set description to be cascading format as what it is in former versions.
+
+Operators generated by Flink SQL will have a name consisted by type of operator and id, and a detailed description, by default.
+Users can set `table.optimizer.simplify-operator-name-enabled` to be `false`, if they want to set name to be the detailed description as what it is in former versions.
+
+When the topology of the pipeline is complex, users can add a topological index in the name of vertex by set `pipeline.vertex-name-include-index-prefix` to be `true`,

Review comment:
       set ... to be -> set ... to ?

##########
File path: docs/content.zh/docs/dev/datastream/operators/overview.md
##########
@@ -755,3 +755,38 @@ some_stream.filter(...).slot_sharing_group("name")
 ```
 {{< /tab >}}
 {{< /tabs>}}
+
+## 名字和描述
+Flink里的算子和作业节点会有一个名字和一个描述。名字和描述。名字和描述都是用来介绍一个算子或者节点是在做什么操作,但是他们会被用在不同地方。
+
+名字会用在用户界面、线程名、日志、指标等场景。节点的名字会根据节点中算子的名字来构建。
+名字需要尽可能的简介,避免对外部系统产生大的压力。
+
+描述主要用在执行计划展示,以及用户界面展示。节点的描述同样是根据节点中算子的描述来构建。
+描述可以包括详细的算子行为的信息,以便我们在运行时进行debug分析。
+
+{{< tabs slotsharing >}}
+{{< tab "Java" >}}
+```java
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Scala" >}}
+```scala
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Python" >}}
+```python
+some_stream.filter(...).name("filter").set_description("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< /tabs>}}
+
+节点的描述默认是按照一个多行的树形结构来构建的,用户可以通过把`pipeline.vertex-description-mode`设为`CASCADING`, 实现将描述改外老版本的单行递归模式。

Review comment:
       改外 -> 改为?

##########
File path: docs/content/docs/dev/datastream/operators/overview.md
##########
@@ -755,5 +755,43 @@ someStream.filter(...).slotSharingGroup("name")
 ```python
 some_stream.filter(...).slot_sharing_group("name")
 ```
+
+## Name And Description
+Operators and job vertices in flink have a name and a description. 
+Both name and description are introduction about what an operator or a job vertex is doing, but they are used differently.
+
+The name of operator and job vertex will be used in web ui, thread name, logging, metrics, etc.
+The name of a job vertex is constructed based on the name of operators in it.
+The name need to be as concise as possible to avoid big pressure on external systems.
+
+The description will be used in the execution plan and displayed as details of a job vertex in web UI.
+The description of a job vertex is constructed based on the description of operators in it.
+The description can contain detail information about operators to facilitate debugging at runtime.
+
+{{< tabs slotsharing >}}
+{{< tab "Java" >}}
+```java
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Scala" >}}
+```scala
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Python" >}}
+```python
+some_stream.filter(...).name("filter").set_description("x in (1, 2, 3, 4) and y > 1")
+```
 {{< /tab >}}
 {{< /tabs>}}
+
+The format of description of a job vertex would be a tree format string by default. 

Review comment:
       `would be a tree` -> `is a tree` ?

##########
File path: docs/content/docs/dev/datastream/operators/overview.md
##########
@@ -755,5 +755,43 @@ someStream.filter(...).slotSharingGroup("name")
 ```python
 some_stream.filter(...).slot_sharing_group("name")
 ```
+
+## Name And Description
+Operators and job vertices in flink have a name and a description. 
+Both name and description are introduction about what an operator or a job vertex is doing, but they are used differently.
+
+The name of operator and job vertex will be used in web ui, thread name, logging, metrics, etc.
+The name of a job vertex is constructed based on the name of operators in it.
+The name need to be as concise as possible to avoid big pressure on external systems.
+
+The description will be used in the execution plan and displayed as details of a job vertex in web UI.
+The description of a job vertex is constructed based on the description of operators in it.
+The description can contain detail information about operators to facilitate debugging at runtime.
+
+{{< tabs slotsharing >}}
+{{< tab "Java" >}}
+```java
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Scala" >}}
+```scala
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Python" >}}
+```python
+some_stream.filter(...).name("filter").set_description("x in (1, 2, 3, 4) and y > 1")
+```
 {{< /tab >}}
 {{< /tabs>}}
+
+The format of description of a job vertex would be a tree format string by default. 
+Users can set `pipeline.vertex-description-mode` to be `CASCADING`, if they want to set description to be cascading format as what it is in former versions.
+
+Operators generated by Flink SQL will have a name consisted by type of operator and id, and a detailed description, by default.

Review comment:
       This sentence seems not consistent with the Chinese version.

##########
File path: docs/content.zh/docs/dev/datastream/operators/overview.md
##########
@@ -755,3 +755,38 @@ some_stream.filter(...).slot_sharing_group("name")
 ```
 {{< /tab >}}
 {{< /tabs>}}
+
+## 名字和描述
+Flink里的算子和作业节点会有一个名字和一个描述。名字和描述。名字和描述都是用来介绍一个算子或者节点是在做什么操作,但是他们会被用在不同地方。
+
+名字会用在用户界面、线程名、日志、指标等场景。节点的名字会根据节点中算子的名字来构建。
+名字需要尽可能的简介,避免对外部系统产生大的压力。

Review comment:
       简介 -> 简洁 ?

##########
File path: docs/content/docs/dev/datastream/operators/overview.md
##########
@@ -755,5 +755,43 @@ someStream.filter(...).slotSharingGroup("name")
 ```python
 some_stream.filter(...).slot_sharing_group("name")
 ```
+
+## Name And Description
+Operators and job vertices in flink have a name and a description. 
+Both name and description are introduction about what an operator or a job vertex is doing, but they are used differently.
+
+The name of operator and job vertex will be used in web ui, thread name, logging, metrics, etc.
+The name of a job vertex is constructed based on the name of operators in it.
+The name need to be as concise as possible to avoid big pressure on external systems.
+
+The description will be used in the execution plan and displayed as details of a job vertex in web UI.
+The description of a job vertex is constructed based on the description of operators in it.
+The description can contain detail information about operators to facilitate debugging at runtime.
+
+{{< tabs slotsharing >}}
+{{< tab "Java" >}}
+```java
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Scala" >}}
+```scala
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Python" >}}
+```python
+some_stream.filter(...).name("filter").set_description("x in (1, 2, 3, 4) and y > 1")
+```
 {{< /tab >}}
 {{< /tabs>}}
+
+The format of description of a job vertex would be a tree format string by default. 
+Users can set `pipeline.vertex-description-mode` to be `CASCADING`, if they want to set description to be cascading format as what it is in former versions.

Review comment:
       I think might change  `set ... to be` to `set ... to`.
   
   `to be cascading format` -> `to be the cascading format`
   `as what it is in former versions.` -> `as in former versions.`
   
   
   Might change to 
   
   Users can set `pipeline.vertex-description-mode` to `CASCADING` if they want to use cascading format description as in former versions.
   
   Similar to `Users can set `table.optimizer.simplify-operator-name-enabled` to be `false`, if they want to set name to be the detailed description as what it is in former versions.`

##########
File path: docs/content.zh/docs/dev/datastream/operators/overview.md
##########
@@ -755,3 +755,38 @@ some_stream.filter(...).slot_sharing_group("name")
 ```
 {{< /tab >}}
 {{< /tabs>}}
+
+## 名字和描述
+Flink里的算子和作业节点会有一个名字和一个描述。名字和描述。名字和描述都是用来介绍一个算子或者节点是在做什么操作,但是他们会被用在不同地方。
+
+名字会用在用户界面、线程名、日志、指标等场景。节点的名字会根据节点中算子的名字来构建。
+名字需要尽可能的简介,避免对外部系统产生大的压力。
+
+描述主要用在执行计划展示,以及用户界面展示。节点的描述同样是根据节点中算子的描述来构建。
+描述可以包括详细的算子行为的信息,以便我们在运行时进行debug分析。
+
+{{< tabs slotsharing >}}
+{{< tab "Java" >}}
+```java
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Scala" >}}
+```scala
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Python" >}}
+```python
+some_stream.filter(...).name("filter").set_description("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< /tabs>}}
+
+节点的描述默认是按照一个多行的树形结构来构建的,用户可以通过把`pipeline.vertex-description-mode`设为`CASCADING`, 实现将描述改外老版本的单行递归模式。
+
+Flink SQL框架生成的算子的名字是由算子的类型以及id构成一个简化的名字,详细的描述信息会被放到描述里。
+用户可以通过将`table.optimizer.simplify-operator-name-enabled`设为`false`,关闭名字简化的功能,关闭后,名字会像以前的版本一样,带有详细的描述信息。
+
+当一个作业的拓扑很复杂是,用户可以把`pipeline.vertex-name-include-index-prefix`设为`true`,在节点的名字前增加一个一个拓扑序的前缀,这样就可以很容易根据指标以及日志的信息快速找到拓扑图中对应节点。

Review comment:
       很复杂是 -> 很复杂时

##########
File path: docs/content.zh/docs/dev/datastream/operators/overview.md
##########
@@ -755,3 +755,38 @@ some_stream.filter(...).slot_sharing_group("name")
 ```
 {{< /tab >}}
 {{< /tabs>}}
+
+## 名字和描述
+Flink里的算子和作业节点会有一个名字和一个描述。名字和描述。名字和描述都是用来介绍一个算子或者节点是在做什么操作,但是他们会被用在不同地方。
+
+名字会用在用户界面、线程名、日志、指标等场景。节点的名字会根据节点中算子的名字来构建。
+名字需要尽可能的简介,避免对外部系统产生大的压力。
+
+描述主要用在执行计划展示,以及用户界面展示。节点的描述同样是根据节点中算子的描述来构建。
+描述可以包括详细的算子行为的信息,以便我们在运行时进行debug分析。
+
+{{< tabs slotsharing >}}
+{{< tab "Java" >}}
+```java
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Scala" >}}
+```scala
+someStream.filter(...).setName("filter").setDescription("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< tab "Python" >}}
+```python
+some_stream.filter(...).name("filter").set_description("x in (1, 2, 3, 4) and y > 1")
+```
+{{< /tab >}}
+{{< /tabs>}}
+
+节点的描述默认是按照一个多行的树形结构来构建的,用户可以通过把`pipeline.vertex-description-mode`设为`CASCADING`, 实现将描述改外老版本的单行递归模式。
+
+Flink SQL框架生成的算子的名字是由算子的类型以及id构成一个简化的名字,详细的描述信息会被放到描述里。
+用户可以通过将`table.optimizer.simplify-operator-name-enabled`设为`false`,关闭名字简化的功能,关闭后,名字会像以前的版本一样,带有详细的描述信息。
+
+当一个作业的拓扑很复杂是,用户可以把`pipeline.vertex-name-include-index-prefix`设为`true`,在节点的名字前增加一个一个拓扑序的前缀,这样就可以很容易根据指标以及日志的信息快速找到拓扑图中对应节点。

Review comment:
       一个一个 -> 一个 ?

##########
File path: docs/content/docs/dev/datastream/operators/overview.md
##########
@@ -755,5 +755,43 @@ someStream.filter(...).slotSharingGroup("name")
 ```python
 some_stream.filter(...).slot_sharing_group("name")
 ```
+
+## Name And Description
+Operators and job vertices in flink have a name and a description. 
+Both name and description are introduction about what an operator or a job vertex is doing, but they are used differently.
+
+The name of operator and job vertex will be used in web ui, thread name, logging, metrics, etc.
+The name of a job vertex is constructed based on the name of operators in it.
+The name need to be as concise as possible to avoid big pressure on external systems.
+
+The description will be used in the execution plan and displayed as details of a job vertex in web UI.

Review comment:
       as details of a job vertex -> as the details of a job




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

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     }, {
       "hash" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "377f14caf340fcfbba8fa409a23529769bfcff2a",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   * 377f14caf340fcfbba8fa409a23529769bfcff2a UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot edited a comment on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680",
       "triggerID" : "0ee72a0732026c046d991d959033995c7baf44e1",
       "triggerType" : "PUSH"
     }, {
       "hash" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372",
       "triggerID" : "b49a58bb711123c9cc370345b864cd529a56f8fe",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 0ee72a0732026c046d991d959033995c7baf44e1 Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=29680) 
   * b49a58bb711123c9cc370345b864cd529a56f8fe Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=31372) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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



[GitHub] [flink] flinkbot commented on pull request #18400: [FLINK-25198][docs] Add doc about name and description of operator

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


   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 0ee72a0732026c046d991d959033995c7baf44e1 (Wed Jan 19 03:59:29 UTC 2022)
   
   **Warnings:**
    * **This pull request references an unassigned [Jira ticket](https://issues.apache.org/jira/browse/FLINK-25198).** 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.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

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