auth: add some description to resource and data source

Signed-off-by: Arthur Outhenin-Chalandre <arthur.outhenin-chalandre@cern.ch>
cernops · Jun 24, 2022 · 96fb4be · 96fb4be
1 parent 4ee4809
commit 96fb4be
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/ceph/data_source_auth.go b/ceph/data_source_auth.go
@@ -10,6 +10,7 @@ import (
 
 func dataSourceAuth() *schema.Resource {
 	return &schema.Resource{
+		Description: "This data source allows you to get information about a ceph client.",
 		ReadContext: dataSourceAuthRead,
 
 		Schema: map[string]*schema.Schema{

diff --git a/ceph/resource_auth.go b/ceph/resource_auth.go
@@ -17,6 +17,7 @@ type authResponse struct {
 
 func resourceAuth() *schema.Resource {
 	return &schema.Resource{
+		Description:   "This resource allows you to create a ceph client and retrieve his key and/or keyring.",
 		CreateContext: resourceAuthCreate,
 		ReadContext:   resourceAuthRead,
 		UpdateContext: resourceAuthUpdate,

diff --git a/docs/data-sources/auth.md b/docs/data-sources/auth.md
@@ -3,12 +3,12 @@
 page_title: "ceph_auth Data Source - terraform-provider-ceph"
 subcategory: ""
 description: |-
-  
+  This data source allows you to get information about a ceph client.
 ---
 
 # ceph_auth (Data Source)
 
-
+This data source allows you to get information about a ceph client.
 
 
 

diff --git a/docs/resources/auth.md b/docs/resources/auth.md
@@ -3,12 +3,12 @@
 page_title: "ceph_auth Resource - terraform-provider-ceph"
 subcategory: ""
 description: |-
-  
+  This resource allows you to create a ceph client and retrieve his key and/or keyring.
 ---
 
 # ceph_auth (Resource)
 
-
+This resource allows you to create a ceph client and retrieve his key and/or keyring.