-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(api): puts the api ref into three columns #9531
Conversation
Signed-off-by: prmellor <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original format seems more readable to me. It seems that in most parts, the description as the longest part gets only one third of the width. But in some tables it for whatever reason overflows outside of the window. Not sure what the motivation was for this, but it does not seem to be an improvement for me.
Signed-off-by: prmellor <[email protected]>
Thanks @jakub. I built using bccutil and the table widths were fine. I tried in asciidoctor (which I think you used) and only the KafkaClusterSpec table looked wrong. Were there any others? This was down to the formatting in the source code, which I fixed in the latest commit. I also added some proportional widths to the columns. I prefer the type on the same row, but if it's not popular, we can revert. Otherwise, maybe there's more that can be done to improve the presentation. |
Signed-off-by: prmellor <[email protected]>
crd-generator/src/main/java/io/strimzi/crdgenerator/DocGenerator.java
Outdated
Show resolved
Hide resolved
Signed-off-by: prmellor <[email protected]>
I'm an infrequent reader of the strimzi documentation. To me the three column layout is clearer/more obvious. With the two column version I think the reader can get lost, especially when looking at tables with more rows. |
I definitely vote for the three-columns format, as I always struggled with the current format. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. I prefer three columns.
I find the 3 column format easier to read. |
Signed-off-by: prmellor <[email protected]>
Signed-off-by: prmellor <[email protected]>
Signed-off-by: prmellor <[email protected]>
Signed-off-by: prmellor <[email protected]>
Signed-off-by: Tom Bentley <[email protected]>
Documentation
Updates DocGenerator to put the api reference guide tables into three columns: Property, Type and Description.
Puts mentions of the version a property was introduced to the start of a description.
Also removes the padding method (not needed or we can adjust through CSS)
Plus typo fix!
Checklist
Please go through this checklist and make sure all applicable tasks have been done