Merge pull request #114 from SumoLogic/ssain-terraform-docs

moving the docs to the terraform.io format

Author: seansain

docs/README.md renamed to website/docs/README.md

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_caller_identity"
+description: |-
+  Provides an easy way to retrieve Sumo Logic auth details.
+---
+
 # sumologic_caller_identity
 Provides an easy way to retrieve Sumo Logic auth details.
 

docs/d/sumologic_caller_identity.md renamed to website/docs/d/caller_identity.html.markdown

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_collector"
+description: |-
+  Provides a way to retrieve Sumo Logic collector details (id, names, etc) for a collector managed by another terraform stack.
+---
+
 # sumologic_collector
 
 Provides a way to retrieve Sumo Logic collector details (id, names, etc) for a collector

docs/d/sumologic_collector.md renamed to website/docs/d/collector.html.markdown

@@ -1,9 +1,16 @@
-# Sumologic Provider
-This provider is used to manage collectors and sources supported by Sumologic. The provider needs to be configured with the proper credentials before it can be used.
+---
+layout: "sumologic"
+page_title: "Provider: SumoLogic"
+description: |-
+  This provider is used to manage resources supported by Sumo Logic.
+---
+
+# Sumo Logic Provider
+This provider is used to manage resources supported by Sumo Logic. The provider needs to be configured with the proper credentials before it can be used.
 
 ## Example Usage
 ```hcl
-# Configure the Sumologic Provider
+# Configure the Sumo Logic Provider
 provider "sumologic" {
     access_id   = "${var.sumologic_access_id}"
     access_key  = "${var.sumologic_access_key}"
@@ -62,16 +69,11 @@ provider "sumologic" { }
 ```bash
 $ export SUMOLOGIC_ACCESSID="your-access-id"
 $ export SUMOLOGIC_ACCESSKEY="your-access-key"
+$ export SUMOLOGIC_ENVIRONMENT=us2
 $ terraform plan
 ```
 
 ## Argument Reference
-- `access_id` - (Optional) This is the Sumo Logic Access ID. It must be provided, but it can also be source from the SUMOLOGIC_ACCESSID environment variable.
-- `access_key` - (Optional) This is the Sumo Logic Access Key. It must be provided, but it can also be sourced from the SUMOLOGIC_ACCESSKEY variable.
-- `environment` - (Optional) This is the API endpoint to use. Default is `us2`. See the [Sumo Logic documentation][1] for details on which environment you should use. This value can also be source from the SUMOLOGIC_ENVIRONMENT variable.
-- `base_url` - (Optional) This is the API endpoint base URL to use. You can specify that instead of the environment. It can also be sourced from SUMOLOGIC_BASE_URL environment variable.
-
-[Back to Index][0]
-
-[0]: README.md
-[1]: https://help.sumologic.com/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security
+- `access_id` - (Required) This is the Sumo Logic Access ID. It must be provided, but it can also be source from the SUMOLOGIC_ACCESSID environment variable.
+- `access_key` - (Required) This is the Sumo Logic Access Key. It must be provided, but it can also be sourced from the SUMOLOGIC_ACCESSKEY variable.
+- `environment` - (Required) This is the API endpoint to use. See the [Sumo Logic documentation](https://help.sumologic.com/APIs/General_API_Information/Sumo_Logic_Endpoints_and_Firewall_Security) for details on which environment you should use. It must be provided, but it can be sourced from the SUMOLOGIC_ENVIRONMENT variable.

docs/sumologic-provider.md renamed to website/docs/index.html.markdown

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_cloudsyslog_source"
+description: |-
+  Provides a Sumo Logic Cloud Syslog source.
+---
+
 # sumologic_cloudsyslog_source
 
 Provides a [Sumo Logic Cloud Syslog source][1].

docs/r/sumologic_cloudsyslog_source.md renamed to website/docs/r/cloudsyslog_source.html.markdown

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_collector"
+description: |-
+  Provides a Sumologic (Hosted) Collector.
+---
+
 # sumologic_collector
 Provides a [Sumologic (Hosted) Collector][1].
 

docs/r/sumologic_collector.md renamed to website/docs/r/collector.html.markdown

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_collector_ingest_budget_assignment"
+description: |-
+  Assigns a Sumologic Collector to a Sumologic Ingest Budget.
+---
+
 # sumologic_collector_ingest_budget_assignment
 Assigns a [Sumologic Collector][1] to a [Sumologic Ingest Budget][2].
 

docs/r/sumologic_collector_ingest_budget_assignment.md renamed to website/docs/r/collector_ingest_budget_assignment.html.markdown

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_folder"
+description: |-
+  Provides the ability to create, read, delete, update, and manage of folders.
+---
+
 # sumologic_folder
 Provides the ability to create, read, delete, update, and manage of folders.
 

docs/r/sumologic_folder.md renamed to website/docs/r/folder.html.markdown

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_http_source"
+description: |-
+  Provides a Sumologic HTTP source
+---
+
 # sumologic_http_source
 Provides a [Sumologic HTTP source][1].
 

docs/r/sumologic_http_source.md renamed to website/docs/r/http_source.html.markdown

@@ -1,3 +1,10 @@
+---
+layout: "sumologic"
+page_title: "SumoLogic: sumologic_ingest_budget"
+description: |-
+  Provides a Sumologic Ingest Budget
+---
+
 # sumologic_ingest_budget
 Provides a [Sumologic Ingest Budget][1].