docs: improve descriptions for billing groups

aiven · Jan 25, 2024 · 733f850 · 733f850
1 parent addf6ee
commit 733f850
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 53 deletions.
diff --git a/docs/data-sources/billing_group.md b/docs/data-sources/billing_group.md
@@ -3,12 +3,12 @@
 page_title: "aiven_billing_group Data Source - terraform-provider-aiven"
 subcategory: ""
 description: |-
-  The Billing Group data source provides information about the existing Aiven Account.
+  Provides information about an existing billing group.
 ---
 
 # aiven_billing_group (Data Source)
 
-The Billing Group data source provides information about the existing Aiven Account.
+Provides information about an existing billing group.
 
 ## Example Usage
 
@@ -23,23 +23,23 @@ data "aiven_billing_group" "foo" {
 
 ### Required
 
-- `billing_group_id` (String) The id of the billing group. To set up proper dependencies please refer to this variable as a reference.
+- `billing_group_id` (String) The ID of the billing group. To set up proper dependencies please refer to this variable as a reference.
 
 ### Read-Only
 
-- `account_id` (String) Account id
-- `address_lines` (Set of String) Address lines
-- `billing_currency` (String) Billing currency
-- `billing_emails` (Set of String) Billing contact emails
-- `billing_extra_text` (String) Billing extra text
-- `card_id` (String) Credit card id
-- `city` (String) City
-- `company` (String) Company name
-- `copy_from_billing_group` (String) ID of the billing group to copy from
-- `country_code` (String) Country code
+- `account_id` (String) Account ID.
+- `address_lines` (Set of String) Address lines 1 and 2. For example, street, PO box, or building.
+- `billing_currency` (String) Billing currency for the billing group. Supported currencies are: AUD, CAD, CHF, DKK, EUR, GBP, JPY, NOK, NZD, SEK, SGD, and USD.
+- `billing_emails` (Set of String) Email address of billing contacts. Invoices and other payment notifications are emailed to all billing contacts.
+- `billing_extra_text` (String) Additional information to include on your invoice (for example, a reference number).
+- `card_id` (String) Credit card ID.
+- `city` (String) City, district, suburb, town, or village.
+- `company` (String) Your company name.
+- `copy_from_billing_group` (String) ID of the billing group to copy the company name, address, currency, billing contacts, and extra text from.
+- `country_code` (String) Two-letter country code.
 - `id` (String) The ID of this resource.
-- `name` (String) Billing Group name
-- `parent_id` (String) An optional property to link a billing group to an already existing organization or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
-- `state` (String) State
-- `vat_id` (String) VAT id
-- `zip_code` (String) Zip Code
+- `name` (String) Name of the billing group.
+- `parent_id` (String) Link a billing group to an existing organization or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
+- `state` (String) State or province.
+- `vat_id` (String) The VAT identification number for your company.
+- `zip_code` (String) Zip or postal code.
diff --git a/docs/resources/billing_group.md b/docs/resources/billing_group.md
@@ -3,12 +3,12 @@
 page_title: "aiven_billing_group Resource - terraform-provider-aiven"
 subcategory: ""
 description: |-
-  The Billing Group resource allows the creation and management of Aiven Billing Groups and association with the Projects.
+  Creates and manages billing groups and assigns them to projects.
 ---
 
 # aiven_billing_group (Resource)
 
-The Billing Group resource allows the creation and management of Aiven Billing Groups and association with the Projects.
+Creates and manages billing groups and assigns them to projects.
 
 ## Example Usage
 
@@ -30,25 +30,25 @@ resource "aiven_project" "pr1" {
 
 ### Required
 
-- `name` (String) Billing Group name
+- `name` (String) Name of the billing group.
 
 ### Optional
 
-- `account_id` (String, Deprecated) Account id
-- `address_lines` (Set of String) Address lines
-- `billing_currency` (String) Billing currency
-- `billing_emails` (Set of String) Billing contact emails
-- `billing_extra_text` (String) Billing extra text
-- `card_id` (String) Credit card id
-- `city` (String) City
-- `company` (String) Company name
-- `copy_from_billing_group` (String) ID of the billing group to copy from
-- `country_code` (String) Country code
-- `parent_id` (String) An optional property to link a billing group to an already existing organization or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
-- `state` (String) State
+- `account_id` (String, Deprecated) Account ID.
+- `address_lines` (Set of String) Address lines 1 and 2. For example, street, PO box, or building.
+- `billing_currency` (String) Billing currency for the billing group. Supported currencies are: AUD, CAD, CHF, DKK, EUR, GBP, JPY, NOK, NZD, SEK, SGD, and USD.
+- `billing_emails` (Set of String) Email address of billing contacts. Invoices and other payment notifications are emailed to all billing contacts.
+- `billing_extra_text` (String) Additional information to include on your invoice (for example, a reference number).
+- `card_id` (String) Credit card ID.
+- `city` (String) City, district, suburb, town, or village.
+- `company` (String) Your company name.
+- `copy_from_billing_group` (String) ID of the billing group to copy the company name, address, currency, billing contacts, and extra text from.
+- `country_code` (String) Two-letter country code.
+- `parent_id` (String) Link a billing group to an existing organization or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
+- `state` (String) State or province.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
-- `vat_id` (String) VAT id
-- `zip_code` (String) Zip Code
+- `vat_id` (String) The VAT identification number for your company.
+- `zip_code` (String) Zip or postal code.
 
 ### Read-Only
 

diff --git a/internal/sdkprovider/service/project/billing_group.go b/internal/sdkprovider/service/project/billing_group.go
@@ -16,103 +16,103 @@ var aivenBillingGroupSchema = map[string]*schema.Schema{
 	"name": {
 		Type:        schema.TypeString,
 		Required:    true,
-		Description: "Billing Group name",
+		Description: "Name of the billing group.",
 	},
 	"card_id": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Credit card id",
+		Description:      "Credit card ID.",
 	},
 	"vat_id": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "VAT id",
+		Description:      "The VAT identification number for your company.",
 	},
 	"account_id": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Account id",
+		Description:      "Account ID.",
 		Deprecated:       "Use parent_id instead. This field will be removed in the next major release.",
 	},
 	"parent_id": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
 		Description: userconfig.Desc(
-			"An optional property to link a billing group to an already existing organization or account by using " +
+			"Link a billing group to an existing organization or account by using " +
 				"its ID.",
 		).Referenced().Build(),
 	},
 	"billing_currency": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Billing currency",
