Merge pull request #24 from netdata/feat/update-docs

feat: update docs
netdata · May 9, 2024 · bf12a36 · bf12a36
2 parents 4f49a5b + 8c160da
commit bf12a36
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+## 0.1.3
+
+FEATURES:
+
+- more detailed resource descriptions
+
+## 0.1.2
+
+BUGFIXES:
+
+- fix bug with empty claim token
+
 ## 0.1.1
 
 BUGFIXES:

diff --git a/docs/resources/room.md b/docs/resources/room.md
@@ -3,12 +3,12 @@
 page_title: "netdata_room Resource - terraform-provider-netdata"
 subcategory: ""
 description: |-
-  Provides a Netdata Cloud Room resource.
+  Provides a Netdata Cloud Room resource. Use this resource to manage rooms in the selected space.
 ---
 
 # netdata_room (Resource)
 
-Provides a Netdata Cloud Room resource.
+Provides a Netdata Cloud Room resource. Use this resource to manage rooms in the selected space.
 
 ## Example Usage
 

diff --git a/docs/resources/room_member.md b/docs/resources/room_member.md
@@ -3,12 +3,12 @@
 page_title: "netdata_room_member Resource - terraform-provider-netdata"
 subcategory: ""
 description: |-
-  Provides a Netdata Cloud Room Member resource.
+  Provides a Netdata Cloud Room Member resource. Use this resource to manage user membership to the room in the selected space. It is referring to the user created at the space level.
 ---
 
 # netdata_room_member (Resource)
 
-Provides a Netdata Cloud Room Member resource.
+Provides a Netdata Cloud Room Member resource. Use this resource to manage user membership to the room in the selected space. It is referring to the user created at the space level.
 
 ## Example Usage
 

diff --git a/docs/resources/space.md b/docs/resources/space.md
@@ -3,12 +3,12 @@
 page_title: "netdata_space Resource - terraform-provider-netdata"
 subcategory: ""
 description: |-
-  Provides a Netdata Cloud Space resource.
+  Provides a Netdata Cloud Space resource. Use this resource to manage spaces.
 ---
 
 # netdata_space (Resource)
 
-Provides a Netdata Cloud Space resource.
+Provides a Netdata Cloud Space resource. Use this resource to manage spaces.
 
 ## Example Usage
 

diff --git a/docs/resources/space_member.md b/docs/resources/space_member.md
@@ -3,12 +3,12 @@
 page_title: "netdata_space_member Resource - terraform-provider-netdata"
 subcategory: ""
 description: |-
-  Provides a Netdata Cloud Space Member resource.
+  Provides a Netdata Cloud Space Member resource. Use this resource to manage user membership to the space.
 ---
 
 # netdata_space_member (Resource)
 
-Provides a Netdata Cloud Space Member resource.
+Provides a Netdata Cloud Space Member resource. Use this resource to manage user membership to the space.
 
 ## Example Usage
 

diff --git a/internal/provider/room_member_resource.go b/internal/provider/room_member_resource.go
@@ -41,7 +41,7 @@ func (s *roomMemberResource) Metadata(ctx context.Context, req resource.Metadata
 
 func (s *roomMemberResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		Description: "Provides a Netdata Cloud Room Member resource.",
+		Description: "Provides a Netdata Cloud Room Member resource. Use this resource to manage user membership to the room in the selected space. It is referring to the user created at the space level.",
 		Attributes: map[string]schema.Attribute{
 			"room_id": schema.StringAttribute{
 				Description: "The Room ID of the space",

diff --git a/internal/provider/room_resource.go b/internal/provider/room_resource.go
@@ -42,7 +42,7 @@ func (s *roomResource) Metadata(ctx context.Context, req resource.MetadataReques
 
 func (s *roomResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		Description: "Provides a Netdata Cloud Room resource.",
+		Description: "Provides a Netdata Cloud Room resource. Use this resource to manage rooms in the selected space.",
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Description: "The ID of the room",

diff --git a/internal/provider/space_member_resource.go b/internal/provider/space_member_resource.go
@@ -45,7 +45,7 @@ func (s *spaceMemberResource) Metadata(ctx context.Context, req resource.Metadat
 
 func (s *spaceMemberResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		Description: "Provides a Netdata Cloud Space Member resource.",
+		Description: "Provides a Netdata Cloud Space Member resource. Use this resource to manage user membership to the space.",
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Description: "The Member ID of the space",

diff --git a/internal/provider/space_resource.go b/internal/provider/space_resource.go
@@ -44,7 +44,7 @@ func (s *spaceResource) Metadata(ctx context.Context, req resource.MetadataReque
 
 func (s *spaceResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		Description: "Provides a Netdata Cloud Space resource.",
+		Description: "Provides a Netdata Cloud Space resource. Use this resource to manage spaces.",
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Description: "The ID of the space",