From 21b3a6e58787aae54938b772e3e66f1c14e86766 Mon Sep 17 00:00:00 2001 From: Julien Dessaux Date: Mon, 19 Jun 2023 13:04:25 +0200 Subject: Terraform registry documentation bootstrap --- CHANGELOG.md | 7 +++++-- docs/data-sources/projects.md | 5 +++++ docs/index.md | 22 +++++++++++++++------- docs/resources/project.md | 14 ++++++++++++++ .../data-sources/eventline_projects/data-source.tf | 2 ++ examples/data-sources/projects/data-source.tf | 2 -- examples/provider/provider.tf | 10 +++++++++- examples/resources/eventline_project/import.sh | 1 + examples/resources/eventline_project/resource.tf | 3 +++ examples/resources/project/import.sh | 1 - examples/resources/project/resource.tf | 3 --- templates/index.md.tmpl | 17 +++++++++++++++++ 12 files changed, 71 insertions(+), 16 deletions(-) create mode 100644 examples/data-sources/eventline_projects/data-source.tf delete mode 100644 examples/data-sources/projects/data-source.tf create mode 100644 examples/resources/eventline_project/import.sh create mode 100644 examples/resources/eventline_project/resource.tf delete mode 100644 examples/resources/project/import.sh delete mode 100644 examples/resources/project/resource.tf create mode 100644 templates/index.md.tmpl diff --git a/CHANGELOG.md b/CHANGELOG.md index bfccf90..ae659e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,10 @@ -# Changelog +## 0.0.2 - 2023-06-19 + +### Notes +* Terraform registry documentation bootstrap ## 0.0.1 - 2023-06-19 -## FEATURES +### FEATURES * Add projects datasource * Add project resource diff --git a/docs/data-sources/projects.md b/docs/data-sources/projects.md index 63b4985..7642834 100644 --- a/docs/data-sources/projects.md +++ b/docs/data-sources/projects.md @@ -10,7 +10,12 @@ description: |- Eventline projects data source +## Example Usage +```terraform +data "projects" "example" { +} +``` ## Schema diff --git a/docs/index.md b/docs/index.md index c43341d..035ab09 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,20 +1,28 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "eventline Provider" -subcategory: "" -description: |- - +layout: "" +page_title: "Provider: eventline" +description: "The eventline provider allows you to interact with the eventline API." --- -# eventline Provider +# Eventline Provider +The [Eventline](https://www.exograd.com/products/eventline/) provider is used to interact with the resources supported by Eventline. The provider needs to be configured with the proper credentials before it can be used. It requires terraform 1.0 or later. +Use the navigation to the left to read about the available resources. ## Example Usage ```terraform +terraform { + required_providers { + eventline = { + source = "adyxax/eventline" + } + } +} + provider "eventline" { - api_key = "12345678-9abc-def0-1234-56789abcdef0" + api_key = var.eventline_api_key endpoint = "http://localhost:8085/" } ``` diff --git a/docs/resources/project.md b/docs/resources/project.md index 21f179f..ac1953d 100644 --- a/docs/resources/project.md +++ b/docs/resources/project.md @@ -10,7 +10,13 @@ description: |- Eventline project resource +## Example Usage +```terraform +resource "project" "example" { + name = "example" +} +``` ## Schema @@ -22,3 +28,11 @@ Eventline project resource ### Read-Only - `id` (String) Project Id + +## Import + +Import is supported using the following syntax: + +```shell +terraform import eventline_project.test 0123456789ABCDEFGHIJKLMNOPQ +``` diff --git a/examples/data-sources/eventline_projects/data-source.tf b/examples/data-sources/eventline_projects/data-source.tf new file mode 100644 index 0000000..f68d2cc --- /dev/null +++ b/examples/data-sources/eventline_projects/data-source.tf @@ -0,0 +1,2 @@ +data "projects" "example" { +} diff --git a/examples/data-sources/projects/data-source.tf b/examples/data-sources/projects/data-source.tf deleted file mode 100644 index f68d2cc..0000000 --- a/examples/data-sources/projects/data-source.tf +++ /dev/null @@ -1,2 +0,0 @@ -data "projects" "example" { -} diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf index 699cdb4..b562140 100644 --- a/examples/provider/provider.tf +++ b/examples/provider/provider.tf @@ -1,4 +1,12 @@ +terraform { + required_providers { + eventline = { + source = "adyxax/eventline" + } + } +} + provider "eventline" { - api_key = "12345678-9abc-def0-1234-56789abcdef0" + api_key = var.eventline_api_key endpoint = "http://localhost:8085/" } diff --git a/examples/resources/eventline_project/import.sh b/examples/resources/eventline_project/import.sh new file mode 100644 index 0000000..c6bc21c --- /dev/null +++ b/examples/resources/eventline_project/import.sh @@ -0,0 +1 @@ +terraform import eventline_project.test 0123456789ABCDEFGHIJKLMNOPQ diff --git a/examples/resources/eventline_project/resource.tf b/examples/resources/eventline_project/resource.tf new file mode 100644 index 0000000..e39b50f --- /dev/null +++ b/examples/resources/eventline_project/resource.tf @@ -0,0 +1,3 @@ +resource "project" "example" { + name = "example" +} diff --git a/examples/resources/project/import.sh b/examples/resources/project/import.sh deleted file mode 100644 index c6bc21c..0000000 --- a/examples/resources/project/import.sh +++ /dev/null @@ -1 +0,0 @@ -terraform import eventline_project.test 0123456789ABCDEFGHIJKLMNOPQ diff --git a/examples/resources/project/resource.tf b/examples/resources/project/resource.tf deleted file mode 100644 index e39b50f..0000000 --- a/examples/resources/project/resource.tf +++ /dev/null @@ -1,3 +0,0 @@ -resource "project" "example" { - name = "example" -} diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl new file mode 100644 index 0000000..6e7e9ff --- /dev/null +++ b/templates/index.md.tmpl @@ -0,0 +1,17 @@ +--- +layout: "" +page_title: "Provider: eventline" +description: "The eventline provider allows you to interact with the eventline API." +--- + +# Eventline Provider + +The [Eventline](https://www.exograd.com/products/eventline/) provider is used to interact with the resources supported by Eventline. The provider needs to be configured with the proper credentials before it can be used. It requires terraform 1.0 or later. + +Use the navigation to the left to read about the available resources. + +## Example Usage + +{{tffile "examples/provider/provider.tf"}} + +{{ .SchemaMarkdown | trimspace }} -- cgit v1.2.3