+		Description:      "Billing currency for the billing group. Supported currencies are: AUD, CAD, CHF, DKK, EUR, GBP, JPY, NOK, NZD, SEK, SGD, and USD.",
 	},
 	"billing_extra_text": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Billing extra text",
+		Description:      "Additional information to include on your invoice (for example, a reference number).",
 	},
 	"billing_emails": {
 		Type:             schema.TypeSet,
 		Elem:             &schema.Schema{Type: schema.TypeString},
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Billing contact emails",
+		Description:      "Email address of billing contacts. Invoices and other payment notifications are emailed to all billing contacts.",
 	},
 	"company": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Company name",
+		Description:      "Your company name.",
 	},
 	"address_lines": {
 		Type:             schema.TypeSet,
 		Elem:             &schema.Schema{Type: schema.TypeString},
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Address lines",
+		Description:      "Address lines 1 and 2. For example, street, PO box, or building.",
 	},
 	"country_code": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Country code",
+		Description:      "Two-letter country code.",
 	},
 	"city": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "City",
+		Description:      "City, district, suburb, town, or village.",
 	},
 	"zip_code": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "Zip Code",
+		Description:      "Zip or postal code.",
 	},
 	"state": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.EmptyObjectNoChangeDiffSuppressFunc,
-		Description:      "State",
+		Description:      "State or province.",
 	},
 	"copy_from_billing_group": {
 		Type:             schema.TypeString,
 		Optional:         true,
 		DiffSuppressFunc: schemautil.CreateOnlyDiffSuppressFunc,
-		Description:      "ID of the billing group to copy from",
+		Description:      "ID of the billing group to copy the company name, address, currency, billing contacts, and extra text from.",
 	},
 }
 
 func ResourceBillingGroup() *schema.Resource {
 	return &schema.Resource{
-		Description:   "The Billing Group resource allows the creation and management of Aiven Billing Groups and association with the Projects.",
+		Description:   "Creates and manages billing groups and assigns them to projects.",
 		CreateContext: resourceBillingGroupCreate,
 		ReadContext:   resourceBillingGroupRead,
 		UpdateContext: resourceBillingGroupUpdate,

diff --git a/internal/sdkprovider/service/project/billing_group_data_source.go b/internal/sdkprovider/service/project/billing_group_data_source.go
@@ -17,13 +17,13 @@ func DatasourceBillingGroup() *schema.Resource {
 		"billing_group_id": {
 			Type:        schema.TypeString,
 			Required:    true,
-			Description: userconfig.Desc("The id of the billing group.").Referenced().Build(),
+			Description: userconfig.Desc("The ID of the billing group.").Referenced().Build(),
 		},
 	})
 
 	return &schema.Resource{
 		ReadContext: datasourceBillingGroupRead,
-		Description: "The Billing Group data source provides information about the existing Aiven Account.",
+		Description: "Provides information about an existing billing group.",
 		Schema:      s,
 	}
 }