You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/07/19 15:47:06 UTC

[GitHub] [pulsar] alpreu opened a new pull request, #16686: [fix][doc] Hotfix Pulsar IO docs

alpreu opened a new pull request, #16686:
URL: https://github.com/apache/pulsar/pull/16686

   ### Motivation
   
   
   This is a hotfix to correct the grammar as well as the page layout of the Pulsar IO  > Debug and Pulsar IO > Develop pages.
   
   ### Modifications
   
   - Fixed grammar on the Debug page
   - Fixed grammar on the Develop page
   - Fixed errors regarding source/sink on the Develop page
   - Fixed page layout (Handling schema as a subsection to source and sink, Infobox regarding licensing)
   
   ### Verifying this change
   
   - [ ] Make sure that the change passes the CI checks.
   
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   ### Does this pull request potentially affect one of the following parts:
   
   *If `yes` was chosen, please highlight the changes*
   
     - Dependencies (does it add or upgrade a dependency): (yes / **no**)
     - The public API: (yes / **no**)
     - The schema: (yes / **no** / don't know)
     - The default values of configurations: (yes / **no**)
     - The wire protocol: (yes / **no**)
     - The rest endpoints: (yes / **no**)
     - The admin cli options: (yes / **no**)
     - Anything that affects deployment: (yes / **no** / don't know)
   
   ### Documentation
   
   Check the box below or label this PR directly.
   
   Need to update docs? 
   
   - [ ] `doc-required` 
   (Your PR needs to update docs and you will update later)
     
   - [ ] `doc-not-needed` 
   (Please explain why)
     
   - [x] `doc` 
   (Your PR contains doc changes)
   
   - [ ] `doc-complete`
   (Docs have been already added)


-- 
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: commits-unsubscribe@pulsar.apache.org

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

[GitHub] [pulsar] alpreu commented on a diff in pull request #16686: [fix][doc] Hotfix Pulsar IO docs

Posted by GitBox <gi...@apache.org>.
alpreu commented on code in PR #16686:
URL: https://github.com/apache/pulsar/pull/16686#discussion_r951362908


##########
site2/docs/io-debug.md:
##########
@@ -106,7 +106,7 @@ Use one of the following methods to get a connector log in localrun mode:
   
   ```
 
-To clearly explain the log information, here breaks down the large block of information into small blocks and add descriptions for each block.
+Following is a breakdown of the log into smaller blocks with descriptions to clearly explain the log information.

Review Comment:
   I adjusted it and pushed the squashed commits right now



-- 
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: commits-unsubscribe@pulsar.apache.org

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

[GitHub] [pulsar] Anonymitaet merged pull request #16686: [fix][doc] Hotfix Pulsar IO docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #16686:
URL: https://github.com/apache/pulsar/pull/16686


-- 
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: commits-unsubscribe@pulsar.apache.org

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

[GitHub] [pulsar] github-actions[bot] commented on pull request #16686: [fix][doc] Hotfix Pulsar IO docs

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #16686:
URL: https://github.com/apache/pulsar/pull/16686#issuecomment-1221451833

   The pr had no activity for 30 days, mark with Stale label.


-- 
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: commits-unsubscribe@pulsar.apache.org

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

[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16686: [fix][doc] Hotfix Pulsar IO docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #16686:
URL: https://github.com/apache/pulsar/pull/16686#discussion_r950950327


##########
site2/docs/io-debug.md:
##########
@@ -106,7 +106,7 @@ Use one of the following methods to get a connector log in localrun mode:
   
   ```
 
-To clearly explain the log information, here breaks down the large block of information into small blocks and add descriptions for each block.
+Following is a breakdown of the log into smaller blocks with descriptions to clearly explain the log information.

Review Comment:
   LGTM



-- 
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: commits-unsubscribe@pulsar.apache.org

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

[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16686: [fix][doc] Hotfix Pulsar IO docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #16686:
URL: https://github.com/apache/pulsar/pull/16686#discussion_r926182521


##########
site2/docs/io-debug.md:
##########
@@ -106,7 +106,7 @@ Use one of the following methods to get a connector log in localrun mode:
   
   ```
 
-To clearly explain the log information, here breaks down the large block of information into small blocks and add descriptions for each block.
+Following is a breakdown of the log into smaller blocks with descriptions to clearly explain the log information.

Review Comment:
   The readability of the original one is better since it splits a long sentence into several parts.



##########
site2/docs/io-develop.md:
##########
@@ -95,10 +95,10 @@ interface, which means you need to implement the {@inject: github:open:/pulsar-i
        `ack` |Acknowledge that the record is fully processed.
        `fail`|Indicate that the record fails to be processed.
 
-## Handle schema information
+#### Handling schema information

Review Comment:
   Use base forms rather than gerunds to improve search efficiency. 



-- 
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: commits-unsubscribe@pulsar.apache.org

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

[GitHub] [pulsar] alpreu commented on a diff in pull request #16686: [fix][doc] Hotfix Pulsar IO docs

Posted by GitBox <gi...@apache.org>.
alpreu commented on code in PR #16686:
URL: https://github.com/apache/pulsar/pull/16686#discussion_r926605573


##########
site2/docs/io-debug.md:
##########
@@ -106,7 +106,7 @@ Use one of the following methods to get a connector log in localrun mode:
   
   ```
 
-To clearly explain the log information, here breaks down the large block of information into small blocks and add descriptions for each block.
+Following is a breakdown of the log into smaller blocks with descriptions to clearly explain the log information.

Review Comment:
   I agree but the problem with the original is that its English is not correct. Maybe we can improve on the wording?
   What do you think about this:
   ```
   To clearly explain the log information, the following is a breakdown into smaller blocks with added descriptions
   ```



-- 
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: commits-unsubscribe@pulsar.apache.org

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

[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #16686: [fix][doc] Hotfix Pulsar IO docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #16686:
URL: https://github.com/apache/pulsar/pull/16686#discussion_r926182432


##########
site2/docs/io-debug.md:
##########
@@ -106,7 +106,7 @@ Use one of the following methods to get a connector log in localrun mode:
   
   ```
 
-To clearly explain the log information, here breaks down the large block of information into small blocks and add descriptions for each block.
+Following is a breakdown of the log into smaller blocks with descriptions to clearly explain the log information.

Review Comment:
   The readability of the original one is better since it splits a long sentence into several parts.



-- 
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: commits-unsubscribe@pulsar.apache.org

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