Skip to content

Conversation

netramali
Copy link
Contributor

@netramali netramali commented Sep 5, 2025

What

I have added a new page called Member Roles that gives information about two new APIs.

Please refer to the RFC for more details.

PRs:
https://github.com/hashicorp/atlas/pull/23200
https://github.com/hashicorp/atlas/pull/23596

Why

The API documentation would help users to find hcp and terraform permissions roles for a specific group .

Screenshots


Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

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.
  • 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.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages.
  • New pages have metadata (page name and description) at the top.
  • 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.
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars.
  • UI elements (button names, page names, etc.) are bolded.
  • 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.
Screenshot 2025-09-08 at 9 28 32 AM Screenshot 2025-09-08 at 9 28 45 AM Screenshot 2025-09-08 at 9 28 53 AM Screenshot 2025-09-08 at 9 28 57 AM

Copy link

github-actions bot commented Sep 5, 2025

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Tue Sep 30 16:36:08 UTC 2025
Unified Docs API ✅ Ready (Inspect) Visit Preview Tue Sep 30 16:21:49 UTC 2025

@netramali netramali added documentation Improvements or additions to documentation HCP Terraform labels Sep 5, 2025
@netramali netramali self-assigned this Sep 5, 2025
@netramali netramali marked this pull request as ready for review September 5, 2025 20:34
@netramali netramali requested a review from a team as a code owner September 5, 2025 20:34
Copy link

github-actions bot commented Sep 5, 2025

Broken Link Checker

No broken links found! 🎉

Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

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

Thank you so much for writing these! Left some comment to add TFE exclusions and some style feedback. Let me know what you think, or if anything is unclear!

@rkoron007 rkoron007 changed the title Member Roles API documentation [Do not merge] Member Roles API documentation Sep 19, 2025
@rkoron007 rkoron007 merged commit 4dea505 into main Oct 1, 2025
15 checks passed
@rkoron007 rkoron007 deleted the netramali/member-roles-api-doc branch October 1, 2025 16:12
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