Terraform registry documentation bootstrap
This commit is contained in:
parent
932a149c35
commit
21b3a6e587
9 changed files with 65 additions and 10 deletions
|
@ -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
|
||||
|
|
|
@ -10,7 +10,12 @@ description: |-
|
|||
|
||||
Eventline projects data source
|
||||
|
||||
## Example Usage
|
||||
|
||||
```terraform
|
||||
data "projects" "example" {
|
||||
}
|
||||
```
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
|
|
@ -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/"
|
||||
}
|
||||
```
|
||||
|
|
|
@ -10,7 +10,13 @@ description: |-
|
|||
|
||||
Eventline project resource
|
||||
|
||||
## Example Usage
|
||||
|
||||
```terraform
|
||||
resource "project" "example" {
|
||||
name = "example"
|
||||
}
|
||||
```
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## 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
|
||||
```
|
||||
|
|
|
@ -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/"
|
||||
}
|
||||
|
|
17
templates/index.md.tmpl
Normal file
17
templates/index.md.tmpl
Normal file
|
@ -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 }}
|
Loading…
Add table
Reference in a new issue