Merge pull request #14 from netascode/refactor-readme

Refactor YAML file name for organization admins

.terraform-docs.yml

@@ -18,7 +18,7 @@ content: |-
   #### `organization.yaml`
 
   ```yaml
-  {{ include "./examples/administrator/organization.yaml" }}
+  {{ include "./examples/administrator/organizations_admins.yaml" }}
   ```
 
   #### `main.tf`

README.md

@@ -15,13 +15,17 @@ Configuring an organization administrator using YAML:
 
 ```yaml
 meraki:
-  organizations:
-    - name: MyOrg1
-      administrators:
-        - name: Admin1
-          email: [email protected]
-          networks:
-            - name: MyNet1
+  domains:
+    - name: EMEA
+      administrator:
+        name: Dev CX Provider Admin
+      organizations:
+        - name: Dev
+          admins:
+            - name: Dev CX Provider Admin
+              email: [email protected]
+              authentication_method: Email
+              org_access: full
 ```
 
 #### `main.tf`
@@ -31,7 +35,7 @@ module "meraki" {
   source  = "netascode/nac-meraki/meraki"
   version = ">= 0.1.0"
 
-  yaml_files = ["organization.yaml"]
+  yaml_files = ["organizations_admins.yaml"]
 }
 ```
 

examples/administrator/.terraform-docs.yml

@@ -21,10 +21,10 @@ content: |-
 
   Note that this example will create resources. Resources can be destroyed with `terraform destroy`.
 
-  #### `organization.yaml`
+  #### `organizations_admins.yaml`
 
   ```yaml
-  {{ include "./organization.yaml" }}
+  {{ include "./organizations_admins.yaml" }}
   ```
 
   #### `main.tf`

examples/administrator/README.md

@@ -17,17 +17,21 @@ $ terraform apply
 
 Note that this example will create resources. Resources can be destroyed with `terraform destroy`.
 
-#### `organization.yaml`
+#### `organizations_admins.yaml`
 
 ```yaml
 meraki:
-  organizations:
-    - name: MyOrg1
-      administrators:
-        - name: Admin1
-          email: [email protected]
-          networks:
-            - name: MyNet1
+  domains:
+    - name: EMEA
+      administrator:
+        name: Dev CX Provider Admin
+      organizations:
+        - name: Dev
+          admins:
+            - name: Dev CX Provider Admin
+              email: [email protected]
+              authentication_method: Email
+              org_access: full
 ```
 
 #### `main.tf`
@@ -37,7 +41,7 @@ module "meraki" {
   source  = "netascode/nac-meraki/meraki"
   version = ">= 0.1.0"
 
-  yaml_files = ["organization.yaml"]
+  yaml_files = ["organizations_admins.yaml"]
 }
 ```
 <!-- END_TF_DOCS -->

examples/administrator/main.tf

@@ -2,5 +2,5 @@ module "meraki" {
   source  = "netascode/nac-meraki/meraki"
   version = ">= 0.1.0"
 
-  yaml_files = ["organization.yaml"]
+  yaml_files = ["organizations_admins.yaml"]
 }

examples/administrator/organizations_admins.yaml

@@ -0,0 +1,12 @@
+meraki:
+  domains:
+    - name: EMEA
+      administrator:
+        name: Dev CX Provider Admin
+      organizations:
+        - name: Dev
+          admins:
+            - name: Dev CX Provider Admin
+              email: [email protected]
+              authentication_method: Email
+              org_access: full