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 2020/06/16 13:38:29 UTC
[GitHub] [kafka] tombentley opened a new pull request #8878: MINOR: Generator config-specific HTML ids
tombentley opened a new pull request #8878:
URL: https://github.com/apache/kafka/pull/8878
Currently the docs have HTML ids for each config key. That doesn't work
correctly for config keys like bootstrap.servers which occur across
producer, consumer, admin configs: We generate duplicate ids. So arrange
for each config to prefix the ids it generates with the HTML id of its
section heading.
----------------------------------------------------------------
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] [kafka] joel-hamill commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
joel-hamill commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-656205597
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] omkreddy commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
omkreddy commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-670626828
ok to test
----------------------------------------------------------------
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] [kafka] tombentley commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
tombentley commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-670404348
Thinking about, it we could avoid breaking existing links by generating both old and new style ids: `<a id=oldId></a><a id=newId href=#newId>whatever.config.name</a>`. WDYT @mimaison @omkreddy?
----------------------------------------------------------------
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] [kafka] omkreddy commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
omkreddy commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-656246737
I agree, it's a useful fix. I think its OK to break existing links. I have not seen anywhere using those links. Lets see what others think.
----------------------------------------------------------------
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] [kafka] omkreddy commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
omkreddy commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-694129604
retest this please
----------------------------------------------------------------
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] [kafka] tombentley commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
tombentley commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-693954974
@mimaison @omkreddy could one of you do the build again?
----------------------------------------------------------------
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] [kafka] omkreddy merged pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
omkreddy merged pull request #8878:
URL: https://github.com/apache/kafka/pull/8878
----------------------------------------------------------------
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] [kafka] tombentley commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
tombentley commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-694425788
@omkreddy I fixed a failing test. The rest look unrelated. Could you trigger the build again please?
----------------------------------------------------------------
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] [kafka] mimaison commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
mimaison commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-645861700
I think it's a useful fix but it's worth noting it will break all existing links. These links were only added a couple of releases ago too, so it's probably acceptable.
----------------------------------------------------------------
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] [kafka] mimaison commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
mimaison commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-656062630
@omkreddy @ijuma What's your opinion on this change? Currently a number of config links collide and this is addressing it. However this will also break existing links.
----------------------------------------------------------------
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] [kafka] tombentley commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
tombentley commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-669856151
@omkreddy any progress on this?
----------------------------------------------------------------
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] [kafka] tombentley commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
tombentley commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-645868566
Another thought I had about improving the docs (though not for this PR) would be to have an index of links in alphabetical order at the start of each section (e.g. after "Broker Configs" header and before the table). This would make it much simpler to find a specific config (if you knew its name). Currently you can click on the top level ToC to get to, e.g., the "Broker Configs" section, but then have to scroll for pages searching (and they're not in alphabetical order) until you find the one you want. With an index it would be two clicks, one (binary) search of a sorted list and no scrolling. We might not want this for all configs, but for the longer ones I think it would be valuable.
----------------------------------------------------------------
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] [kafka] tombentley commented on pull request #8878: MINOR: Generator config-specific HTML ids
Posted by GitBox <gi...@apache.org>.
tombentley commented on pull request #8878:
URL: https://github.com/apache/kafka/pull/8878#issuecomment-644772529
@mimaison I know you added the per-config-key anchors. Please could you take a look at attempt to disambiguate the current situation with duplicated ids.
----------------------------------------------------------------
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