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.

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

TF-14885 Add default-project relationship to organization API docs #683

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

ker-an
Copy link
Contributor

@ker-an ker-an commented Jul 18, 2024

Note: Do not merge until we release the change default project feature.

What

This PR adds the default-project relationship to the Organization#update API documentation. I also updated default-pool-param from an attribute because we’re actually patching a relationship.

Why

Organization owners can now update or remove an organization's default project.

Screenshots

Screenshot 2024-07-18 at 9 50 28 AM

Merge Checklist

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to website/redirects.js for moved, renamed, or deleted pages. N/A
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate. N/A
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages. N/A
  • New pages have metadata (page name and description) at the top. N/A
  • New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility. N/A
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars. N/A
  • UI elements (button names, page names, etc.) are bolded. N/A
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

@ker-an ker-an self-assigned this Jul 18, 2024
Copy link

vercel bot commented Jul 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 22, 2024 10:53pm

@ker-an ker-an added documentation Improvements or additions to documentation HCP Terraform labels Jul 18, 2024
@ker-an ker-an force-pushed the ker-an/update-organization-api-docs branch from a3d0189 to 34af89c Compare July 18, 2024 16:36
@ker-an ker-an requested a review from a team July 18, 2024 16:36
@ker-an ker-an marked this pull request as ready for review July 18, 2024 16:38
@ker-an ker-an requested a review from a team July 18, 2024 16:39
Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

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

A couple of minor style guide suggestions. Approving on behalf of the IPL education team so that you can proceed with merging when necessary.

website/docs/cloud-docs/api-docs/organizations.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/organizations.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/organizations.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/organizations.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/organizations.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/organizations.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@jbonhag jbonhag left a comment

Choose a reason for hiding this comment

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

Thanks for leaving this better than you found it! ✨

website/docs/cloud-docs/api-docs/changelog.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/changelog.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/organizations.mdx Outdated Show resolved Hide resolved
Co-authored-by: Jeff Bonhag <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge documentation Improvements or additions to documentation HCP Terraform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants