Doc updates (#10)

* added overview page docs * fix * fix * fix * fix * done
AxtonGrams · Sep 30, 2022 · a896bdb · a896bdb
1 parent b10cac3
commit a896bdb
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 55 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,45 +1,25 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "wiz Provider"
-subcategory: ""
+page_title: "Wiz Provider"
 description: |-
-  
+  Terraform provider to manage Wiz resources
 ---
 
-# wiz Provider
+# 
 
+The Wiz Terraform provider is designed to work with [Wiz](https://app.wiz.io/). 
 
+The "wiz" provider manages resources typically manually managed in the [Wiz web interface](https://app.wiz.io/).  You must configure the provider with the proper credentials before you can use it.
+
+Use the navigation to the left to read about the available resources.
 
 ## Example Usage
 
 ```terraform
-variable "wiz_url" {
-  type        = string
-  description = "Wiz api endpoint. This varies for each Wiz deployment. See https://docs.wiz.io/wiz-docs/docs/using-the-wiz-api#the-graphql-endpoint"
-}
-
-variable "wiz_auth_client_id" {
-  type        = string
-  description = "Your application's Client ID. You can find this value on the Settings > Service Accounts page."
-}
-
-variable "wiz_auth_client_secret" {
-  type        = string
-  description = "Your application's Client Secret. You can find this value on the Settings > Service Accounts page."
-  sensitive   = true
-}
-
-variable "wiz_auth_audience" {
-  type        = string
-  description = "Use 'beyond-api' if using auth0, otherwise use 'wiz-api'"
-  default     = "wiz-api"
-}
-
 terraform {
   required_providers {
     wiz = {
-      source  = "wiz.io/hashicorp/wiz"
-      version = "1.0.0"
+      source  = "AxtonGrams/wiz"
+      version = "1.0.2"
     }
   }
 }
@@ -48,10 +28,13 @@ provider "wiz" {
   wiz_url                = var.wiz_url
   wiz_auth_client_id     = var.wiz_auth_client_id
   wiz_auth_client_secret = var.wiz_auth_client_secret
-  wiz_auth_audience      = var.wiz_auth_audience
+  wiz_auth_audience      = "wiz-api"
 }
 ```
 
+> **WARNING** Hard-coded credentials are not recommended in any Terraform configuration and risks secret leakage should this file ever be committed to a public version control system.
+
+
 <!-- schema generated by tfplugindocs -->
 ## Schema
 

diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,30 +1,8 @@
-variable "wiz_url" {
-  type        = string
-  description = "Wiz api endpoint. This varies for each Wiz deployment. See https://docs.wiz.io/wiz-docs/docs/using-the-wiz-api#the-graphql-endpoint"
-}
-
-variable "wiz_auth_client_id" {
-  type        = string
-  description = "Your application's Client ID. You can find this value on the Settings > Service Accounts page."
-}
-
-variable "wiz_auth_client_secret" {
-  type        = string
-  description = "Your application's Client Secret. You can find this value on the Settings > Service Accounts page."
-  sensitive   = true
-}
-
-variable "wiz_auth_audience" {
-  type        = string
-  description = "Use 'beyond-api' if using auth0, otherwise use 'wiz-api'"
-  default     = "wiz-api"
-}
-
 terraform {
   required_providers {
     wiz = {
-      source  = "wiz.io/hashicorp/wiz"
-      version = "1.0.0"
+      source  = "AxtonGrams/wiz"
+      version = "1.0.2"
     }
   }
 }
@@ -33,5 +11,5 @@ provider "wiz" {
   wiz_url                = var.wiz_url
   wiz_auth_client_id     = var.wiz_auth_client_id
   wiz_auth_client_secret = var.wiz_auth_client_secret
-  wiz_auth_audience      = var.wiz_auth_audience
+  wiz_auth_audience      = "wiz-api"
 }
diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -0,0 +1,22 @@
+---
+page_title: "Wiz Provider"
+description: |-
+  Terraform provider to manage Wiz resources
+---
+
+# {{.Name}}
+
+The Wiz Terraform provider is designed to work with [Wiz](https://app.wiz.io/). 
+
+The "wiz" provider manages resources typically manually managed in the [Wiz web interface](https://app.wiz.io/).  You must configure the provider with the proper credentials before you can use it.
+
+Use the navigation to the left to read about the available resources.
+
+## Example Usage
+
+{{ tffile "examples/provider/provider.tf" }}
+
+> **WARNING** Hard-coded credentials are not recommended in any Terraform configuration and risks secret leakage should this file ever be committed to a public version control system.
+
+
+{{ .SchemaMarkdown | trimspace }}