docs: refine documentation across multiple files for clarity and consistency

Author: hvinn

CHANGELOG.md

@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Initial ONTAP automation examples for Python, Ansible, and Terraform
-- CI workflows for linting, testing, and secret scanning
+- CI workflows for linting, syntax validation, and secret scanning
 - Documentation for ONTAP API patterns
 
 ## [0.1.0] - 2025-01-01

README.md

@@ -3,9 +3,9 @@
 [![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
 [![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE)
 
-Production-ready automation examples for NetApp ONTAP, implemented in **Python**,
-**Ansible**, and **Terraform**. Pick the tool your team already uses and get a
-working script in minutes.
+Automation examples for NetApp ONTAP, implemented in **Python**, **Ansible**,
+and **Terraform**. Pick the tool your team already uses and get a working
+script in minutes.
 
 ---
 
@@ -31,8 +31,9 @@ Each use case is implemented across all approaches so you can compare side-by-si
 |---|---|---|---|
 | **Cluster info** — version and node list | [cluster_info.py](python/cluster_info.py) | [cluster_info.yml](ansible/cluster_info.yml) | [cluster-info/](terraform/cluster-info/) |
 | **NFS provision** — volume + export policy | [nfs_provision.py](python/nfs_provision.py) | [nfs_provision.yml](ansible/nfs_provision.yml) | [nfs-provision/](terraform/nfs-provision/) |
+| **CIFS provision** — share + ACL | — | [cifs_provision.yml](ansible/cifs_provision.yml) | — |
 
-More use cases (CIFS, SnapMirror, snapshots, SVM) are on the roadmap.
+More use cases (SnapMirror, snapshots, SVM) are on the roadmap.
 
 ---
 

SUPPORT.md

@@ -1,8 +1,8 @@
 # Orchestrio Support and Getting Help
 
 Orchestrio is an open-source project developed and published by NetApp providing
-production-ready automation examples for ONTAP, implemented in Python, Ansible,
-and Terraform. Orchestrio is not an officially supported NetApp product. NetApp
+automation examples for ONTAP, implemented in Python, Ansible, and Terraform.
+Orchestrio is not an officially supported NetApp product. NetApp
 maintains and updates Orchestrio with bug fixes, security updates, and feature
 development. For assistance, refer to [Getting Help](#getting-help).
 

ansible/README.md

@@ -2,8 +2,8 @@
 
 Ansible playbooks that automate ONTAP workflows using the
 [`netapp.ontap`](https://galaxy.ansible.com/ui/repo/published/netapp/ontap/)
-Galaxy collection. Each playbook is self-contained and designed to be copied,
-adapted, and used in production.
+Galaxy collection. Each playbook is self-contained and designed to be copied
+and adapted for your environment.
 
 For ONTAP REST API conventions (endpoints, auth, headers, async jobs), see the
 [ONTAP API patterns guide](../docs/ontap-api-patterns.md).

docs/example-template/python/example.py

@@ -23,8 +23,7 @@ def main() -> None:
 
     with OntapClient.from_env() as client:
         # 1. Retrieve or create resources
-        resp = client.get("/api/cluster", params={"fields": "name,version"})
-        cluster = resp.json()
+        cluster = client.get("/cluster", fields="name,version")
         log.info("Cluster: %s — %s", cluster["name"], cluster["version"]["full"])
 
         # 2. Add your logic here

python/README.md

@@ -1,8 +1,8 @@
 # Python Script Examples
 
 Plain Python scripts that automate ONTAP workflows using the REST API with the
-`requests` library. Each script is self-contained and designed to be copied,
-adapted, and used in production.
+`requests` library. Each script is self-contained and designed to be copied
+and adapted for your environment.
 
 For ONTAP REST API conventions (endpoints, auth, headers, async jobs), see the
 [ONTAP API patterns guide](../docs/ontap-api-patterns.md).

terraform/README.md

@@ -2,8 +2,8 @@
 
 Terraform configurations that manage ONTAP resources using the
 [NetApp ONTAP provider](https://registry.terraform.io/providers/NetApp/netapp-ontap/latest).
-Each module is self-contained and designed to be copied, adapted, and used
-in production.
+Each module is self-contained and designed to be copied and adapted for your
+environment.
 
 For ONTAP REST API conventions (endpoints, auth, headers, async jobs), see the
 [ONTAP API patterns guide](../docs/ontap-api-patterns.md).