You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2022/02/20 17:00:50 UTC

[GitHub] [kafka] mimaison opened a new pull request #11794: MINOR: Add links to connector configs in TOC

mimaison opened a new pull request #11794:
URL: https://github.com/apache/kafka/pull/11794


   Add links to Sink and Source connectors configurations
   
   ### Committer Checklist (excluded from commit message)
   - [ ] Verify design and implementation 
   - [ ] Verify test coverage and CI build status
   - [ ] Verify documentation (including upgrade notes)
   


-- 
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: jira-unsubscribe@kafka.apache.org

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



[GitHub] [kafka] showuon merged pull request #11794: MINOR: Add links to connector configs in TOC

Posted by GitBox <gi...@apache.org>.
showuon merged pull request #11794:
URL: https://github.com/apache/kafka/pull/11794


   


-- 
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: jira-unsubscribe@kafka.apache.org

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



[GitHub] [kafka] showuon commented on a change in pull request #11794: MINOR: Add links to connector configs in TOC

Posted by GitBox <gi...@apache.org>.
showuon commented on a change in pull request #11794:
URL: https://github.com/apache/kafka/pull/11794#discussion_r811537471



##########
File path: docs/toc.html
##########
@@ -45,6 +45,10 @@
                 <li><a href="#producerconfigs">3.3 Producer Configs</a>
                 <li><a href="#consumerconfigs">3.4 Consumer Configs</a>
                 <li><a href="#connectconfigs">3.5 Kafka Connect Configs</a>
+                    <ul>
+                        <li><a href="#sourceconnectconfigs">Source Connector Configs</a>
+                        <li><a href="#sinkconnectconfigs">Sink Connector Configs</a>
+                    </ul>

Review comment:
       OK, I checked the other sub category links, like: 
    - https://kafka.apache.org/documentation/#os 
    - https://kafka.apache.org/documentation/#basic_ops_add_topic
   They all jump to the sub category directly, while there are still some paragraph above it. So, I agree with you. We can add sub TOC: `Source Connector Configs` and `Sink Connector Configs` into `Kafka Connect Configs`, and there keep the rest as is. 
   Thanks.




-- 
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: jira-unsubscribe@kafka.apache.org

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



[GitHub] [kafka] mimaison commented on a change in pull request #11794: MINOR: Add links to connector configs in TOC

Posted by GitBox <gi...@apache.org>.
mimaison commented on a change in pull request #11794:
URL: https://github.com/apache/kafka/pull/11794#discussion_r811030427



##########
File path: docs/toc.html
##########
@@ -45,6 +45,10 @@
                 <li><a href="#producerconfigs">3.3 Producer Configs</a>
                 <li><a href="#consumerconfigs">3.4 Consumer Configs</a>
                 <li><a href="#connectconfigs">3.5 Kafka Connect Configs</a>
+                    <ul>
+                        <li><a href="#sourceconnectconfigs">Source Connector Configs</a>
+                        <li><a href="#sinkconnectconfigs">Sink Connector Configs</a>
+                    </ul>

Review comment:
       I considered that but then both `Kafka Connect Configs` links would point to the same anchor. Also `Kafka Connect Configs` is one level higher (3.5) level than the other two sections (3.5.1 and 3.5.2).
   
   About adding `3.5.1` and `3.5.2`, we don't include numbers for sub categories, for example see `[Adding and removing topics](https://kafka.apache.org/documentation/#basic_ops_add_topic)` in the TOC, so I've kept it consistent with the other ones.




-- 
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: jira-unsubscribe@kafka.apache.org

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



[GitHub] [kafka] showuon commented on a change in pull request #11794: MINOR: Add links to connector configs in TOC

Posted by GitBox <gi...@apache.org>.
showuon commented on a change in pull request #11794:
URL: https://github.com/apache/kafka/pull/11794#discussion_r810744353



##########
File path: docs/toc.html
##########
@@ -45,6 +45,10 @@
                 <li><a href="#producerconfigs">3.3 Producer Configs</a>
                 <li><a href="#consumerconfigs">3.4 Consumer Configs</a>
                 <li><a href="#connectconfigs">3.5 Kafka Connect Configs</a>
+                    <ul>
+                        <li><a href="#sourceconnectconfigs">Source Connector Configs</a>
+                        <li><a href="#sinkconnectconfigs">Sink Connector Configs</a>
+                    </ul>

Review comment:
       It's good to have these 2 sub categories in TOC. But usually with this TOC, we will think there are only 2 categories under `3.5 Kafka Connect Configs`. However, there is another sub-category `Kafka Connect Configs` there. Do you think we can make the TOC as below:
   - 3.5 Kafka Connect Configs
      - Kafka Connect Configs
      - Source Connector Configs
      - Sink Connector Configs
   
   And maybe change `3.5.1` and `3.5.2` in front of `Source Connector Configs` and `Sink Connector Configs`. WDYT?




-- 
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: jira-unsubscribe@kafka.apache.org

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