fix snapmirror resource doc and docs adjustment

NetApp · Oct 31, 2024 · 4eafb25 · 4eafb25
1 parent 6911012
commit 4eafb25
Show file tree

Hide file tree

Showing 111 changed files with 114 additions and 226 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -142,10 +142,11 @@ ENHANCEMENTS:
 DOC FIXES:
 * **netapp-ontap_storage_flexcache_resource**: Fixed Page display issue ([[#271](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/271)])
 * **netapp-ontap_networking_ip_interface_resource**: Include min version for metrics ([[#265](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/265)])
+* Fix the documentation: snapmirror and the description of other data source and resource ([[#330](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/330)])
 
 BUG FIXES:
-* **netapp-ontap_cluster_data_source: fix on nodes to show multiple elements ([#264](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/264))
-* **netapp-ontap_protocols_nfs_export_policy_resource: fix id error during the creation ([[#290](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/290)])
+* **netapp-ontap_cluster_data_source**: fix on nodes to show multiple elements ([#264](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/264))
+* **netapp-ontap_protocols_nfs_export_policy_resource**: fix id error during the creation ([[#290](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/290)])
 
 ## 1.1.3 (2024-08-08)
 
@@ -165,7 +166,7 @@ BUG FIXES:
 * corrected typos in the CHANGELOG.
 
 BUG FIXES:
-* netapp-ontap_storage_flexcache_resource: Fixed junction_path bug ([#223](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/223))
+* **netapp-ontap_storage_flexcache_resource**: Fixed junction_path bug ([#223](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/223))
 
 ## 1.1.1 (2024-05-15)
 
@@ -251,9 +252,9 @@ BUG FIXES:
 ## 1.0.1 (2023-11-17)
 
 BUG FIXES:
-* netapp-ontap_name_services_dns_resource: Fixed and Documented Import ([#63](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/63))
-* netapp-ontap_cluster_data_source, netapp-ontap_snapmirrors_data_source, netapp-ontap_networking_ip_route_resource and netapp-ontap_sotrage_volume_resource: Fix documentation ([#70](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/70))
-* netapp-ontap_name_services_ldap_resource: Fixed and Document with the version check and workflow ([#163](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/163))
+* **netapp-ontap_name_services_dns_resource**: Fixed and Documented Import ([#63](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/63))
+* **netapp-ontap_cluster_data_source**, **netapp-ontap_snapmirrors_data_source**, **netapp-ontap_networking_ip_route_resource** and **netapp-ontap_sotrage_volume_resource**: Fix documentation ([#70](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/70))
+* **netapp-ontap_name_services_ldap_resource**: Fixed and Document with the version check and workflow ([#163](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/163))
 
 
 ## 1.0.0 (2023-11-06)

diff --git a/docs/data-sources/cluster.md b/docs/data-sources/cluster.md
@@ -6,8 +6,7 @@ description: |-
   Cluster data source
 ---
 
-# netapp-ontap_cluster (Data Source)
-
+# Data Source cluster 
 Retrieve the details of a cluster data source
 
 ### Related ONTAP commands

diff --git a/docs/data-sources/cluster_licensing_license_data_source.md b/docs/data-sources/cluster_licensing_license_data_source.md
@@ -5,13 +5,14 @@ description: |-
   ClusterLicensingLicense data source
 ---
 
-# Netapp Ontap Cluster Licensing License Data Source
+# Data Source cluster licensing license
+Retrieves Cluster Licensing License
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher
 * Amazon FSx for NetApp ONTAP
 
-ClusterLicensingLicense data source
+
 ## Example Usage
 ```terraform
 data "netapp-ontap_cluster_licensing_license" "cluster_licensing_license" {

diff --git a/docs/data-sources/cluster_licensing_licenses_data_source.md b/docs/data-sources/cluster_licensing_licenses_data_source.md
@@ -5,13 +5,13 @@ description: |-
   ClusterLicensingLicenses data source
 ---
 
-# Netapp Ontap Cluster Licensing Licenses Data Source
+# Data Source cluster licensing licenses
+Retrieves Cluster Licensing Licenses
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher
 * Amazon FSx for NetApp ONTAP
 
-ClusterLicensingLicenses data source
 ## Example Usage
 ```terraform
 data "netapp-ontap_cluster_licensing_licenses" "cluster_licensing_licenses" {

diff --git a/docs/data-sources/cluster_peer_data_source.md b/docs/data-sources/cluster_peer_data_source.md
@@ -6,8 +6,7 @@ description: |-
   ClusterPeer data source
 ---
 
-# Data Source cluster_peer
-
+# Data Source cluster peer
 Retrieves an existing cluster_peer
 
 ## Supported Platforms

diff --git a/docs/data-sources/cluster_peers_data_source.md b/docs/data-sources/cluster_peers_data_source.md
@@ -6,8 +6,7 @@ description: |-
   ClusterPeers data source
 ---
 
-# Data Source cluster_peers
-
+# Data Source cluster peers
 Retrieves existing cluster_peers
 
 ## Supported Platforms

diff --git a/docs/data-sources/cluster_schedule_data_source.md b/docs/data-sources/cluster_schedule_data_source.md
@@ -6,8 +6,7 @@ description: |-
   Retrieves Cluster Schedule configuration of SVMs.
 ---
 
-# Data Source cluster_schedule
-
+# Data Source cluster schedule
 Retrieves Cluster Schedule configuration of SVMs.
 
 ## Supported Platforms

diff --git a/docs/data-sources/cluster_schedules_data_source.md b/docs/data-sources/cluster_schedules_data_source.md
@@ -6,8 +6,7 @@ description: |-
   Retrieves list of Cluster Schedules configuration of SVMs.
 ---
 
-# Data Source cluster_schedules
-
+# Data Source cluster schedules
 Retrieves list of Cluster Schedules configuration of SVMs.
 
 ## Supported Platforms

diff --git a/docs/data-sources/name_services_dns_data_source.md b/docs/data-sources/name_services_dns_data_source.md
@@ -5,8 +5,7 @@ description: |-
   Retrieves the DNS Configuration of an SVM.
 ---
 
-# Data Source dns
-
+# Data Source DNS
 Retrieves the DNS Configuration of an SVM.
 
 ## Supported Platforms

diff --git a/docs/data-sources/name_services_dnss_data_source.md b/docs/data-sources/name_services_dnss_data_source.md
@@ -5,8 +5,7 @@ description: |-
   Retrieves the DNSs Configuration of SVMs.
 ---
 
-# Data Source dnss
-
+# Data Source DNSs
 Retrieves the DNSs Configuration of an SVMs.
 
 ## Supported Platforms

diff --git a/docs/data-sources/name_services_ldap_data_source.md b/docs/data-sources/name_services_ldap_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieve LDAP data source of a SVM
 ---
 
-# Data source netapp-ontap_name_services_ldap
-
-Retrieve LDAP data source of a SVM
+# Data Source name_services_ldap
+Retrieves LDAP data source of a SVM
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/data-sources/name_services_ldaps_data_source.md b/docs/data-sources/name_services_ldaps_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieve LDAP data source of SVMs
 ---
 
-# netapp-ontap_name_services_ldaps (Data Source)
-
-Retrieve LDAP data source of SVMs
+# Data Source name_services_ldaps
+Retrieves LDAP data source of SVMs
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/data-sources/networking_ip_interface_data_source.md b/docs/data-sources/networking_ip_interface_data_source.md
@@ -7,7 +7,6 @@ description: |-
 ---
 
 # Data Source ip_interface
-
 Retrieves the details of IP interface of SVMs.
 
 ## Supported Platforms

diff --git a/docs/data-sources/networking_ip_interfaces_data_source.md b/docs/data-sources/networking_ip_interfaces_data_source.md
@@ -6,8 +6,7 @@ description: |-
   Retrieves the details of IP interfaces of SVMs.
 ---
 
-# Data Source ip_interfaces
-
+# Data Source network_ip_interfaces
 Retrieves the details of IP interfaces of SVMs.
 
 ## Supported Platforms

diff --git a/docs/data-sources/networking_ip_route_data_source.md b/docs/data-sources/networking_ip_route_data_source.md
@@ -6,8 +6,7 @@ description: |-
   Retrieves the IP route of SVMs.
 ---
 
-# Data Source ip_route
-
+# Data Source network_ip_route
 Retrieves the IP route of SVMs.
 
 ## Supported Platforms

diff --git a/docs/data-sources/networking_ip_routes_data_source.md b/docs/data-sources/networking_ip_routes_data_source.md
@@ -6,8 +6,7 @@ description: |-
   Retrieves the IP routes of SVMs.
 ---
 
-# Data Source ip_routes
-
+# Data Source network_ip_routes
 Retrieves the IP routes of SVMs.
 
 ## Supported Platforms

diff --git a/docs/data-sources/protocols_cifs_local_group_data_source.md b/docs/data-sources/protocols_cifs_local_group_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieve CifsLocalGroup data source
 ---
 
-# Data Source ontap_cifs_local_group
-
-Retrieves protocols cifs local group configuration
+# Data Source cifs_local_group
+Retrieves cifs local group configuration
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

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
@@ -6,9 +6,8 @@ description: |-
   Retrieve CifsLocalGroupMember data source
 ---
 
-# Data source netapp-ontap_cifs_local_group_member
-
-Retreives protocols cifs local group member configuration
+# Data Source cifs_local_group_member
+Retreives cifs local group member configuration
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

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
@@ -6,9 +6,8 @@ description: |-
   Retrieve CifsLocalGroupMembers data source
 ---
 
-# Data source netapp-ontap_cifs_local_group_members
-
-Retreives protocols cifs local group members configuration
+# Data Source cifs_local_group_members
+Retreives cifs local group members configuration
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

diff --git a/docs/data-sources/protocols_cifs_local_groups_data_source.md b/docs/data-sources/protocols_cifs_local_groups_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieves list of Cifs Local Groups.
 ---
 
-# Data Source protocols_cifs_local_groups
-
-Retrieves list of Cifs Local Groups.
+# Data Source cifs_local_groups
+Retrieves list of Cifs Local Groups
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

diff --git a/docs/data-sources/protocols_cifs_local_user_data_source.md b/docs/data-sources/protocols_cifs_local_user_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieve CifsLocalUser data source
 ---
 
-# Data Source netapp-ontap_cifs_local_user
-
-Retreives protocols cifs local user configuration
+# Data Source cifs_local_user
+Retreives cifs local user configuration
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

diff --git a/docs/data-sources/protocols_cifs_local_users_data_source.md b/docs/data-sources/protocols_cifs_local_users_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieves list of Cifs Local Users.
 ---
 
-# Data Source protocols_cifs_local_users
-
-Retrieves a list of Cifs Local Users.
+# Data Source cifs_local_users
+Retrieves a list of Cifs Local Users
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10 or higher

diff --git a/docs/data-sources/protocols_cifs_service_data_source.md b/docs/data-sources/protocols_cifs_service_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieve Cifs Service data source
 ---
 
-# Data Source netapp-ontap_cifs_service
-
-Retrieves protocols cifs service data source
+# Data Source cifs_service
+Retrieves cifs service data
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/data-sources/protocols_cifs_services_data_source.md b/docs/data-sources/protocols_cifs_services_data_source.md
@@ -6,9 +6,8 @@ description: |-
   Retrieve Cifs Services data source
 ---
 
-# Data Source netapp-ontap_cifs_services
-
-Retrieve Cifs Services data source
+# Data Source cifs_services
+Retrieve Cifs Services data
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/data-sources/protocols_cifs_share_data_source.md b/docs/data-sources/protocols_cifs_share_data_source.md
@@ -6,8 +6,7 @@ description: |-
   ProtocolsCIFSShare data source
 ---
 
-# netapp-ontap_cifs_share (Data Source)
-
+# Data Source cifs_share
 Retrieves the details of a cifs share
 
 ### Related ONTAP commands

diff --git a/docs/data-sources/protocols_cifs_shares_data_source.md b/docs/data-sources/protocols_cifs_shares_data_source.md
@@ -6,8 +6,7 @@ description: |-
   ProtocolsCIFSShares data source
 ---
 
-# netapp-ontap_cifs_shares (Data Source)
-
+# Data Source cifs_shares
 Retrieves the details of one or more cifs shares by filter
 
 ### Related ONTAP commands

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
@@ -6,9 +6,8 @@ description: |-
   Retrieve CifsUserGroupPrivilege data source
 ---
 
-# Data Source netapp-ontap_cifs_user_group_privilege
-
-Retrieve Protocol Cifs User or Group Privilege data source
+# Data Source cifs_user_group_privilege
+Retrieves Protocol Cifs User or Group Privilege data source
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10.1 or higher

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
@@ -6,9 +6,8 @@ description: |-
   Retrieve CifsUserGroupPrivileges data source
 ---
 
-# Data Source netapp-ontap_cifs_user_group_privileges ()
-
-Retrieve Protocol Cifs User or Group Privileges data source
+# Data Source cifs_user_group_privileges
+Retrieves Cifs User or Group Privileges data source
 
 ## Supported Platforms
 * On-perm ONTAP system 9.10.1 or higher

diff --git a/docs/data-sources/protocols_nfs_export_policies_data_source.md b/docs/data-sources/protocols_nfs_export_policies_data_source.md
@@ -6,8 +6,7 @@ description: |-
 ---
 
 # Data source NFS Export Policies
-
-ExportPolicies data source
+Retrieves nfs export policies
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/data-sources/protocols_nfs_export_policy_data_source.md b/docs/data-sources/protocols_nfs_export_policy_data_source.md
@@ -5,9 +5,8 @@ description: |-
   NFS Export Policy Data source
 ---
 
-# Data source NFS Export Policy
-
-NFS Export Policy Data source
+# Data Source NFS Export Policy
+Retrieves NFS Export Policy Data source
 
 ## Supported Platforms
 * On-perm ONTAP system 9.6 or higher

diff --git a/docs/data-sources/protocols_nfs_export_policy_rule_data_source.md b/docs/data-sources/protocols_nfs_export_policy_rule_data_source.md
@@ -6,8 +6,7 @@ description: |-
   Retrieves an export policy rule of SVMs
 ---
 
-# Data Source protocols_nfs_export_policy_rule
-
+# Data Source nfs_export_policy_rule
 Retrieves an export policy rule of SVMs
 
 ## Supported Platforms

diff --git a/docs/data-sources/protocols_nfs_export_policy_rules_data_source.md b/docs/data-sources/protocols_nfs_export_policy_rules_data_source.md
@@ -6,8 +6,7 @@ description: |-
   Retrieves an export policy rules of SVMs
 ---
 
-# Data Source protocols_nfs_export_policy_rules
-
+# Data Source nfs_export_policy_rules
 Retrieves an export policy rules of SVMs
 
 ## Supported Platforms

diff --git a/docs/data-sources/protocols_nfs_service_data_source.md b/docs/data-sources/protocols_nfs_service_data_source.md
@@ -6,7 +6,6 @@ description: |-
 ---
 
 # Data Source nfs_service
-
 Retrieves the NFS configuration of SVMs.
 
 ## Supported Platforms