search

NetAppDocs / ontap-automation

https://docs.netapp.com/us-en/ontap-automation/
1 stars 2 forks source link

Unnecessary inconsistency in formation of lead paragraph #91

Closed adamn-netapp closed 7 months ago

adamn-netapp commented 7 months ago

Page URL

https://docs.netapp.com/us-en/ontap-automation/resources/snaplock.html

Page title

SnapLock

Summary

There are 17 topics under the "Summary of the REST resources" node in the sidebar. Setting aside the Overview topic, 15 of the remaining 16 topics have lead paragraphs that follow a reasonable pattern that begins with "You can use these API calls to...".

The SnapLock topic does not follow this same pattern, and I see no reason why it doesn't.

For consistency, we should update the lead paragraph to follow the pattern that the other 15 sibling topics use.

Public issues must not contain sensitive information

dmp-netapp commented 7 months ago

Thanks for your feedback. Actually I do include a sentence of the same pattern as all the other categories, but it's the second sentence in the lead (after an introductory sentence about SnapLock). Here's what I currently have: "SnapLock is a storage-based implementation of the traditional WORM (write once, read many) optical solution and provides for the long-term retention of data. You can use these API calls to administer the SnapLock feature." But at your request, I will remove the first sentence to make this lead paragraph consistent with the others.

dmp-netapp commented 7 months ago

The update is now live. Please open another issue if you feel this does not address your concerns.