Skip to content

[Docs]: import not documented in resources #613

@suhasbshekar

Description

@suhasbshekar

Documentation Link

https://github.com/NetApp/terraform-provider-netapp-ontap/tree/integration/main/docs/resources

Description

Documentation Issue: Missing and Incorrect Import Documentation Across NetApp ONTAP Provider

Documentation Link

Multiple pages across the NetApp ONTAP provider documentation on Terraform Registry:

Description

There is a lot of missing import documentation across the NetApp ONTAP provider resources. The problems fall into several categories:

1. Resources claiming import is unsupported when it actually is supported

The netapp-ontap_network_ip_route resource documentation states "Import is not supported" but the resource actually supports import functionality.

2. There are some resources with no import documentation at all that do support import

netapp-ontap_cifs_service

netapp-ontap_name_services_ldap

Suggested Fix

I haven't gone through all the resources, but it is difficult to use the imports when it requires cross referencing the docs with the source code. It would be useful to audit the docs and ensure consistent documentation when import is supported, and make sure it clearly states when import is actually unsupported instead of having no comment.

References

No response

Would you like to implement a fix?

None

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

2.5.0

Relationships

None yet

Development

No branches or pull requests

Issue actions