Skip to content

HCPTF Metrics Token Management Docs#2310

Open
dominic-retli-hashi wants to merge 6 commits intomainfrom
dominicretli/hcptf-metrics-token-managment-docs
Open

HCPTF Metrics Token Management Docs#2310
dominic-retli-hashi wants to merge 6 commits intomainfrom
dominicretli/hcptf-metrics-token-managment-docs

Conversation

@dominic-retli-hashi
Copy link
Copy Markdown
Contributor

@dominic-retli-hashi dominic-retli-hashi commented Apr 24, 2026

Do not merge until Metrics Service work has gone GA (expected last week of May)

What

Added docs for Atlas Metrics Service Token Management.
Use the /metrics-tokens endpoint to manage Metrics Service API tokens. Generate, list, and delete Metrics service tokens using the API.

Why

These docs explain how to use the metric service token managemnt API in HCPTF to list, create, and delete endpoints.

Screenshots

Screenshot 2026-04-24 at 10 48 48 AM
Screen.Recording.2026-04-24.at.11.28.16.AM.mov

Metrics service tokens API Full UI View As PDF

Jira Ticket for Docs:
https://hashicorp.atlassian.net/browse/TF-34604

Merged PR for the API:
https://github.com/hashicorp/atlas/pull/27819


Merge Checklist

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

Pull Request

  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to content/terraform-docs-common/redirects.jsonc 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.
  • 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. (N/A)
  • 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. (N/A, not sure what this is)

Reviews

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

@dominic-retli-hashi dominic-retli-hashi requested a review from a team as a code owner April 24, 2026 15:23
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Mon Apr 27 14:59:36 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Mon Apr 27 14:55:40 UTC 2026

This reverts commit 327feec.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

Broken Link Checker

This PR contains broken links, but won't be blocked. Use this report to improve content quality:

Quick Actions

  • Internal links (HashiCorp sites): Please fix these - they impact user experience
  • External links: Consider if these are essential or can be updated/removed
  • Temporary issues: External sites may recover - check again before merging

Need Help?


Internal Links

Full Github Actions output

External Links

Full Github Actions output

Copy link
Copy Markdown
Contributor

@robin-norwood robin-norwood left a comment

Choose a reason for hiding this comment

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

Looks good to me - will we be documenting the metrics service itself in a different PR?

Comment thread content/terraform-docs-common/docs/cloud-docs/api-docs/metrics-service-tokens.mdx Outdated
Co-authored-by: Robin Norwood <robin.norwood@gmail.com>
@dominic-retli-hashi
Copy link
Copy Markdown
Contributor Author

dominic-retli-hashi commented Apr 27, 2026

Looks good to me - will we be documenting the metrics service itself in a different PR?

@robin-norwood
Thanks for the review!

Good question. There is a separate team responsible for the entire metrics service, so I would assume "yes".
My team was responsible just for building and documenting these HCPTF proxy endpoints that interact with a subset of the Metrics Service endpoints. The endpoints are only exposed to HCPTF at the moment.

All of the Metrics Service functionality just entered private beta and is in-use for one customer. GA is in about a month, so I will be holding off on merging these docs changes until then.

Edit:
Is there a standard way to hold off on docs changes until the feature is GA? Not sure if there is some kind of flag mechanism I'm unaware of.

@robin-norwood
Copy link
Copy Markdown
Contributor

Edit: Is there a standard way to hold off on docs changes until the feature is GA? Not sure if there is some kind of flag mechanism I'm unaware of.

The do not merge label is sufficient, but usually we also convert to a draft as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants