Merge pull request #336 from NetApp/335-docs-typo-on-the-documents

fix typo and markdown format

Author: carchi8py

CHANGELOG.md

@@ -3,6 +3,7 @@
 BREAKING CHANGES:
 
 Cluster
+
 * **Rename Resource:** `netapp-ontap_cluster_licensing_license_resource` is now renamed to `netapp-ontap_cluster_licensing_license`
 * **Rename Resource:** `netapp-ontap_cluster_peers_resource` is now renamed to `netapp-ontap_cluster_peer`
 * **Rename Resource:** `netapp-ontap_cluster_schedule_resource` is now renamed to `netapp-ontap_cluster_schedule`
@@ -14,6 +15,7 @@ Cluster
 * **Rename Data Source:** `netapp-ontap_cluster_schedules_data_source` is now renamed to `netapp-ontap_cluster_schedules`
 
 Name Services
+
 * **Rename Resource:** `netapp-ontap_name_services_dns_resource` is now renamed to `netapp-ontap_dns`
 * **Rename Resource:** `netapp-ontap_name_services_ldap_resource` is now renamed to `netapp-ontap_name_services_ldap`
 * **Rename Data Source:** `netapp-ontap_name_services_dns_data_source` is now renamed to `netapp-ontap_dns`
@@ -22,6 +24,7 @@ Name Services
 * **Rename Data Source:** `netapp-ontap_name_services_ldaps_data_source` is now renamed to `netapp-ontap_name_services_ldaps`
 
 Networking
+
 * **Rename Resource:** `netapp-ontap_networking_ip_interface_resource` is now renamed to `netapp-ontap_network_ip_interface`
 * **Rename Resource:** `netapp-ontap_networking_ip_route_resource` is now renamed to `netapp-ontap_network_ip_route`
 * **Rename Data Source:** `netapp-ontap_networking_ip_interface_data_source` is now renamed to `netapp-ontap_network_ip_interface`
@@ -30,6 +33,7 @@ Networking
 * **Rename Data Source:** `netapp-ontap_networking_ip_routes_data_source` is now renamed to `netapp-ontap_network_ip_routes`
 
 Protocols
+
 * **Rename Resource:** `netapp-ontap_cifs_local_group_member_resource` is now renamed to `netapp-ontap_cifs_local_group_members`
 * **Rename Resource:** `netapp-ontap_cifs_local_group_resource` is now renamed to `netapp-ontap_cifs_local_group`
 * **Rename Resource:** `netapp-ontap_cifs_local_user_resource` is now renamed to `netapp-ontap_cifs_local_user`
@@ -66,11 +70,13 @@ Protocols
 * **Rename Data Source:** `netapp-ontap_san_lun-maps_data_source` is now renamed to `netapp-ontap_san_lun-maps`
 
 Security
+
 * **Rename Resource:** `netapp-ontap_security_accounts_resource` is now renamed to `netapp-ontap_security_account`
 * **Rename Data Source:** `netapp-ontap_security_account_data_source` is now renamed to `netapp-ontap_security_account`
 * **Rename Data Source:** `netapp-ontap_security_accounts_data_source` is now renamed to `netapp-ontap_security_accounts`
 
 Snapmirror
+
 * **Rename Resource:** `netapp-ontap_snapmirror_resource` is now renamed to `netapp-ontap_snapmirror`
 * **Rename Resource:** `netapp-ontap_snapmirror_policy_resource` is now renamed to `netapp-ontap_snapmirror_policy`
 * **Rename Data Source:** `netapp-ontap_snapmirror_data_source` is now renamed to `netapp-ontap_snapmirror`
@@ -79,6 +85,7 @@ Snapmirror
 * **Rename Data Source:** `netapp-ontap_snapmirror_policies_data_source` is now renamed to `netapp-ontap_snapmirror_policies`
 
 Storage
+
 * **Rename Resource:** `netapp-ontap_aggregate_resource` is now renamed to `netapp-ontap_aggregate`
 * **Rename Resource:** `netapp-ontap_flexcache_resource` is now renamed to `netapp-ontap_flexcache`
 * **Rename Resource:** `netapp-ontap_lun_resource` is now renamed to `netapp-ontap_lun`
