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

API Docs: Variable Sets searchable #589

Merged
merged 5 commits into from
Mar 27, 2024
Merged

Conversation

JarrettSpiker
Copy link
Contributor

What

I noticed that we are missing API docs for searching Variable Sets by name in our API docs.

The q parameter is available for listing variable sets on organizations, workspaces, and projects.


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. tfc).
  • (N/A) 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.
  • API documentation and the API Changelog have been updated.
  • 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.
  • (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.
  • 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.

@JarrettSpiker JarrettSpiker added the documentation Improvements or additions to documentation label Mar 26, 2024
@JarrettSpiker JarrettSpiker requested a review from a team March 26, 2024 19:29
Copy link

vercel bot commented Mar 26, 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 Mar 27, 2024 2:05pm

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.

Suggested some small tweaks for style but looks great to me! ✨

website/docs/cloud-docs/api-docs/changelog.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/variable-sets.mdx Outdated Show resolved Hide resolved
website/docs/cloud-docs/api-docs/variable-sets.mdx Outdated Show resolved Hide resolved
JarrettSpiker and others added 3 commits March 26, 2024 17:17
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
Co-authored-by: Rose M Koron <32436232+rkoron007@users.noreply.github.com>
@JarrettSpiker JarrettSpiker merged commit 7e2c52e into main Mar 27, 2024
4 checks passed
@JarrettSpiker JarrettSpiker deleted the jspiker/varsetSearch branch March 27, 2024 14:59
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants