docs: add documentation to provider and resources

Author: maxjoehnk

docs/index.md

@@ -0,0 +1,36 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "mssql Provider"
+subcategory: ""
+description: |-
+  
+---
+
+# mssql Provider
+
+
+
+## Example Usage
+
+```terraform
+provider "mssql" {
+  host = "localhost"
+  username = "sa"
+  password = "password"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `host` (String) The address the mssql server is reachable on.
+- `password` (String)
+- `username` (String) The username to authenticate against the mssql server with. Requires the dbcreator role to create new databases.
+
+### Optional
+
+- `port` (Number) The port the mssql server is listening on.
+
+Defaults to 1433

docs/resources/database.md

@@ -0,0 +1,39 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "mssql_database Resource - terraform-provider-mssql"
+subcategory: ""
+description: |-
+  Manage a Database
+  Updating the database is currently not implemented and will drop the entire database!
+---
+
+# mssql_database (Resource)
+
+Manage a Database
+
+Updating the database is currently not implemented and will drop the entire database!
+
+## Example Usage
+
+```terraform
+resource "mssql_database" "db" {
+  name = "MyDatabase"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) The name of the database
+
+### Optional
+
+- `owner` (String) The username of the owner of the database
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+

docs/resources/role.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "mssql_role Resource - terraform-provider-mssql"
+subcategory: ""
+description: |-
+  Manage a role
+  Updating a role is currently not supported and will drop the user.
+---
+
+# mssql_role (Resource)
+
+Manage a role
+
+Updating a role is currently not supported and will drop the user.
+
+## Example Usage
+
+```terraform
+resource "mssql_role" "user" {
+  name = "MyUser"
+  password = "MyPassword"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) The logon name of the role
+- `password` (String) The password used by the role
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+

examples/provider/provider.tf

@@ -0,0 +1,5 @@
+provider "mssql" {
+  host = "localhost"
+  username = "sa"
+  password = "password"
+}

examples/resources/mssql_database/resource.tf

@@ -0,0 +1,3 @@
+resource "mssql_database" "db" {
+  name = "MyDatabase"
+}

examples/resources/mssql_role/resource.tf

@@ -0,0 +1,4 @@
+resource "mssql_role" "user" {
+  name = "MyUser"
+  password = "MyPassword"
+}

mssql/provider.go

@@ -12,21 +12,26 @@ func Provider() *schema.Provider {
 	return &schema.Provider{
 		Schema: map[string]*schema.Schema{
 			"username": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The username to authenticate against the mssql server with. Requires the dbcreator role to create new databases.",
 			},
 			"password": {
 				Type:     schema.TypeString,
 				Required: true,
 			},
 			"host": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The address the mssql server is reachable on.",
 			},
 			"port": {
 				Type:     schema.TypeInt,
 				Default:  1433,
 				Optional: true,
+				Description: `The port the mssql server is listening on.
+
+Defaults to 1433`,
 			},
 		},
 		ResourcesMap: map[string]*schema.Resource{

mssql/resource_database.go

@@ -12,15 +12,19 @@ func resourceDatabase() *schema.Resource {
 		Read:   resourceDatabaseRead,
 		Update: resourceDatabaseUpdate,
 		Delete: resourceDatabaseDelete,
+		Description: `Manage a Database
 
+Updating the database is currently not implemented and will drop the entire database!`,
 		Schema: map[string]*schema.Schema{
 			"owner": {
-				Type:     schema.TypeString,
-				Optional: true,
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The username of the owner of the database",
 			},
 			"name": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The name of the database",
 			},
 		},
 	}

mssql/resource_role.go

@@ -12,15 +12,21 @@ func resourceRole() *schema.Resource {
 		Read:   resourceRoleRead,
 		Update: resourceRoleUpdate,
 		Delete: resourceRoleDelete,
+		Description: `Manage a role
+
+Updating a role is currently not supported and will drop the user.
+`,
 
 		Schema: map[string]*schema.Schema{
 			"name": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The logon name of the role",
 			},
 			"password": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The password used by the role",
 			},
 		},
 	}