NetAppDocs / cloudinsights

Cloud Insights Documentation
https://docs.netapp.com/us-en/cloudinsights/
5 stars 19 forks source link

fix notation in Inventory table (not a dupe) #2584

Closed ntap-bmegan closed 1 month ago

ntap-bmegan commented 2 months ago

Page URL

https://docs.netapp.com/us-en/cloudinsights/task_dc_oracle_zfs.html

Page title

Oracle ZFS Storage Appliance data collector

Summary

This is a different article with an inventory table, probably the same resolution.

image

Public issues must not contain sensitive information

netapp-alavoie commented 2 months ago

I'm not sure I understand. The steps in question are to possibly solve the error seen on the data collector, so in the context of this troubleshooting tip they seem to make sense.

I did change some formatting and spacing to better show the steps.

ntap-bmegan commented 2 months ago

The list notation is incorrect. The list should display with bullet symbols, not dashes.

First, you need an empty line before the list starts.

Second, it looks like you intend two list levels based on the current source:

* Correct the Analytics (statistic) scope for the user ${user} with the read only role:
- From the Configuration -> Users screen, put your mouse over the role and double click to allow editing
-   Select "Analytics" from the Scope drop down menu. A list of the possible properties appears.
-   Click the top most check box and it will select all three properties.
-   Click the Add button on the right side.
-   Click the Apply button at the top right of the pop-up window. The pop-up window will close.

If that's the case, then you can't use - list leaders because those only work - when they work, which they won't because of the missing blank line - for first-level list entries.

Third, based on the content, the - list leader should be . because that looks like it should be a numbered list.

Possible Solution:

* Correct the Analytics (statistic) scope for the user ${user} with the read only role:
.. From the Configuration -> Users screen, put your mouse over the role and double click to allow editing
.. Select "Analytics" from the Scope drop down menu. A list of the possible properties appears.
.. Click the top most check box and it will select all three properties.
.. Click the Add button on the right side.
.. Click the Apply button at the top right of the pop-up window. The pop-up window will close.

That leaves you with a singleton list entry at the first level, second-level list numbering (alpha), and a lot of wasted cell width.

A better approach is:

Possible Solution:

Correct the Analytics (statistic) scope for the user ${user} with the read only role.

. From the Configuration -> Users screen, put your mouse over the role and double click to allow editing
. Select "Analytics" from the Scope drop down menu. A list of the possible properties appears.
. Click the top most check box and it will select all three properties.
. Click the Add button on the right side.
. Click the Apply button at the top right of the pop-up window. The pop-up window will close.
netapp-alavoie commented 2 months ago

The "*" and "." bullets don't work in a table, unless I am missing something. I did re-do the steps and added manual numbers to them, which reads much more cleanly now.

ntap-bmegan commented 2 months ago

You need to allow AsciiDoc syntax in the column. See the table syntax article in the internal help site.

netapp-alavoie commented 1 month ago

Corrected the asciidoc formatting inside the table here.