Skip to content
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

Merged
merged 9 commits into from Feb 1, 2024

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Jan 9, 2024

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

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md
  • Supply screenshots for visual changes, such as Grafana dashboards

Signed-off-by: prmellor <pmellor@redhat.com>
Copy link
Member

@scholzj scholzj left a 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 <pmellor@redhat.com>
@PaulRMellor
Copy link
Contributor Author

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.

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 <pmellor@redhat.com>
Signed-off-by: prmellor <pmellor@redhat.com>
@k-wall
Copy link
Contributor

k-wall commented Jan 11, 2024

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.

@fvaleri
Copy link
Contributor

fvaleri commented Jan 11, 2024

I definitely vote for the three-columns format, as I always struggled with the current format.

Copy link
Member

@ppatierno ppatierno left a 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.

@mimaison
Copy link
Contributor

I find the 3 column format easier to read.

Signed-off-by: prmellor <pmellor@redhat.com>
PaulRMellor and others added 4 commits January 30, 2024 14:41
Signed-off-by: prmellor <pmellor@redhat.com>
Signed-off-by: prmellor <pmellor@redhat.com>
Signed-off-by: prmellor <pmellor@redhat.com>
Signed-off-by: Tom Bentley <tbentley@redhat.com>
@PaulRMellor PaulRMellor merged commit d7b58d0 into strimzi:main Feb 1, 2024
13 checks passed
adamj-m pushed a commit to jamesfarlow/strimzi-kafka-operator that referenced this pull request Feb 1, 2024
Signed-off-by: prmellor <pmellor@redhat.com>
Signed-off-by: Tom Bentley <tbentley@redhat.com>
Co-authored-by: Tom Bentley <tbentley@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants