cockroachdb / terraform-provider-cockroach

Terraform provider for CockroachDB Cloud
Apache License 2.0
57 stars 12 forks source link

[CC-25231] Generated documentation is comprehensive and accurate #148

Closed erademacher closed 1 year ago

erademacher commented 1 year ago

Went over all the resource and database schemas and updated the Description/MarkdownDescription fields where missing or needed improvement. Standardized on adding a period to the end of each description.

Added a helper to format allowed enum value lists, which show up as bullet points in a markdown renderer.

Fixed the formatting of a few ID fields, where angle brackets were getting swallowed by the markdown renderer.

Renamed "cockroach_cluster_data_source" to "cluster_data_source" for consistency and "networking_resource" to "allowlist_resource" to match the name of the actual resource.

Commit checklist


This change is Reviewable

Amruta-Ranade commented 1 year ago

@erademacher Hi! Sorry for the delayed review -- found out what the process and expectations are just yesterday. It's on my to-do list for today!

Amruta-Ranade commented 1 year ago

Reviewable status: 0 of 42 files reviewed, 21 unresolved discussions (waiting on @Amruta-Ranade, @gemma-shay, @ianjevans, and @jenngeorge)

a discussion (no related file):

Previously, jenngeorge (Jenn Georgevich) wrote…

The cockroach_user_role_grants resource requires the ID of the user being granted roles. A service account's ID can be found in the url for its detail page like "/service-accounts/{service account user id}", but we didn't have a way for customers to get the user ID of a person in their org. So we added the API endpoint & data source to address that specific problem. Here's a workflow with example use: https://github.com/cockroachdb/terraform-provider-cockroach/blob/main/examples/workflows/cockroach_user_role_grants/main.tf

@Amruta-Ranade thoughts on this? Are we ok publicly calling it a "person user"?

How about "individual user"?

erademacher commented 1 year ago

TFTRs!