Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs for User and Service Account #192

Closed
wants to merge 3 commits into from
+6 −6
Closed

Updated docs for User and Service Account #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d7fb3d
Updated docs for User and Service Account
jlacefie Nov 22, 2024
6fc59f9
Updated docs for User and Service Account
jlacefie Nov 22, 2024
9d8a82c
Merge branch 'main' into jlacefie/userdcb
jlacefie Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/resources/service_account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "temporalcloud_service_account Resource - terraform-provider-temporalcloud"
subcategory: ""
description: |-
Provisions a Temporal Cloud Service Account.
Provisions a Temporal Cloud Service Account. To avoid overwriting service account permissions, manage a specific service account in one and only one .tf file.
---

# temporalcloud_service_account (Resource)

Provisions a Temporal Cloud Service Account.
Provisions a Temporal Cloud Service Account. To avoid overwriting service account permissions, manage a specific service account in one and only one .tf file.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "temporalcloud_user Resource - terraform-provider-temporalcloud"
subcategory: ""
description: |-
Provisions a Temporal Cloud user.
Provisions a Temporal Cloud user. Follow Terraform best practices. To avoid overwriting user permissions, manage a specific user in one and only one .tf file.
---

# temporalcloud_user (Resource)

Provisions a Temporal Cloud user.
Provisions a Temporal Cloud user. Follow Terraform best practices. To avoid overwriting user permissions, manage a specific user in one and only one .tf file.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion internal/provider/service_account_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ func (r *serviceAccountResource) Metadata(_ context.Context, req resource.Metada

func (r *serviceAccountResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
Description: "Provisions a Temporal Cloud Service Account.",
Description: "Provisions a Temporal Cloud Service Account. To avoid overwriting service account permissions, manage a specific service account in one and only one .tf file. ",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is necessary to say here, it seems as though this is an invalid way to use Terraform altogether

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TY for the input. The reason this was provided is that users were attempting to do this, which led to the underlying issue - #119

IIRC, we agreed to update our docs and the TF docs to make this recommendation explicitly

Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: "The unique identifier of the Service Account.",
Expand Down
2 changes: 1 addition & 1 deletion internal/provider/user_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ func (r *userResource) Metadata(_ context.Context, req resource.MetadataRequest,

func (r *userResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
Description: "Provisions a Temporal Cloud user.",
Description: "Provisions a Temporal Cloud user. Follow Terraform best practices. To avoid overwriting user permissions, manage a specific user in one and only one .tf file. ",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: "The unique identifier of the user.",
Expand Down
Binary file added terraform-provider-temporalcloud
View file
Open in desktop
Binary file not shown.
Loading