Skip to content

Conversation

@nphilbrook
Copy link
Contributor

@nphilbrook nphilbrook commented Apr 9, 2025

What

Copied a note from the VCS Events API page into the VCS Events UI page, noting that his functionality only applies to Gitlab.com connections. This page is very confusing for customers since Gitlab is not the most common VCS provider. I had a customer ask today why there was nothing showing on this page for their Bitbucket connection, hence the note here.

Direct preview link: https://terraform-docs-common-git-nphilbrookvcsevents-hashicorp.vercel.app/terraform/cloud-docs/vcs#viewing-events

Why

Mitigating customer and employee confusion.


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

  • N/A 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.
  • N/A Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • N/A 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.
  • 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.
  • 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.

@vercel
Copy link

vercel bot commented Apr 9, 2025

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 Apr 9, 2025 1:26pm

@nphilbrook nphilbrook added documentation Improvements or additions to documentation HCP Terraform labels Apr 9, 2025
@nphilbrook nphilbrook marked this pull request as ready for review April 9, 2025 13:38
@nphilbrook nphilbrook merged commit c0a89ff into main Apr 14, 2025
4 checks passed
@nphilbrook nphilbrook deleted the nphilbrook_vcs_events branch April 14, 2025 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation HCP Terraform

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants