Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yufeiminds committed Apr 20, 2023
1 parent 80ef196 commit bca9a9a
Show file tree
Hide file tree
Showing 12 changed files with 224 additions and 365 deletions.
16 changes: 15 additions & 1 deletion docs/data-sources/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,23 @@ Guance Cloud Function is a function development, management and execution platfo

### Optional

- `filter` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--filter))
- `max_results` (Number) The max results count of the resource will be returned.
- `type_name` (String) The type name of the resource be queried

### Read-Only

- `id` (String) Identifier of the resource.
- `items` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--items))

<a id="nestedatt--filter"></a>
### Nested Schema for `filter`

Required:

- `name` (String) The filter path, represent as json path.
- `values` (List of String) The filter values


<a id="nestedatt--items"></a>
### Nested Schema for `items`

Expand All @@ -34,4 +43,9 @@ Optional:
- `func_id` (String) Function ID
- `title` (String) Title

Read-Only:

- `created_at` (String) Timestamp of the last Terraform update of the order.
- `id` (String) Numeric identifier of the order.


33 changes: 24 additions & 9 deletions docs/resources/member.md → docs/data-sources/members.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "guance_member Resource - guance"
page_title: "guance_members Data Source - guance"
subcategory: ""
description: |-
A workspace member is a user who has access to a workspace.
Expand All @@ -11,7 +11,7 @@ description: |-
A[Workspace] --> B[Member]
---

# guance_member (Resource)
# guance_members (Data Source)

A workspace member is a user who has access to a workspace.

Expand All @@ -29,19 +29,34 @@ graph LR
<!-- schema generated by tfplugindocs -->
## Schema

### Required
### Optional

- `workspace_id` (String) Workspace ID
- `filter` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--filter))
- `max_results` (Number) The max results count of the resource will be returned.

### Optional
### Read-Only

- `id` (String) Identifier of the resource.
- `items` (Attributes List) The list of the resource (see [below for nested schema](#nestedatt--items))

<a id="nestedatt--filter"></a>
### Nested Schema for `filter`

Required:

- `name` (String) The filter path, represent as json path.
- `values` (List of String) The filter values


<a id="nestedatt--items"></a>
### Nested Schema for `items`

Optional:

- `email` (String) Email
- `mobile` (String) Mobile
- `name` (String) Name
- `role` (String) Role
- `username` (String) Username

### Read-Only
Read-Only:

- `created_at` (String) Timestamp of the last Terraform update of the order.
- `id` (String) Numeric identifier of the order.
Expand Down
224 changes: 0 additions & 224 deletions docs/data-sources/resourceschemas.md

This file was deleted.

3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@ Interact with Guance Cloud.

### Optional

- `endpoint` (String) URI for Guance Cloud API. May also be provided via GUANCE_ENDPOINT environment variable.
- `region` (String) Region for Guance Cloud API. May also be provided via GUANCE_REGION environment variable.
- `token` (String, Sensitive) Access token for Guance Cloud API. May also be provided via GUANCE_TOKEN environment variable.
28 changes: 17 additions & 11 deletions docs/resources/alertpolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,37 +41,43 @@ Notes:
### Required

- `name` (String) Alert Policy Name
- `statuses` (List of String) The status value of the event to be sent

### Optional

- `alert_target` (Attributes List) Alert Action (see [below for nested schema](#nestedatt--alert_target))
- `alert_targets` (Attributes List) Alert Action (see [below for nested schema](#nestedatt--alert_targets))
- `silent_timeout` (Number) Silent timeout timestamp
- `type` (String) Trigger rule type, default is custom

### Read-Only

- `created_at` (String) Timestamp of the last Terraform update of the order.
- `id` (String) Numeric identifier of the order.

<a id="nestedatt--alert_target"></a>
### Nested Schema for `alert_target`
<a id="nestedatt--alert_targets"></a>
### Nested Schema for `alert_targets`

Required:

- `status` (List of String) The status value of the event to be sent
- `type` (String) Alert type

Optional:

- `allow_week_days` (List of Number) Allowed to send alerts on weekdays
- `min_interval` (Number) The minimum alert interval, in seconds. 0 / null means always send an alert
- `notification` (Attributes) Notification (see [below for nested schema](#nestedatt--alert_target--notification))
- `member_group` (Attributes) Member Group (see [below for nested schema](#nestedatt--alert_targets--member_group))
- `notification` (Attributes) Notification (see [below for nested schema](#nestedatt--alert_targets--notification))

<a id="nestedatt--alert_target--notification"></a>
### Nested Schema for `alert_target.notification`
<a id="nestedatt--alert_targets--member_group"></a>
### Nested Schema for `alert_targets.member_group`

Required:

- `to` (List of String) Notification
- `id` (String) Member Group


<a id="nestedatt--alert_targets--notification"></a>
### Nested Schema for `alert_targets.notification`

Required:

- `id` (String) Notification


3 changes: 3 additions & 0 deletions docs/resources/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
page_title: "guance_dashboard Resource - guance"
subcategory: ""
description: |-
WORKING IN PROGRESS!
A dashboard is a collection of visualizations that you can use to monitor the health of your systems and applications. Dashboards are made up of one or more panels, which are the visualizations themselves. Each panel displays a single metric or a single aggregation of metrics.
Dashboards are a great way to visualize your data and monitor your systems. You can use them to track metrics over time, and to quickly see how your systems are performing. You can also use them to compare metrics from different systems and applications.
Guance Cloud's dashboard is used to clearly show the range in which the metric data values are located. It is suitable for slicing messy data into points.
---

# guance_dashboard (Resource)

**WORKING IN PROGRESS!**

A dashboard is a collection of visualizations that you can use to monitor the health of your systems and applications. Dashboards are made up of one or more panels, which are the visualizations themselves. Each panel displays a single metric or a single aggregation of metrics.

Dashboards are a great way to visualize your data and monitor your systems. You can use them to track metrics over time, and to quickly see how your systems are performing. You can also use them to compare metrics from different systems and applications.
Expand Down
Loading

0 comments on commit bca9a9a

Please sign in to comment.