docs: (slightly) improve descriptions

svalabs · Oct 8, 2024 · b1f0011 · b1f0011
1 parent c584c37
commit b1f0011
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 8 deletions.
diff --git a/docs/data-sources/organization.md b/docs/data-sources/organization.md
@@ -3,12 +3,12 @@
 page_title: "forgejo_organization Data Source - forgejo"
 subcategory: ""
 description: |-
-  Organization data source
+  Forgejo organization data source
 ---
 
 # forgejo_organization (Data Source)
 
-Organization data source
+Forgejo organization data source
 
 ## Example Usage
 

diff --git a/docs/index.md b/docs/index.md
@@ -3,12 +3,12 @@
 page_title: "forgejo Provider"
 subcategory: ""
 description: |-
-  
+  Terraform provider for Forgejo — self-hosted lightweight software forge
 ---
 
 # forgejo Provider
 
-
+Terraform provider for Forgejo — self-hosted lightweight software forge
 
 ## Example Usage
 

diff --git a/docs/resources/organization.md b/docs/resources/organization.md
@@ -3,12 +3,12 @@
 page_title: "forgejo_organization Resource - forgejo"
 subcategory: ""
 description: |-
-  Organization resource
+  Forgejo organization resource
 ---
 
 # forgejo_organization (Resource)
 
-Organization resource
+Forgejo organization resource
 
 ## Example Usage
 

diff --git a/internal/provider/organization_data_source.go b/internal/provider/organization_data_source.go
@@ -43,7 +43,7 @@ func (d *organizationDataSource) Metadata(_ context.Context, req datasource.Meta
 // Schema defines the schema for the data source.
 func (d *organizationDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		Description: "Organization data source",
+		Description: "Forgejo organization data source",
 
 		Attributes: map[string]schema.Attribute{
 			"id": schema.Int64Attribute{

diff --git a/internal/provider/organization_resource.go b/internal/provider/organization_resource.go
@@ -47,7 +47,7 @@ func (r *organizationResource) Metadata(_ context.Context, req resource.Metadata
 // Schema defines the schema for the resource.
 func (r *organizationResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		Description: "Organization resource",
+		Description: "Forgejo organization resource",
 
 		Attributes: map[string]schema.Attribute{
 			"id": schema.Int64Attribute{

diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -43,6 +43,8 @@ func (p *forgejoProvider) Metadata(_ context.Context, _ provider.MetadataRequest
 // Schema defines the provider-level schema for configuration data.
 func (p *forgejoProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		Description: "Terraform provider for Forgejo — self-hosted lightweight software forge",
+
 		Attributes: map[string]schema.Attribute{
 			"host": schema.StringAttribute{
 				Description: "URI for Forgejo API. May also be provided via FORGEJO_HOST environment variable.",