Merge pull request #72 from NetApp/70-docs-example-contains-unquoted-…

…strings Fix documentation
NetApp · Nov 8, 2023 · 9465df8 · 9465df8
2 parents 3558fda + 32c8c47
commit 9465df8
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,10 @@
-## 1.0.0 (2023-09-18)
+
+## 1.0.1 ()
+
+BUG FIXES:
+* 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))
+
+## 1.0.0 (2023-11-06)
 
 NOTES
 

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1 @@
-* @carchi8py @chuyich @suhasbshekar @wenjun666
+* @carchi8py @chuyich @suhasbshekar @wenjun666
diff --git a/README.md b/README.md
@@ -35,10 +35,10 @@ go install
 Click on Issues, we have 6 categories for issues:
 1. Report a Bug -- for unexpected error, a crash, or otherwise incorrect behavior.
 2. Report a Documentation Error -- for error in our documentation, including typos, mistakes, or outdated information.
-3. Request an Enchantment -- For new fields to existing Resources or data sources 
+3. Request an Enhancement -- For new fields to existing Resources or data sources 
 4. Request a New Resource, Data Source, or Service 
 5. Other -- Any other issue that is not covered by the above categories.
 6. General Questions -- If you have any general question we have a Discord channel for that.
 
 ## Contributing
-Please read the [Contributing Guide](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
+Please read the [Contributing Guide](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
diff --git a/docs/data-sources/cluster_data_source.md b/docs/data-sources/cluster_data_source.md
@@ -9,8 +9,13 @@ description: |-
 # netapp-ontap_cluster_data_source (Data Source)
 
 Cluster data source
-
-
+## Example Usage
+```terraform
+data "netapp-ontap_cluster_data_source" "cluster" {
+  # required to know which system to interface with
+  cx_profile_name = "cluster2"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/data-sources/protocols_nfs_service_data_source.md b/docs/data-sources/protocols_nfs_service_data_source.md
@@ -1,5 +1,5 @@
 ---
-page_title: "ONTAP: NFS_Service "
+page_title: "ONTAP: NFS_Service 
 subcategory: "nas"
 description: |-
     Retrieves the NFS configuration of SVMs.

diff --git a/docs/data-sources/snapmirrors_data_source.md b/docs/data-sources/snapmirrors_data_source.md
@@ -15,7 +15,7 @@ data "netapp-ontap_snapmirrors_data_source" "snapmirrors" {
   # required to know which system to interface with
   cx_profile_name = "cluster4"
   filter = {
-    "destination_path" = "snapmirror_dest_svm*"
+    destination_path = "snapmirror_dest_svm*"
   }
 }
 ```

diff --git a/docs/data-sources/storage_volume_snapshots_data_source.md b/docs/data-sources/storage_volume_snapshots_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_storage_volume_snapshots_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "storage"
+subcategory: ""
 description: |-
   Retrieves a collection of volume Snapshot copies
 ---

diff --git a/docs/data-sources/svms_data_source.md b/docs/data-sources/svms_data_source.md
@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "netapp-ontap_svms_data_source Data Source - terraform-provider-netapp-ontap"
-subcategory: "svm"
+subcategory: "svms"
 description: |-
   Retrieves the configuration of SVMs.
 ---

diff --git a/docs/resources/networking_ip_route_resource.md b/docs/resources/networking_ip_route_resource.md
@@ -56,7 +56,7 @@ resource "netapp-ontap_networking_ip_route_resource" "networking_ip_route" {
 Optional:
 
 - `address` (String) IPv4 or IPv6 address
-- `netmask` (String) netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, valid range is 1 to 127.
+- `netmask` (Number) netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, valid range is 1 to 127.
 
 ## Import
 Import is currently not support for this Resource.
diff --git a/docs/resources/storage_volume_resource.md b/docs/resources/storage_volume_resource.md
@@ -20,8 +20,8 @@ Create/modify/delete a Volume resource
 ```terraform
 resource "netapp-ontap_storage_volume_resource" "example" {
   cx_profile_name = "cluster5"
-  name = vol1
-  svm_name = svm2
+  name = "vol1"
+  svm_name = "svm2"
   aggregates = [
     {
       name = "aggr2"
@@ -34,9 +34,9 @@ resource "netapp-ontap_storage_volume_resource" "example" {
     type = "non_snaplock"
   }
   space = {
-	size = 30
-	size_unit = "mb"
-	percent_snapshot_space = 20
+	  size = 30
+	  size_unit = "mb"
+	  percent_snapshot_space = 20
     logical_space = {
       enforcement = true
       reporting = true
@@ -51,7 +51,7 @@ resource "netapp-ontap_storage_volume_resource" "example" {
     user_id = 20
     unix_permissions = "755"
     security_style = "mixed"
-	junction_path = "/testacc"
+	  junction_path = "/testacc"
   }
 }
 ```