-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add docs for postincident tasks and tasktemplates
- Loading branch information
Showing
5 changed files
with
225 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "Zenduty: PostIncidentTasks" | ||
subcategory: "" | ||
description: |- | ||
Provides a Zenduty PostIncidentTasks Resource. This allows PostIncidentTasks to be created, updated, and deleted. | ||
--- | ||
|
||
# Resource : zenduty_post_incident_tasks | ||
Provides a Zenduty PostIncidentTasks Resource. This allows PostIncidentTasks to be created, updated, and deleted. | ||
## Example Usage | ||
```hcl | ||
resource "zenduty_teams" "exampleteam" { | ||
name = "exmaple team" | ||
} | ||
``` | ||
|
||
|
||
```hcl | ||
resource "zenduty_post_incident_tasks" "demotask" { | ||
title = "demo task template" | ||
description = "this is a description of demo task" | ||
team_id = zenduty_teams.exampleteam.id | ||
due_in_time = "YYYY-MM-DD HH:MM" | ||
status = 0 | ||
} | ||
``` | ||
|
||
|
||
## Argument Reference | ||
|
||
* `team_id` - (Required) The unique_id of team. | ||
* `title` - (Required) The title of the task. | ||
* `description` - (Required) The description of the task. | ||
* `status` - (Optional) the status of the task choices are `0` is To-Do,`1` is In-Progress, `2`- Done | ||
* `due_in_time` - (Optional) The due time of the task in format YYYY-MM-DD HH:MM. | ||
* `assigned_to` - (Optional) username of the user to assign the task | ||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `id` - The ID of the Zenduty PostIncidentTasks. | ||
|
||
## Import | ||
|
||
Team PostIncidentTask can be imported using the `team_id`(ie. unique_id of the team) and `task_id`(ie. unique_id of the task template) | ||
|
||
```hcl | ||
resource "zenduty_post_incident_tasks" "demotask" { | ||
} | ||
``` | ||
|
||
`$ terraform import zenduty_post_incident_tasks.demotask team_id/task_id` | ||
|
||
`$ terraform state show zenduty_post_incident_tasks.demotask` | ||
|
||
`* copy the output data and paste inside zenduty_post_incident_tasks.demotask resource block and remove the id attribute` | ||
|
||
`$ terraform plan` to verify the import | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "Zenduty: TaskTemplateTasks" | ||
subcategory: "" | ||
description: |- | ||
Provides a Zenduty TaskTemplateTasks Resource. This allows TaskTemplateTasks to be created, updated, and deleted. | ||
--- | ||
|
||
# Resource : zenduty_task_template_tasks | ||
Provides a Zenduty TaskTemplateTasks Resource. This allows TaskTemplateTasks to be created, updated, and deleted. | ||
## Example Usage | ||
```hcl | ||
resource "zenduty_teams" "exampleteam" { | ||
name = "exmaple team" | ||
} | ||
resource "zenduty_task_template_tasks" "demotemplate" { | ||
name = "example template" | ||
summary = "this is an example template" | ||
team_id = zenduty_teams.exampleteam.id | ||
} | ||
resource "zenduty_roles" "example_role" { | ||
team = zenduty_teams.exampleteam.id | ||
title = "Example Role" | ||
description = "Role Description" | ||
} | ||
``` | ||
|
||
|
||
```hcl | ||
resource "zenduty_task_template_tasks" "demotask" { | ||
team_id = "af0e6c8a-c895-434c-b667-2f44833e15b6" | ||
task_template_id = zenduty_task_template_tasks.demotemplate.id | ||
title = "demo task" | ||
description = "this is a description of demo task" | ||
role = zenduty_roles.example_role.id | ||
} | ||
``` | ||
|
||
|
||
## Argument Reference | ||
|
||
* `team_id` - (Required) The unique_id of team. | ||
* `task_template_id` - (Required) The unique_id of tasktemplate to create the tasktemplatetasks in. | ||
* `title` - (Required) The title of the task. | ||
* `description` - (Required) The description of the task. | ||
* `role` - (Optional) The unique_id of incident role attached to the task | ||
* `due_in` - (Optional) Time in minutes to complete the task `-1` => no due time | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `id` - The ID of the Zenduty TaskTemplateTask. | ||
|
||
## Import | ||
|
||
Team TaskTemplate can be imported using the `team_id`(ie. unique_id of the team) and `task_template_id`(ie. unique_id of the task template), and `task_template_task_id` (ie. unique_id of the task template task id) . | ||
|
||
```hcl | ||
resource "zenduty_task_template_tasks" "demotemplatetask" { | ||
} | ||
``` | ||
|
||
`$ terraform import zenduty_task_template_tasks.demotemplatetask team_id/task_template_id/task_template_task_id` | ||
|
||
`$ terraform state show zenduty_task_template_tasks.demotemplatetask` | ||
|
||
`* copy the output data and paste inside zenduty_task_template_tasks.demotemplatetask resource block and remove the id attribute` | ||
|
||
`$ terraform plan` to verify the import | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "Zenduty: TaskTemplates" | ||
subcategory: "" | ||
description: |- | ||
Provides a Zenduty TaskTemplates Resource. This allows TaskTemplates to be created, updated, and deleted. | ||
--- | ||
|
||
# Resource : zenduty_task_templates | ||
Provides a Zenduty TaskTemplates Resource. This allows TaskTemplates to be created, updated, and deleted. | ||
## Example Usage | ||
```hcl | ||
resource "zenduty_teams" "exampleteam" { | ||
name = "exmaple team" | ||
} | ||
``` | ||
|
||
```hcl | ||
resource "zenduty_task_templates" "demotemplate" { | ||
name = "example template" | ||
summary = "this is an example template" | ||
team_id = zenduty_teams.exampleteam.id | ||
} | ||
``` | ||
|
||
|
||
## Argument Reference | ||
|
||
* `team_id` - (Required) The unique_id of team to create the tasktemplate in. | ||
* `name` - (Required) The name of the tasktemplate. | ||
* `summary` - (Required) The summary of the tasktemplate. | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `id` - The ID of the Zenduty TaskTemplate. | ||
|
||
## Import | ||
|
||
Team TaskTemplate can be imported using the `team_id`(ie. unique_id of the team) and `task_template_id`(ie. unique_id of the task template), e.g. | ||
|
||
```hcl | ||
resource "zenduty_task_templates" "demotemplate" { | ||
} | ||
``` | ||
|
||
`$ terraform import zenduty_task_templates.demotemplate team_id/task_template_id` | ||
|
||
`$ terraform state show zenduty_task_templates.demotemplate` | ||
|
||
`* copy the output data and paste inside zenduty_task_templates.demotemplate resource block and remove the id attribute` | ||
|
||
`$ terraform plan` to verify the import | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters