NetAppDocs / oncommand-insight

https://docs.netapp.com/us-en/oncommand-insight/
0 stars 0 forks source link

This table isn't a table #40

Open ntap-bmegan opened 1 month ago

ntap-bmegan commented 1 month ago

Page URL

https://docs.netapp.com/us-en/oncommand-insight/config-admin/reference_data_collector_support_matrix.html

Page title

OCI Data Collector Support Matrix

Summary

https://docs.netapp.com/us-en/oncommand-insight/config-admin/reference_data_collector_support_matrix.html#vmware-vsphere-web-services

image

There is no valid use case for a single-column table, particularly one where there's a header and a single data cell with soft-return (single Enter rather than double) lines.

This literally broke our translation system. Take it out of the table and put it into an unordered list. Use a block title for the heading.

Public issues must not contain sensitive information

netapp-alavoie commented 1 month ago

I believe I have corrected the three instances where we had a single-column table. The first two--with one row in each--I made an unordered list. The VMware one noted above I turned into a two-column table, since there were a large number of rows.

ntap-bmegan commented 1 month ago

It's not tabular data and does not belong in a table. Making it two parallel columns does not turn it into tabular data. If you are concerned about the length on page, look into a tabbed block or s series of collapsible sections separating the releases.

netapp-alavoie commented 1 month ago

I think I've fund a solution that works. Since there are multiple builds per API version, we can build the table like this:

== VMware vSphere (Web Services) :description: Support Matrix Asciidoc for VMware vSphere (Web Services)

Models and versions supported by this data collector: |=== <.<|API version |Build

.4+|VMware vCenter Server 5.5.0 |build-1750787 |build-3252642 |build-4180647 |build-9911218 .6+|VMware vCenter Server 6.0.0 |build-13638472 |build-14510545 |build-4541947 |build-5318200 |build-9313458 |build-10964411 ...

This gives us a better visualization of the data than an unordered list in the case of the VMware entry.

ntap-bmegan commented 1 month ago

We don't support :description:.

I've no idea what <.< does so don't recommend its use as it could affect downstream processing.

Tables should not be used for page layout. Splitting the release number from the build number just barely technically qualifies.

netapp-alavoie commented 1 month ago

Thanks for those clarifications, Megan! I'll address these.

I'm also creating a bug for my acquisition people to fix the table--they provide me with an .adoc file built from their sources, which I want to be as clean as possible before I integrate it into the docs. This was a first stab of this matrix for OCI based on what we're doing for CI (which likely also will therefore need to change, based on your information here).