Merge pull request #41 from planetscale/docs

tweak more docs

Author: aybabtme

README.md

@@ -37,7 +37,8 @@ provider "planetscale" {
 
 ## Known limitations
 
-- Service tokens don't immediately have read/write access on the resources they create. For now, access must be granted via the UI or via the CLI (pscale service-token add-access)
+- Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.
+- Service tokens don't immediately have read/write access on the resources they create. For now, access must be granted via the UI or via the CLI (`pscale service-token add-access`)
 
 ## Contributing
 

docs/index.md

@@ -8,6 +8,7 @@ description: |-
   Note that the provider is not production ready and only for early testing at this time.
   Known limitations:
   - Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.
+  - Service tokens don't immediately have read/write access on the resources they create. For now, access must be granted via the UI or via the CLI (pscale service-token add-access)
 ---
 
 # planetscale Provider
@@ -21,6 +22,7 @@ Note that the provider is not production ready and only for early testing at thi
 
 Known limitations:
 - Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.
+- Service tokens don't immediately have read/write access on the resources they create. For now, access must be granted via the UI or via the CLI (`pscale service-token add-access`)
 
 ## Example Usage
 

docs/resources/backup.md

@@ -35,7 +35,7 @@ resource "planetscale_backup" "example" {
 
 ### Required
 
-- `backup_policy` (Attributes) . (see [below for nested schema](#nestedatt--backup_policy))
+- `backup_policy` (Attributes) The policy used by the backup. (see [below for nested schema](#nestedatt--backup_policy))
 - `branch` (String) The branch being backed up.
 - `database` (String) The database to which the branch being backed up belongs to.
 - `name` (String) The name of the backup.
@@ -64,8 +64,8 @@ Required:
 Read-Only:
 
 - `created_at` (String) When the backup policy was created.
-- `frequency_unit` (String) The unit for the frequency of the backup policy.
-- `frequency_value` (Number) A number value for the frequency of the backup policy.
+- `frequency_unit` (String) The unit for the frequency of the backup policy. Not configurable for now.
+- `frequency_value` (Number) A number value for the frequency of the backup policy. Not configurable for now.
 - `id` (String) The ID of the backup policy.
 - `last_ran_at` (String) When the backup was last run.
 - `name` (String) The name of the backup policy.

internal/provider/backup_resource.go

@@ -121,7 +121,7 @@ Known limitations:
 					stringplanmodifier.RequiresReplace(),
 				}},
 			"backup_policy": schema.SingleNestedAttribute{
-				Description: ".",
+				Description: "The policy used by the backup.",
 				Required:    true,
 				Attributes:  backupPolicyResourceAttribute,
 			},

internal/provider/models_resource.go

@@ -147,11 +147,11 @@ var backupPolicyResourceAttribute = map[string]schema.Attribute{
 		Computed:    true,
 	},
 	"frequency_unit": schema.StringAttribute{
-		Description: "The unit for the frequency of the backup policy.",
+		Description: "The unit for the frequency of the backup policy. Not configurable for now.",
 		Computed:    true,
 	},
 	"frequency_value": schema.Float64Attribute{
-		Description: "A number value for the frequency of the backup policy.",
+		Description: "A number value for the frequency of the backup policy. Not configurable for now.",
 		Computed:    true,
 	},
 	"last_ran_at": schema.StringAttribute{

internal/provider/provider.go

@@ -62,7 +62,8 @@ func (p *PlanetScaleProvider) Schema(ctx context.Context, req provider.SchemaReq
 Note that the provider is not production ready and only for early testing at this time.
 
 Known limitations:
-- Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.`,
+- Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.
+- Service tokens don't immediately have read/write access on the resources they create. For now, access must be granted via the UI or via the CLI (` + "`pscale service-token add-access`" + `)`,
 		Attributes: map[string]schema.Attribute{
 			"endpoint": schema.StringAttribute{
 				MarkdownDescription: "If set, points the API client to a different endpoint than `https:://api.planetscale.com/v1`.",