Merge pull request #170 from NetApp/169-doc-check-review-subcategory-…

…and-support-platform-for-each-module doc update
NetApp · Apr 17, 2024 · 97ff740 · 97ff740
2 parents 33b3bf4 + 7050950
commit 97ff740
Show file tree

Hide file tree

Showing 52 changed files with 179 additions and 70 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -58,6 +58,7 @@ ENHANCEMENTS:
 
 BUG FIXES:
 * **netapp-ontap_protocols_nfs_service**: Fixed issue with version check failing for minor versions
+* netapp-ontap resource and data source documentation update ([#169](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/169))
 
 
 ## 1.0.3 (2023-12-05)

diff --git a/docs/data-sources/protocols_cifs_local_group_data_source.md b/docs/data-sources/protocols_cifs_local_group_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_local_group_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieve CifsLocalGroup data source
 ---

diff --git a/docs/data-sources/protocols_cifs_local_group_member_data_source.md b/docs/data-sources/protocols_cifs_local_group_member_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_local_group_member_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieve CifsLocalGroupMember data source
 ---

diff --git a/docs/data-sources/protocols_cifs_local_group_members_data_source.md b/docs/data-sources/protocols_cifs_local_group_members_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_local_group_members_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieve CifsLocalGroupMembers data source
 ---

diff --git a/docs/data-sources/protocols_cifs_local_groups_data_source.md b/docs/data-sources/protocols_cifs_local_groups_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_local_groups_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieves list of Cifs Local Groups.
 ---

diff --git a/docs/data-sources/protocols_cifs_local_user_data_source.md b/docs/data-sources/protocols_cifs_local_user_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_local_user_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieve CifsLocalUser data source
 ---

diff --git a/docs/data-sources/protocols_cifs_local_users_data_source.md b/docs/data-sources/protocols_cifs_local_users_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_local_users_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieves list of Cifs Local Users.
 ---

diff --git a/docs/data-sources/protocols_cifs_service_data_source.md b/docs/data-sources/protocols_cifs_service_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_service_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieve Cifs Service data source
 ---

diff --git a/docs/data-sources/protocols_cifs_services_data_source.md b/docs/data-sources/protocols_cifs_services_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_services_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: ""
+subcategory: "NAS"
 description: |-
   Retrieve Cifs Services data source
 ---

diff --git a/docs/data-sources/protocols_cifs_share_data_source.md b/docs/data-sources/protocols_cifs_share_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_share_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   ProtocolsCIFSShare data source
 ---

diff --git a/docs/data-sources/protocols_cifs_shares_data_source.md b/docs/data-sources/protocols_cifs_shares_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_shares_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   ProtocolsCIFSShares data source
 ---

diff --git a/docs/data-sources/protocols_cifs_user_group_privilege_data_source.md b/docs/data-sources/protocols_cifs_user_group_privilege_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_user_group_privilege_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieve CifsUserGroupPrivilege data source
 ---

diff --git a/docs/data-sources/protocols_cifs_user_group_privileges_data_source.md b/docs/data-sources/protocols_cifs_user_group_privileges_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_user_group_privileges_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Retrieve CifsUserGroupPrivileges data source
 ---

diff --git a/docs/data-sources/protocols_san_igroup_data_source.md b/docs/data-sources/protocols_san_igroup_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_san_igroup_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "san"
+subcategory: "SAN"
 description: |-
   ProtocolsSanIgroup data source
 ---

diff --git a/docs/data-sources/protocols_san_igroups_data_source.md b/docs/data-sources/protocols_san_igroups_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_san_igroups_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "san"
+subcategory: "SAN"
 description: |-
   ProtocolsSanIgroups data source
 ---

diff --git a/docs/data-sources/protocols_san_lun-map_data_source.md b/docs/data-sources/protocols_san_lun-map_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_san_lun-map_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "san"
+subcategory: "SAN"
 description: |-
   ProtocolsSanLunMap data source
 ---

diff --git a/docs/data-sources/protocols_san_lun-maps_data_source.md b/docs/data-sources/protocols_san_lun-maps_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_san_lun-maps_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "san"
+subcategory: "SAN"
 description: |-
   ProtocolsSanLunMaps data source
 ---

diff --git a/docs/data-sources/storage_flexcache_data_source.md b/docs/data-sources/storage_flexcache_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_storage_flexcache_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "storage"
+subcategory: "Storage"
 description: |-
   Flexcache data source
 ---

diff --git a/docs/data-sources/storage_flexcaches_data_source.md b/docs/data-sources/storage_flexcaches_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_storage_flexcaches_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "storage"
+subcategory: "Storage"
 description: |-
   Flexcaches data source
 ---

diff --git a/docs/resources/cluster_licensing_license_resource.md b/docs/resources/cluster_licensing_license_resource.md
@@ -11,8 +11,13 @@ description: |-
 Add/Remove License from ONTAP
 
 ### Related ONTAP commands
+```commandline
 * system license add
 * system license delete
+```
+
+## Supported Platforms
+* On-perm ONTAP system 9.6 or higher
 
 ## Example Usage
 Example when using a license string

diff --git a/docs/resources/cluster_peers_resource.md b/docs/resources/cluster_peers_resource.md
@@ -10,9 +10,14 @@ description: |-
 Create/Modify/Delete a cluster peer.
 
 ### Related ONTAP commands
+```commandline
 * cluster peer create
 * cluster peer modify
 * cluster peer delete
+```
+
+## Supported Platforms
+* On-perm ONTAP system 9.6 or higher
 
 ## Example Usage
 

diff --git a/docs/resources/cluster_schedule_resource.md b/docs/resources/cluster_schedule_resource.md
@@ -9,6 +9,15 @@ description: |-
 
 Create/Modify/Delete a job schedule in a cluster.
 
+### Related ONTAP commands
+```commandline
+* job schedule cron create
+* job schedule interval create
+* job schedule delete
+* job schedule cron modify
+* job schedule interval modify
+```
+
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher
 * Amazon FSx for NetApp ONTAP

diff --git a/docs/resources/name_services_dns_resource.md b/docs/resources/name_services_dns_resource.md
@@ -8,7 +8,15 @@ description: |-
 
 # Resource DNS
 
-Create, Modify, Delete and Import a name services DNS resource
+Create/Modify/Delete and Import a name services DNS resource
+
+### Related ONTAP commands
+```commandline
+* vserver services name-service dns create
+* vserver services name-service dns create
+* vserver services name-service dns show
+* vserver services name-service dns delete
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/resources/name_services_ldap_resource.md b/docs/resources/name_services_ldap_resource.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_name_services_ldap_resource Resource - terraform-provider-netapp-ontap"
-subcategory: "name-services"
+subcategory: "Name-Services"
 description: |-
   Name Services LDAP resource
 ---
@@ -10,6 +10,14 @@ description: |-
 
 Create/Modify/Delete an LDAP configuration for an SVM
 
+### Related ONTAP commands
+```commandline
+* vserver services name-service ldap create
+* vserver services name-service ldap show
+* vserver services name-service ldap delete
+* vserver services name-service ldap modify
+```
+
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher
 

diff --git a/docs/resources/networking_ip_interface_resource.md b/docs/resources/networking_ip_interface_resource.md
@@ -10,10 +10,15 @@ description: |-
 
 Create/Update/Delete an IPInterface resource
 
-#Related ONTAP commands
+### Related ONTAP commands
+```commandline
 * network interface create
 * network interface modify
 * network interface delete
+```
+
+## Supported Platforms
+* On-perm ONTAP system 9.6 or higher
 
 ## Example Usage
 

diff --git a/docs/resources/networking_ip_route_resource.md b/docs/resources/networking_ip_route_resource.md
@@ -11,8 +11,10 @@ description: |-
 Create/Delete an IP Route resource
 
 ### Related ONTAP commands
+```commandline
 * network route create
 * network route delete
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/resources/protocols_cifs_local_group_member_resource.md b/docs/resources/protocols_cifs_local_group_member_resource.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_local_group_member_resource Resource - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   CifsLocalGroupMember resource
 ---

diff --git a/docs/resources/protocols_cifs_local_group_resource.md b/docs/resources/protocols_cifs_local_group_resource.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "ONTAP: Local Group"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Cifs Local Group resource
 ---
@@ -11,10 +11,12 @@ description: |-
 Create/Modify/Delete a Local Group resource
 
 ### Related ONTAP commands
+```commandline
 * vserver cifs users-and-groups local-group create
 * vserver cifs users-and-groups local-group modify
 * vserver cifs users-and-groups local-group rename
 * vserver cifs users-and-groups local-group delete
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

diff --git a/docs/resources/protocols_cifs_local_user_resource.md b/docs/resources/protocols_cifs_local_user_resource.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "ONTAP: Local User"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   Cifs Local User resource
 ---
@@ -11,11 +11,13 @@ description: |-
 Create/Modify/Delete a Local User resource
 
 ### Related ONTAP commands
+```commandline
 vserver cifs users-and-groups local-user create
 vserver cifs users-and-groups local-user modify
 vserver cifs users-and-groups local-user rename
 vserver cifs users-and-groups local-user set-password
 vserver cifs users-and-groups local-user delete
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

diff --git a/docs/resources/protocols_cifs_service_resource.md b/docs/resources/protocols_cifs_service_resource.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_protocols_cifs_service_resource Resource - terraform-provider-netapp-ontap"
-subcategory: "nas"
+subcategory: "NAS"
 description: |-
   CifsService resource
 ---
@@ -11,13 +11,15 @@ description: |-
 Create/Modify/Delete a CIFS service resource
 
 ### Related ONTAP commands
+```commandline
 * vserver cifs server create
 * vserver cifs server options modify
 * vserver cifs security modify
 * vserver cifs server add-netbios-aliases
 * vserver cifs server modify
 * vserver cifs server remove-netbios-aliases
 * vserver cifs server delete
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/resources/protocols_cifs_user_group_privilege_resource.md b/docs/resources/protocols_cifs_user_group_privilege_resource.md
@@ -10,9 +10,11 @@ description: |-
 Create, Modify, Delete and Import protocols cifs user local privilege resource
 
 ### Related ONTAP commands
+```commandline
 vserver cifs users-and-groups privilege show
 vserver cifs users-and-groups privilege add-privilege
 vserver cifs users-and-groups privilege reset-privilege
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10.1 or higher

diff --git a/docs/resources/protocols_nfs_export_policy_resource.md b/docs/resources/protocols_nfs_export_policy_resource.md
@@ -9,9 +9,11 @@ description: |-
 Create/Modify/Delete an Export policy resource
 
 ### Related ONTAP commands
+```commandline
 * vserver export-policy create
 * vserver export-policy delete
 * vserver export-policy rename
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/resources/protocols_nfs_export_policy_rule_resource.md b/docs/resources/protocols_nfs_export_policy_rule_resource.md
@@ -10,9 +10,11 @@ description: |-
 Export policy rule resource
 
 ### Related ONTAP commands
+```commandline
 * vserver export-policy rule create
 * vserver export-policy rule modify
 * vserver export-policy rule delete
+```
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher