Adjust documentation

mittwald · Oct 10, 2023 · e64f02f · e64f02f
1 parent afe72fa
commit e64f02f
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 2 deletions.
diff --git a/docs/resources/app.md b/docs/resources/app.md
@@ -10,7 +10,45 @@ description: |-
 
 Models an app installation on the mittwald platform
 
+## Example Usage
 
+```terraform
+variable "admin_password" {
+  description = "The password for the admin user of the wordpress app"
+  type        = string
+  sensitive   = true
+}
+
+resource "mittwald_app" "wordpress" {
+  project_id = mittwald_project.foobar.id
+
+  app     = "wordpress"
+  version = "6.3.1"
+
+  description   = "Martins Test-App"
+  update_policy = "patchlevel"
+
+  user_inputs = {
+    "site_title"  = "My awesome site"
+    "admin_user"  = "martin"
+    "admin_pass"  = var.admin_password
+    "admin_email" = "[email protected]"
+
+  }
+}
+
+resource "mittwald_app" "custom_php" {
+  project_id  = mittwald_project.foobar.id
+  database_id = mittwald_mysql_database.foobar_database.id
+
+  app     = "php"
+  version = "1.0.0"
+
+  description   = "Martins Test-App"
+  document_root = "/public"
+  update_policy = "none"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/docs/resources/mysql_database.md b/docs/resources/mysql_database.md
@@ -18,7 +18,7 @@ variable "database_password" {
   sensitive = true
 }
 
-resource "mittwald_mysql_database" "martin_test" {
+resource "mittwald_mysql_database" "foobar_database" {
   project_id  = mittwald_project.foobar.id
   version     = "8.0"
   description = "Foo"

diff --git a/examples/resources/mittwald_app/resource.tf b/examples/resources/mittwald_app/resource.tf
@@ -0,0 +1,35 @@
+variable "admin_password" {
+  description = "The password for the admin user of the wordpress app"
+  type        = string
+  sensitive   = true
+}
+
+resource "mittwald_app" "wordpress" {
+  project_id = mittwald_project.foobar.id
+
+  app     = "wordpress"
+  version = "6.3.1"
+
+  description   = "Martins Test-App"
+  update_policy = "patchlevel"
+
+  user_inputs = {
+    "site_title"  = "My awesome site"
+    "admin_user"  = "martin"
+    "admin_pass"  = var.admin_password
+    "admin_email" = "[email protected]"
+
+  }
+}
+
+resource "mittwald_app" "custom_php" {
+  project_id  = mittwald_project.foobar.id
+  database_id = mittwald_mysql_database.foobar_database.id
+
+  app     = "php"
+  version = "1.0.0"
+
+  description   = "Martins Test-App"
+  document_root = "/public"
+  update_policy = "none"
+}
diff --git a/examples/resources/mittwald_mysql_database/resource.tf b/examples/resources/mittwald_mysql_database/resource.tf
@@ -3,7 +3,7 @@ variable "database_password" {
   sensitive = true
 }
 
-resource "mittwald_mysql_database" "martin_test" {
+resource "mittwald_mysql_database" "foobar_database" {
   project_id  = mittwald_project.foobar.id
   version     = "8.0"
   description = "Foo"