@@ -100,6 +107,7 @@ Storage
 * **Rename Data Source:** `netapp-ontap_volume_snapshots_data_source` is now renamed to `netapp-ontap_volume_snapshots`
 
 Svm
+
 * **Rename Resource:** `netapp-ontap_svm_peers_resource` is now renamed to `netapp-ontap_svm_peer`
 * **Rename Resource:** `netapp-ontap_svm_resource` is now renamed to `netapp-ontap_svm`
 * **Rename Data Source:** `netapp-ontap_svm_peer_data_source` is now renamed to `netapp-ontap_svm_peer`
@@ -108,6 +116,7 @@ Svm
 * **Rename Data Source:** `netapp-ontap_svms_data_source` is now renamed to `netapp-ontap_svms`
 
 FEATURES:
+
 * **provider**: add `aws_lambda` option. ([#262](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/262))
 * **New Data Source:** `netapp-ontap_volume_file` ([#8](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/8))
 * **New Data Source:** `netapp-ontap_qos_policy` ([#77](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/77))
@@ -133,39 +142,46 @@ FEATURES:
 * **New Resource:** `netapp-security_login_message` ([#18](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/18))
 
 ENHANCEMENTS:
+
 * **netapp-ontap_lun**: added `size_unit` option. ([#227](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/227))
 * **netapp-ontap_security_account**: Add support for import and update ([#243](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/243))
 * **netapp-ontap_name_services_dns**: Add `skip_config_validation`([#316](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/316))
 
 ## 1.1.4 (2024-09-05)
 
 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)])
 
 ## 1.1.3 (2024-08-08)
 
 BUG FIXES:
+
 * **netapp-ontap_protocols_cifs_service_resource**: fixed on attribute checking ([#250](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/250))
 * **netapp-ontap_protocols_cifs_share_resource** :`acls` unable to update acls ([#236](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/236))
 * **netapp-ontap_protocols_san_igroups_resource**: fixed bug nil pointer dereference ([#247](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/247))
 
 ## 1.1.2 (2024-06-03)
 
 ENHANCEMENTS:
+
 * **netapp-ontap_storage_lun_resource**, **netapp-ontap_storage_lun_data_source**, **netapp-ontap_storage_luns_data_source**: added `serial_number` option to get info in state file ([#207](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/207))
 
 BUG FIXES:
+
 * **netapp-ontap_storage_lun_resource**, **netapp-ontap_storage_lun_data_source**, **netapp-ontap_storage_luns_data_source**: fixed `name` and `logical_unit` options as separate inputs for resource and info in state file gets added separately as well ([#215](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/215))
 * added guide for changing NetApp Ontap Provider from one minor version to another.
 * 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))
 
 ## 1.1.1 (2024-05-15)
@@ -176,6 +192,7 @@ BUG FIXES:
 ## 1.1.0 (2024-05-08)
 
 FEATURES:
+
 * **New Data Source:** `netapp-ontap_protocols_cifs_local_group_data_source` ([#54](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/54))
 * **New Data Source:** `netapp-ontap_protocols_cifs_local_groups_data_source` ([#54](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/54))
 * **New Data Source:** `netapp-ontap_cluster_peer_data_source` ([#50](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/50))
@@ -218,8 +235,8 @@ FEATURES:
 * **New Resource:** `netapp-ontap_storage_lun_resource` ([#11](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/11))
 * **New Resource:** `netapp-ontap_security_account_resource` ([#21](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/21))
 
-
 ENHANCEMENTS:
+
 * **netapp-ontap_protocols_nfs_export_policy_resource**: Add support for import ([#34](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/34))
 * **netapp-ontap_cluster_licensing_license_resource**: Add support for import ([#30](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/30))
 * **netapp-ontap_storage_aggregate_resource**: Add support for import ([#39](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/39))
@@ -238,28 +255,30 @@ ENHANCEMENTS:
 * **netapp-ontap_cluster** Add contact, locaton, dns_domains, name_servers, timezone, certificate, ntp_servers, management_interfaces options ([#16](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/16))
 
 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)
+
 * netapp-ontap_name_services_dns_resource: Fixed missing ID on create ([#99](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/63))
 
 ## 1.0.2 (2023-11-17)
-* 1.0.1 did not deploy correctly 1.0.2 fixes that. 
 
+* 1.0.1 did not deploy correctly 1.0.2 fixes that. 
 
 ## 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))
 
-
 ## 1.0.0 (2023-11-06)
 
 FEATURES:
+
 * **New Data Source:** `netapp-ontap_cluster_data_source`
 * **New Data Source:** `netapp-ontap_cluster_licensing_license_data_source`
 * **New Data Source:** `netapp-ontap_cluster_licensing_licenses_data_source`

CONTRIBUTING.md

@@ -1,34 +1,39 @@
 # Contributing
-Thank you  for your interest in contributing to the Terraform Provider for ONTAP! 🎉
+
+Thank you for your interest in contributing to the Terraform Provider for ONTAP! 🎉
 
 We appreciate that you want to take the time to contribute! Please follow these steps before submitting your PR.
 
 # Creating a Pull Request
+
 1. Please search [existing issues](https://github.com/NetApp/terraform-provider-netapp-ontap/issues) to determine if an issue already exists for what you intend to contribute.
 2. If the issue does not exist, [create a new one](https://github.com/NetApp/terraform-provider-netapp-ontap/issues/new/choose) that explains the bug or feature request.
 3. Let us know in the issue that you plan on creating a pull request for it, by selecting the option when creating an issue. This helps us to keep track of the pull request and make sure there isn't duplicate effort.
 4. It's better to wait for feedback from someone on Netapp's Terraform Team development team before writing code. We don't have an SLA for our feedback, but we will do our best to respond in a timely manner (at a minimum, to give you an idea if you're on the right track and that you should proceed, or not).
 5. Sign and submit [NetApp's Contributor License Agreement (CCLA)](https://netapp.tap.thinksmart.com/prod/Portal/ShowWorkFlow/AnonymousEmbed/3d2f3aa5-9161-4970-997d-e482b0b033fa). You must sign and submit the Corporate Contributor License Agreement (CCLA) in order to contribute.
-* For Project name, select "Terraform Provider for ONTAP"
-* For Project Website, enter "https://github.com/NetApp/terraform-provider-netapp-ontap"
+
+   * For Project name, select "Terraform Provider for ONTAP"
+   * For Project Website, enter "https://github.com/NetApp/terraform-provider-netapp-ontap"
 6. If you've made it this far, have written the code that solves your issue, and addressed the review comments, then feel free to create your pull request.
 
 Important: NetApp will NOT look at the PR or any of the code submitted in the PR if the CCLA is not on file with NetApp Legal.
 
 ## Requirement for new Resources/Data Sources
-If your building a new Resouces or Data Source for the ONTAP we have a few requirements that need to be met before we can accept the PR.
+
+If your building a new Resources or Data Source for the ONTAP we have a few requirements that need to be met before we can accept the PR.
+
 * documentation in the /docs directory
 * example in the /examples directory
 * ACCtest in the /internal/provider directory
   * we have a GitHub Self Hosted Action that will run the ACCtest on an internal ONTAP VSIM, if there is anything that need to be set up for the ACCtest to run please let us know in the PR.
 * Pass all existing GitHub actions test
 
-
 # Netapp's Terraform Team's Commitment
+
 While we truly appreciate your efforts on pull requests, we cannot make any commitment for when, or if, your PR will be included in the Trident project. Here are a few reasons why:
-* There are many factors involved in integrating new code into this project, including things like: support for a wide variety of NetApp backends, proper adherence to our existing and/or upcoming architecture, sufficient functional and/or scenario tests across all backends, etc. In other words, while your bug fix or feature may be perfect as a standalone patch, we must ensure that your code works and can be accomodated for in all of our use cases, configurations, backends, installer, support matrix, etc.
+
+* There are many factors involved in integrating new code into this project, including things like: support for a wide variety of NetApp backends, proper adherence to our existing and/or upcoming architecture, sufficient functional and/or scenario tests across all backends, etc. In other words, while your bug fix or feature may be perfect as a standalone patch, we must ensure that your code works and can be accommodated for in all of our use cases, configurations, backends, installer, support matrix, etc.
 * The Terraform Team must plan our resources to integrate your code into our code base and CI platform, and depending on the complexity of your PR, we may or may not have the resources available to make it happen in a timely fashion. As much as we would like to, and as much as we like to be "agile", we still have a roadmap of features that comes from Product Management. We will do our best, but it doesn't always happen quickly.
 * Sometimes the PR just doesn't fit into our future plans. As stated above, we have a roadmap of things, and you don't necessarily know what's coming down the pike. It's possible that a PR you submit doesn't align with our upcoming plans, thus we won't be able to use it. It's not personal.
 
 Thank you for considering to contribute to the Terraform Provider for ONTAP!
-

README.md

@@ -33,13 +33,16 @@ go install
 ```
 
 ## Bug Reports & Feature Requests
+
 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 Enhancement -- For new fields to existing Resources or data sources 
-4. Request a New Resource, Data Source, or Service 
+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.

docs/data-sources/cluster.md

@@ -6,17 +6,23 @@ description: |-
   Cluster data source
 ---
 
-# Data Source cluster 
+# Data Source cluster
+
 Retrieve the details of a cluster data source
 
-### Related ONTAP commands
-cluster show
+## Related ONTAP commands
+
+```commandline
+* cluster show
+```
 
 ## Supported Platforms
-* On-perm ONTAP system 9.6 or higher
+
+* On-prem ONTAP system 9.6 or higher
 * Amazon FSx for NetApp ONTAP
 
 ## Example Usage
+
 ```terraform
 data "netapp-ontap_cluster" "cluster" {
   # required to know which system to interface with
@@ -46,14 +52,15 @@ data "netapp-ontap_cluster" "cluster" {
 - `version` (Attributes) ONTAP software version (see [below for nested schema](#nestedatt--version))
 
 <a id="nestedatt--certificate"></a>
+
 ### Nested Schema for `certificate`
 
 Read-Only:
 
 - `id` (String)
 
-
 <a id="nestedatt--management_interfaces"></a>
+
 ### Nested Schema for `management_interfaces`
 
 Read-Only:
@@ -63,6 +70,7 @@ Read-Only:
 - `name` (String) Name
 
 <a id="nestedatt--management_interfaces--ip"></a>
+
 ### Nested Schema for `management_interfaces.ip`
 
 Read-Only:
@@ -72,6 +80,7 @@ Read-Only:
 
 
 <a id="nestedatt--nodes"></a>
+
 ### Nested Schema for `nodes`
 
 Read-Only:
@@ -81,6 +90,7 @@ Read-Only:
 
 
 <a id="nestedatt--time_zone"></a>
+
 ### Nested Schema for `time_zone`
 
 Read-Only:
@@ -89,9 +99,9 @@ Read-Only:
 
 
 <a id="nestedatt--version"></a>
+
 ### Nested Schema for `version`
 
 Read-Only:
 
 - `full` (String) ONTAP software version
-

docs/data-sources/cluster_licensing_license_data_source.md

@@ -6,14 +6,16 @@ description: |-
 ---
 
 # Data Source cluster licensing license
+
 Retrieves Cluster Licensing License
 
 ## Supported Platforms
-* On-perm ONTAP system 9.6 or higher
-* Amazon FSx for NetApp ONTAP
 
+* On-prem ONTAP system 9.6 or higher
+* Amazon FSx for NetApp ONTAP
 
 ## Example Usage
+
 ```terraform
 data "netapp-ontap_cluster_licensing_license" "cluster_licensing_license" {
   # required to know which system to interface with
@@ -37,6 +39,7 @@ data "netapp-ontap_cluster_licensing_license" "cluster_licensing_license" {
 - `state` (String) State of the license
 
 <a id="nestedatt--licenses"></a>
+
 ### Nested Schema for `licenses`
 
 Read-Only:
@@ -49,10 +52,9 @@ Read-Only:
 - `serial_number` (String) Serial Number of the license
 
 <a id="nestedatt--licenses--compliance"></a>
+
 ### Nested Schema for `licenses.compliance`
 
 Read-Only:
 
 - `state` (String) state of the license
-
-